openresponsescompat

type BackendSpec ¶

type BackendSpec struct {
	ID               string
	APIKeyEnvVarRoot string
	APIKey           string
	APIKeys          []string
	BaseURL          string
	HTTPClient       *http.Client
	RequestLimits    RequestLimits
	ResponseLimits   ResponseLimits
	Caps             lipapi.BackendCaps
	DialectSupport   lipapi.DialectSupport
	Inventory        modelinventory.Provider
	// Codec is the explicit codec customization/provenance seam for future
	// provider connectors. The zero value resolves to the generic default via
	// [NewBackend]; provider wrappers may pass explicit options to preserve
	// instance/factory/profile provenance without provider-policy leakage.
	Codec CodecOptions
}

BackendSpec carries the validated construction inputs for one instance.

type CodecOptions ¶

type CodecOptions struct {
	// contains filtered or unexported fields
}

CodecOptions is the narrow, explicit, immutable codec customization seam for future provider connectors that reuse the shared OpenResponses wire codec (Requirement 9.12). It carries only bounded provenance identity and the pinned profile; provider-specific attribution, routing, billing, catalog, and proprietary controls are never representable here and stay in the connector (Requirement 4.11).

CodecOptions is immutable and safe for concurrent use: every field is validated at construction and read-only afterwards. It exposes no callbacks, no arbitrary option maps, and no provider-policy fields.

func DefaultCodecOptions() CodecOptions

func NewCodecOptions(profile, factoryKind, providerID string) (CodecOptions, error)

func (o CodecOptions) FactoryKind() string

func (o CodecOptions) Profile() string

func (o CodecOptions) ProviderID() string

type Config ¶

type Config struct {
	BackendPrefix    string
	Profile          string
	BaseURL          string
	APIKeyEnvVarRoot string
	Models           config.CompatibleModeModelsConfig
	Capabilities     []lipapi.Capability
	Dialects         DialectConfig
	RequestLimits    RequestLimits
	ResponseLimits   ResponseLimits
}

Config is the strict, secret-free configuration surface for the generic OpenResponses backend. Successful decoding never retains literal credential values; credentials are resolved from the environment only.

func DecodeConfig(instanceID, factoryKind string, n yaml.Node) (Config, error)

type DialectConfig ¶

type DialectConfig struct {
	Item       []DialectRequirementConfig
	Reasoning  []DialectRequirementConfig
	Compaction []DialectRequirementConfig
	Extensions []ExtensionRequirementConfig
}

DialectConfig declares exact dialects and extension types satisfied by the configured remote endpoint.

type DialectRequirementConfig ¶

type DialectRequirementConfig struct {
	Dialect     string
	Implementor string
}

DialectRequirementConfig is one item/reasoning/compaction dialect declaration.

type ExtensionRequirementConfig ¶

type ExtensionRequirementConfig struct {
	Namespace   string
	Type        string
	Implementor string
}

ExtensionRequirementConfig is one bounded extension type declaration.

type LimitError ¶

type LimitError struct {
	Param  string
	Limit  int
	Actual int
}

LimitError carries the bounded identity of one exceeded configured limit.

func (e *LimitError) Error() string

func (e *LimitError) Unwrap() error

type NativeEvidence ¶

type NativeEvidence struct {
	ResponseID  string
	ItemIDs     []string
	ToolCallIDs []string
	// ExtensionTypes preserves the bounded discriminators of valid
	// vendor-prefixed output items/events accepted but not representable on
	// the canonical stream.
	ExtensionTypes []string
}

NativeEvidence captures bounded provider-native identity from a parsed response resource or stream. It is private attempt evidence: it is never forwarded to clients and never emitted on the canonical stream.

type RequestLimits ¶

type RequestLimits struct {
	MaxItems          int
	MaxItemBytes      int
	MaxContentParts   int
	MaxTools          int
	MaxExtensionBytes int
}

RequestLimits bounds one outbound OpenResponses request.

type ResponseLimits ¶

type ResponseLimits struct {
	MaxItems          int
	MaxEventBytes     int
	MaxResourceBytes  int
	MaxReasoningBytes int
	MaxTextBytes      int
}

ResponseLimits bounds one inbound OpenResponses response/stream.