sigma

package module

Go to main page

Versions in this module

v0

v0.7.0

Aug 2, 2026

Changes in this version

+ func RegisterDefaultTextModelSource(provider ProviderID, source TextModelSource, opts ...RegisterOption) error

type API

+ const APIRadiusMessages

+ type CachedTextModelSource interface

+ CachedTextModels func(context.Context) ([]Model, error)

type Client

+ func (c *Client) RestoreTextModels(ctx context.Context, providers ...ProviderID) error

type OpenAICompletionsCompat

+ SupportsGrammarTools OpenAICompatSupport

+ SupportsLongCacheRetention OpenAICompatSupport

+ type OpenAIGrammar struct

+ Definition string

+ Syntax OpenAIGrammarSyntax

+ type OpenAIGrammarSyntax string

+ const OpenAIGrammarLark

+ const OpenAIGrammarRegex

type OpenAIOptions

+ EnableGrammarTools *bool

type OpenAIResponsesCompat

+ SupportsExplicitPromptCacheMode bool

+ SupportsGrammarTools bool

+ SupportsLongCacheRetention OpenAICompatSupport

type Option

+ func WithRequestHTTPClient(httpClient *http.Client) Option

type ProviderID

+ const ProviderQwenTokenPlan

+ const ProviderQwenTokenPlanCN

+ const ProviderRadius

type Registry

+ func (r *Registry) RestoreTextModels(ctx context.Context, providers ...ProviderID) error

type Tool

+ OpenAIGrammar *OpenAIGrammar

v0.6.0

Jul 15, 2026

Changes in this version

+ const RouteDimensionCodePresence

+ const RouteDimensionMultiStepPatterns

+ const RouteDimensionQuestionComplexity

+ const RouteDimensionReasoningMarkers

+ const RouteDimensionSimpleIndicators

+ const RouteDimensionTechnicalTerms

+ const RouteDimensionTokenCount

+ var ErrNoRouteCandidates = errors.New("no route candidates")

+ func AccountUsage(model Model, usage Usage, opts ...UsageAccountingOption) (Usage, Cost)

+ func ApplySuppressedHeaders(headers http.Header, opts Options)

+ func CleanupSessionResources(sessionID string) error

+ func EstimateContentTokens(blocks []ContentBlock) int

+ func EstimateMessageTokens(message Message) int

+ func EstimateTextTokens(text string) int

+ func MaxTokensForContext(model Model, req Request, requestedMaxTokens int) int

+ func RegisterDefaultProviderAuth(id ProviderID, auth ProviderAuth, opts ...RegisterOption) error

+ func RegisterEmbeddingModelSource(registry *Registry, provider ProviderID, source EmbeddingModelSource, ...) error

+ func RegisterImageModelSource(registry *Registry, provider ProviderID, source ImageModelSource, ...) error

+ func RegisterProviderAuth(registry *Registry, provider ProviderID, auth ProviderAuth, ...) error

+ func RegisterSessionResourceCleanup(cleanup SessionResourceCleanup) func()

+ func RegisterTextModelSource(registry *Registry, provider ProviderID, source TextModelSource, ...) error

+ func ResolveAuthForRequest(ctx context.Context, model Model, opts Options) (Options, Credential, error)

+ func ValidateToolCallWithOptions(tools []Tool, call ToolCall, options ToolValidationOptions) (map[string]any, error)

+ type APIKeyAuth struct

+ EnvVars []string

+ Name string

+ Resolve APIKeyAuthResolver

+ func EnvironmentAPIKeyAuth(name string, envVars ...string) *APIKeyAuth

+ type APIKeyAuthResolver func(context.Context, Model, Options, StoredCredential, bool) (AuthResolution, bool, error)

type AnthropicMessagesCompat

+ SupportsToolReferences AnthropicCompatSupport

type AssistantMessage

+ func (m AssistantMessage) Citations() []ResultCitation

+ func (m AssistantMessage) ResponseID() string

+ func (m AssistantMessage) ResponseModel() ModelID

+ func (m AssistantMessage) Sources() []ResultSource

+ type AuthResolution struct

+ BaseURL string

+ Credential Credential

+ Headers map[string]string

+ ProviderEnv map[string]string

+ ProviderOptions map[string]any

+ Source string

+ func ResolveAuthResolution(ctx context.Context, model Model, opts Options) (AuthResolution, error)

+ func ResolveProviderAuth(ctx context.Context, model Model, opts Options, auth ProviderAuth, ...) (AuthResolution, bool, error)

+ type AuthResolutionResolver interface

+ ResolveAuthResolution func(context.Context, Model, Options) (AuthResolution, error)

type ChainAuthResolver

+ DefaultProviderCallbacks map[ProviderID]AuthResolver

+ func (r ChainAuthResolver) ResolveAuthResolution(ctx context.Context, model Model, opts Options) (AuthResolution, error)

type Client

+ func (c *Client) RefreshEmbeddingModels(ctx context.Context, providers ...ProviderID) error

+ func (c *Client) RefreshImageModels(ctx context.Context, providers ...ProviderID) error

+ func (c *Client) RefreshTextModels(ctx context.Context, providers ...ProviderID) error

type ClientOption

+ func WithCredentialStore(store CredentialStore) ClientOption

+ func WithStoredProviderAuth() ClientOption

type ContentBlock

+ DocumentSource string

+ ExtraFields map[string]any

+ FileID string

+ Filename string

+ func DocumentBase64(mimeType string, filename string, data string) ContentBlock

+ func DocumentFileID(mimeType string, filename string, fileID string) ContentBlock

+ func DocumentURL(mimeType string, filename string, url string) ContentBlock

+ func (b *ContentBlock) UnmarshalJSON(data []byte) error

+ func (b ContentBlock) Citations() []ResultCitation

+ func (b ContentBlock) Clone() ContentBlock

+ func (b ContentBlock) MarshalJSON() ([]byte, error)

type ContentBlockType

+ const ContentBlockDocument

type Cost

+ ProviderReportedCost *float64

+ ProviderReportedCurrency string

+ type CredentialModifyFunc func(current StoredCredential, ok bool) (next StoredCredential, nextOK bool, err error)

+ type CredentialStore interface

+ DeleteCredential func(context.Context, ProviderID) error

+ ModifyCredential func(context.Context, ProviderID, CredentialModifyFunc) (StoredCredential, bool, error)

+ ReadCredential func(context.Context, ProviderID) (StoredCredential, bool, error)

+ type EmbeddingModelSource interface

+ EmbeddingModels func(context.Context) ([]EmbeddingModel, error)

+ type EmbeddingModelSourceFunc func(context.Context) ([]EmbeddingModel, error)

+ func (f EmbeddingModelSourceFunc) EmbeddingModels(ctx context.Context) ([]EmbeddingModel, error)

type EmbeddingOption

+ func WithEmbeddingSuppressedHeader(key string) EmbeddingOption

+ func WithEmbeddingSuppressedHeaders(keys ...string) EmbeddingOption

type EnvironmentAuthResolver

+ func (r EnvironmentAuthResolver) ConfiguredEnvVars(model Model) []string

+ func (r EnvironmentAuthResolver) EnvVars(model Model) []string

+ type HandoffChange struct

+ ContentIndex *int

+ Detail string

+ Kind HandoffChangeKind

+ MessageIndex int

+ OutputMessageIndex *int

+ type HandoffChangeKind string

+ const HandoffChangeDeveloperRoleConverted

+ const HandoffChangeRepairMessageInserted

+ const HandoffChangeThinkingConverted

+ const HandoffChangeToolResultNameRepaired

+ const HandoffChangeToolResultSynthesized

+ const HandoffChangeUnansweredToolCallDropped

+ const HandoffChangeUnsupportedImageReplaced

+ type HandoffMessagesResult struct

+ Messages []Message

+ Report HandoffReport

+ func TransformMessagesForModel(target Model, messages []Message, opts ...HandoffOption) (HandoffMessagesResult, error)

+ type HandoffOption func(*handoffConfig)

+ func WithHandoffThinkingDelimiters(start string, end string) HandoffOption

+ func WithHandoffUnsupportedImageReplacement(text string) HandoffOption

+ type HandoffReport struct

+ Changes []HandoffChange

+ ConvertedDeveloperMessages int

+ ConvertedThinkingBlocks int

+ DroppedUnansweredToolCalls int

+ InsertedRepairMessages int

+ RepairedToolResultNames int

+ ReplacedUnsupportedImages int

+ SynthesizedToolResults int

+ type HandoffResult struct

+ Report HandoffReport

+ Request Request

+ func TransformRequestForModel(target Model, req Request, opts ...HandoffOption) (HandoffResult, error)

+ type ImageModelSource interface

+ ImageModels func(context.Context) ([]ImageModel, error)

+ type ImageModelSourceFunc func(context.Context) ([]ImageModel, error)

+ func (f ImageModelSourceFunc) ImageModels(ctx context.Context) ([]ImageModel, error)

type ImageOption

+ func WithImageSuppressedHeader(key string) ImageOption

+ func WithImageSuppressedHeaders(keys ...string) ImageOption

+ type InMemoryCredentialStore struct

+ func NewInMemoryCredentialStore() *InMemoryCredentialStore

+ func (s *InMemoryCredentialStore) DeleteCredential(_ context.Context, provider ProviderID) error

+ func (s *InMemoryCredentialStore) ModifyCredential(ctx context.Context, provider ProviderID, fn CredentialModifyFunc) (StoredCredential, bool, error)

+ func (s *InMemoryCredentialStore) ReadCredential(_ context.Context, provider ProviderID) (StoredCredential, bool, error)

type Message

+ AddedToolNames []string

+ Usage *Usage

type Model

+ CostTiers []ModelCostTier

+ OpenAIResponsesCompat *OpenAIResponsesCompat

+ func (model Model) SupportsDocuments() bool

+ type ModelCostTier struct

+ CacheReadInputCostPerMillion float64

+ CacheWriteInputCostPerMillion float64

+ InputCostPerMillion float64

+ InputTokensAbove int

+ OutputCostPerMillion float64

+ type OAuthAuth struct

+ Credential OAuthCredentialFunc

+ Name string

+ Refresh OAuthRefreshFunc

+ RefreshBefore time.Duration

+ type OAuthCredentialFunc func(context.Context, Model, Options, StoredCredential) (Credential, error)

+ type OAuthRefreshFunc func(context.Context, StoredCredential) (StoredCredential, error)

type OpenAICodexResponsesConfig

+ SupportsToolSearch bool

type OpenAICompatibleModelConfig

+ CostTiers []ModelCostTier

type OpenAIOptions

+ CodexWebSocketConnectTimeout *time.Duration

+ type OpenAIResponsesCompat struct

+ SessionAffinityFormat OpenAIResponsesSessionAffinityFormat

+ SupportsToolSearch bool

+ type OpenAIResponsesSessionAffinityFormat string

+ const OpenAIResponsesSessionAffinityOpenAINoSession

type Option

+ func WithAutomaticMaxTokensForContext(enabled bool) Option

+ func WithJSONOutput() Option

+ func WithJSONSchemaOutput(name string, schema any, strict bool) Option

+ func WithMaxTokensForContext(model Model, req Request, requestedMaxTokens int) Option

+ func WithReasoningBudgetForContext(model Model, req Request, level ThinkingLevel, requestedMaxTokens int) Option

+ func WithStructuredOutput(output StructuredOutput) Option

+ func WithSuppressedHeader(key string) Option

+ func WithSuppressedHeaders(keys ...string) Option

+ func WithTopLogprobs(top int) Option

type Options

+ AutomaticMaxTokensForContext *bool

+ StructuredOutput *StructuredOutput

+ SuppressedHeaders []string

+ TopLogprobs int

+ type ProviderAuth struct

+ APIKey *APIKeyAuth

+ OAuth *OAuthAuth

+ type ProviderAuthInfo struct

+ APIKey bool

+ ID ProviderID

+ OAuth bool

type ProviderID

+ const ProviderHuggingFace

+ const ProviderKimiCoding

+ const ProviderXiaomiTokenPlanAMS

+ const ProviderXiaomiTokenPlanCN

+ const ProviderXiaomiTokenPlanSGP

+ type ReasoningBudget struct

+ MaxTokens int

+ ThinkingBudgetTokens int

+ func ReasoningBudgetForContext(model Model, req Request, level ThinkingLevel, requestedMaxTokens int) ReasoningBudget

type Registry

+ func (r *Registry) ListProviderAuths() []ProviderAuthInfo

+ func (r *Registry) ProviderAuth(provider ProviderID) (ProviderAuth, bool)

+ func (r *Registry) RefreshEmbeddingModels(ctx context.Context, providers ...ProviderID) error

+ func (r *Registry) RefreshImageModels(ctx context.Context, providers ...ProviderID) error

+ func (r *Registry) RefreshTextModels(ctx context.Context, providers ...ProviderID) error

+ func (r *Registry) RegisterEmbeddingModelSource(provider ProviderID, source EmbeddingModelSource, opts ...RegisterOption) error

+ func (r *Registry) RegisterImageModelSource(provider ProviderID, source ImageModelSource, opts ...RegisterOption) error

+ func (r *Registry) RegisterProviderAuth(provider ProviderID, auth ProviderAuth, opts ...RegisterOption) error

+ func (r *Registry) RegisterTextModelSource(provider ProviderID, source TextModelSource, opts ...RegisterOption) error

type RegistrySnapshot

+ ProviderAuths []ProviderAuthInfo

+ type ResultCitation struct

+ CitedText string

+ EndIndex *int

+ ID string

+ ProviderMetadata map[string]any

+ StartIndex *int

+ Title string

+ Type string

+ URI string

+ URL string

+ type ResultSource struct

+ EndIndex *int

+ ID string

+ ProviderMetadata map[string]any

+ StartIndex *int

+ Title string

+ Type string

+ URI string

+ URL string

+ type RouteAction string

+ const RouteActionAbort

+ const RouteActionFallback

+ const RouteActionRetry

+ type RouteAdvice struct

+ Action RouteAction

+ Classification ErrorClassification

+ Model ModelRef

+ Reason string

+ RetryAfter time.Duration

+ type RouteClassification struct

+ Score float64

+ Signals []RouteSignal

+ Tier RouteTier

+ func ClassifyRequest(req Request, opts ...RouteOption) RouteClassification

+ type RouteDecision struct

+ Classification RouteClassification

+ Model ModelRef

+ Tier RouteTier

+ type RouteOption func(*routeConfig)

+ func WithRouteBoundaries(simpleStandard float64, standardComplex float64, complexReasoning float64) RouteOption

+ func WithRouteExclusions(refs ...ModelRef) RouteOption

+ func WithRouteModelLookup(lookup func(ModelRef) (Model, bool)) RouteOption

+ func WithRouteWeight(dimension string, weight float64) RouteOption

+ type RoutePolicy struct

+ Tiers map[RouteTier][]ModelRef

+ func (p RoutePolicy) Fallback(decision RouteDecision, attempted []ModelRef, err error, opts ...RouteOption) RouteAdvice

+ func (p RoutePolicy) Select(req Request, opts ...RouteOption) (RouteDecision, error)

+ type RouteSignal struct

+ Detail string

+ Dimension string

+ Score float64

+ Weight float64

+ type RouteTier string

+ const RouteTierComplex

+ const RouteTierReasoning

+ const RouteTierSimple

+ const RouteTierStandard

+ type SessionResourceCleanup func(sessionID string) error

+ type StoredCredential struct

+ Expiry time.Time

+ Metadata map[string]any

+ ProviderEnv map[string]string

+ RefreshToken string

+ Source string

+ Type CredentialType

+ Value string

+ type StoredCredentialAuthResolver struct

+ Fallback AuthResolver

+ Now func() time.Time

+ Registry *Registry

+ Store CredentialStore

+ func (r StoredCredentialAuthResolver) Resolve(ctx context.Context, model Model, opts Options) (Credential, error)

+ func (r StoredCredentialAuthResolver) ResolveAuthResolution(ctx context.Context, model Model, opts Options) (AuthResolution, error)

+ type StructuredOutput struct

+ Name string

+ Schema any

+ Strict bool

+ Type StructuredOutputType

+ type StructuredOutputType string

+ const StructuredOutputJSONObject

+ const StructuredOutputJSONSchema

+ type TextModelSource interface

+ TextModels func(context.Context) ([]Model, error)

+ type TextModelSourceFunc func(context.Context) ([]Model, error)

+ func (f TextModelSourceFunc) TextModels(ctx context.Context) ([]Model, error)

+ type TokenEstimate struct

+ LastUsageMessageIndex *int

+ Tokens int

+ TrailingTokens int

+ UsageTokens int

+ func EstimateRequestTokens(req Request) TokenEstimate

type ToolCall

+ func (c *ToolCall) UnmarshalJSON(data []byte) error

+ type ToolValidationOptions struct

+ CoercePrimitives bool

type Usage

+ LongCacheWriteInputTokens int

+ Model ModelID

+ Provider ProviderID

+ Raw map[string]any

+ ToolUseInputTokens int

+ type UsageAccountingOption func(*usageAccountingConfig)

+ func WithEstimatedCostAdjustment(adjust func(*Cost)) UsageAccountingOption

+ func WithProviderReportedCost(cost float64, currency string) UsageAccountingOption

+ func WithRawUsage(raw any) UsageAccountingOption

v0.5.0

Jun 13, 2026

Changes in this version

+ func IsContextOverflow(message AssistantMessage, contextWindow int) bool

type AnthropicMessagesCompat

+ SupportsDisabledThinking AnthropicCompatSupport

type AnthropicOptions

+ DisableParallelToolUse *bool

+ OutputFormat any

type BedrockOptions

+ BearerToken string

+ ResponseFormat any

+ type MistralOptions struct

+ ToolChoice *MistralToolChoice

+ type MistralToolChoice struct

+ Name string

+ Type MistralToolChoiceType

+ type MistralToolChoiceType string

+ const MistralToolChoiceAny

+ const MistralToolChoiceAuto

+ const MistralToolChoiceNone

+ const MistralToolChoiceRequired

+ const MistralToolChoiceTool

type OpenAICompletionsCompat

+ SupportsRequiredToolChoice OpenAICompatSupport

type Option

+ func WithMistralOptions(mistralOptions MistralOptions) Option

type Options

+ MistralOptions *MistralOptions

type ProviderID

+ const ProviderFireworksAnthropic

v0.4.0

Jun 7, 2026

Changes in this version

type AnthropicOptions

+ InterleavedThinking *bool

+ ThinkingDisplay AnthropicThinkingDisplay

+ ToolChoice *AnthropicToolChoice

+ type AnthropicThinkingDisplay string

+ const AnthropicThinkingDisplayOmitted

+ const AnthropicThinkingDisplaySummarized

+ type AnthropicToolChoice struct

+ Name string

+ Type AnthropicToolChoiceType

+ type AnthropicToolChoiceType string

+ const AnthropicToolChoiceAny

+ const AnthropicToolChoiceAuto

+ const AnthropicToolChoiceNone

+ const AnthropicToolChoiceTool

type EmbeddingAPI

+ const EmbeddingAPIBedrockEmbeddings

+ const EmbeddingAPIGoogleEmbeddings

+ const EmbeddingAPIGoogleVertexEmbeddings

type ImageAPI

+ const ImageAPIGoogleImages

+ const ImageAPIGoogleVertexImages

type OpenAICompletionsCompat

+ RequiresToolsForToolHistory OpenAICompatSupport

+ SupportsJSONSchemaResponseFormat OpenAICompatSupport

type ProviderID

+ const ProviderGoogleVertexAnthropic

+ const ProviderGoogleVertexOpenAI

v0.3.0

Jun 4, 2026

Changes in this version

+ const ImageSourceFileID

+ var ErrEmbeddingVectorDimensionMismatch = errors.New("embedding vector dimensions do not match")

+ var ErrEmbeddingVectorWeightMismatch = errors.New("embedding vector weights do not match vectors")

+ var ErrEmbeddingVectorZeroNorm = errors.New("embedding vector norm is zero")

+ var ErrEmbeddingVectorZeroWeight = errors.New("embedding vector weight sum is zero")

+ func CombineEmbeddingVectors(vectors [][]float32, weights []int) ([]float32, error)

+ func CosineSimilarity(a, b []float32) (float64, error)

+ func DotProduct(a, b []float32) (float64, error)

+ func NewImageStream(ctx context.Context) (*ImageStream, ImageStreamWriter)

+ func NormalizeEmbeddingNewlines(inputs []string) []string

+ func NormalizeEmbeddingVector(vector []float32) ([]float32, error)

+ func RegisterDefaultEmbeddingModel(model EmbeddingModel, opts ...RegisterOption) error

+ func RegisterDefaultEmbeddingProvider(id ProviderID, provider EmbeddingProvider, opts ...RegisterOption) error

+ func RegisterEmbeddingModel(registry *Registry, model EmbeddingModel, opts ...RegisterOption) error

+ func RunEmbeddingPayloadDebugHooks(ctx context.Context, opts Options, provider ProviderID, api EmbeddingAPI, ...) error

type AnthropicMessagesCompat

+ SupportsTemperature AnthropicCompatSupport

type AssistantImages

+ func CollectImages(ctx context.Context, stream *ImageStream) (AssistantImages, error)

type Client

+ func (c *Client) Embed(ctx context.Context, model EmbeddingModel, req EmbeddingRequest, ...) (Embeddings, error)

+ func (c *Client) EmbedBatch(ctx context.Context, model EmbeddingModel, req EmbeddingRequest, ...) (EmbeddingBatchResult, error)

+ func (c *Client) EmbeddingModels() []EmbeddingModel

+ func (c *Client) GetEmbeddingModel(provider ProviderID, id ModelID) (EmbeddingModel, bool)

+ func (c *Client) StreamImages(ctx context.Context, model ImageModel, req ImageRequest, opts ...ImageOption) *ImageStream

+ type ClientEmbeddingEmbedder struct

+ func NewEmbeddingEmbedder(client *Client, model EmbeddingModel, config EmbeddingEmbedderConfig, ...) *ClientEmbeddingEmbedder

+ func (e *ClientEmbeddingEmbedder) EmbedDocuments(ctx context.Context, texts []string) ([][]float32, error)

+ func (e *ClientEmbeddingEmbedder) EmbedQuery(ctx context.Context, text string) ([]float32, error)

type Cost

+ func CostForEmbeddingUsage(model EmbeddingModel, usage Usage) Cost

type Diagnostic

+ ProviderCode string

+ ProviderMessage string

+ type Embedding struct

+ Index int

+ Vector []float32

+ type EmbeddingAPI string

+ const EmbeddingAPIOpenAIEmbeddings

+ type EmbeddingAttempt struct

+ API EmbeddingAPI

+ Attempt int

+ Latency time.Duration

+ Model ModelID

+ Provider ProviderID

+ RequestID string

+ StatusCode int

+ type EmbeddingBatchConfig struct

+ Cache EmbeddingCache

+ MaxBatchBytes int

+ MaxBatchInputs int

+ MaxParallelBatches int

+ MaxRetries int

+ Progress func(EmbeddingBatchProgress) error

+ ReuseDuplicateInputs bool

+ SplitOversized bool

+ SplitPolicy EmbeddingSplitPolicy

+ type EmbeddingBatchPhase string

+ const EmbeddingBatchPhaseBatchError

+ const EmbeddingBatchPhaseBatchStart

+ const EmbeddingBatchPhaseBatchSuccess

+ const EmbeddingBatchPhaseCacheHit

+ const EmbeddingBatchPhaseCacheLookup

+ const EmbeddingBatchPhaseCacheStore

+ const EmbeddingBatchPhaseLimitSplit

+ const EmbeddingBatchPhaseSplit

+ type EmbeddingBatchProgress struct

+ Attempt int

+ BatchSize int

+ Err error

+ InputIndexes []int

+ Phase EmbeddingBatchPhase

+ SplitPart int

+ SplitTotal int

+ type EmbeddingBatchResult struct

+ Embeddings Embeddings

+ Reused []bool

+ Summary EmbeddingBatchSummary

+ func EmbedBatch(ctx context.Context, model EmbeddingModel, req EmbeddingRequest, ...) (EmbeddingBatchResult, error)

+ type EmbeddingBatchSummary struct

+ Attempts []EmbeddingAttempt

+ Cost *Cost

+ ErrorCount int

+ RequestCount int

+ RequestIDs []string

+ StatusBuckets map[int]int

+ TotalRequestCount int

+ Trace []EmbeddingBatchTraceEvent

+ Usage *Usage

+ VectorCount int

+ type EmbeddingBatchTraceEvent struct

+ Attempt int

+ BatchBytes int

+ BatchSize int

+ CacheHit bool

+ CacheKey EmbeddingCacheKey

+ ErrorClass ErrorClass

+ ErrorMessage string

+ InputIndexes []int

+ MaxBatchBytes int

+ MaxBatchInputs int

+ Phase EmbeddingBatchPhase

+ ProviderAttempts []EmbeddingAttempt

+ ProviderCode string

+ RequestID string

+ Retryable bool

+ SplitPart int

+ SplitReason string

+ SplitRecoverable bool

+ SplitTotal int

+ StatusCode int

+ type EmbeddingCache interface

+ Get func(EmbeddingCacheKey) (Embedding, bool, error)

+ Set func(EmbeddingCacheKey, Embedding) error

+ type EmbeddingCacheKey struct

+ API EmbeddingAPI

+ Dimensions int

+ InputSHA256 string

+ InputType EmbeddingInputType

+ Model ModelID

+ Provider ProviderID

+ type EmbeddingEmbedder interface

+ EmbedDocuments func(ctx context.Context, texts []string) ([][]float32, error)

+ EmbedQuery func(ctx context.Context, text string) ([]float32, error)

+ type EmbeddingEmbedderConfig struct

+ Batch EmbeddingBatchConfig

+ Dimensions int

+ type EmbeddingInputType string

+ const EmbeddingInputTypeDocument

+ const EmbeddingInputTypeQuery

+ type EmbeddingModel struct

+ API EmbeddingAPI

+ CostCurrency string

+ DefaultDimensions int

+ ID ModelID

+ InputCostPerMillion float64

+ MaxBatchBytes int

+ MaxBatchInputs int

+ MaxDimensions int

+ MaxInputTokens int

+ MinDimensions int

+ Name string

+ Provider ProviderID

+ ProviderMetadata map[string]any

+ func EmbeddingModels() []EmbeddingModel

+ func GetEmbeddingModel(provider ProviderID, id ModelID) (EmbeddingModel, bool)

+ func OpenAICompatibleEmbeddingModel(config OpenAICompatibleEmbeddingModelConfig) EmbeddingModel

+ type EmbeddingOption func(*Options)

+ func WithEmbeddingAPIKey(apiKey string) EmbeddingOption

+ func WithEmbeddingAuthResolver(resolver AuthResolver) EmbeddingOption

+ func WithEmbeddingHTTPClient(httpClient *http.Client) EmbeddingOption

+ func WithEmbeddingHeader(key, value string) EmbeddingOption

+ func WithEmbeddingHeaders(headers map[string]string) EmbeddingOption

+ func WithEmbeddingMaxRetries(maxRetries int) EmbeddingOption

+ func WithEmbeddingMaxRetryDelay(maxRetryDelay time.Duration) EmbeddingOption

+ func WithEmbeddingMetadata(metadata map[string]any) EmbeddingOption

+ func WithEmbeddingMetadataValue(key string, value any) EmbeddingOption

+ func WithEmbeddingPayloadDebugHook(hook EmbeddingPayloadDebugHook) EmbeddingOption

+ func WithEmbeddingProviderAuthResolver(provider ProviderID, resolver AuthResolver) EmbeddingOption

+ func WithEmbeddingProviderOption(provider ProviderID, key string, value any) EmbeddingOption

+ func WithEmbeddingProviderOptions(provider ProviderID, values map[string]any) EmbeddingOption

+ func WithEmbeddingResponseDebugHook(hook EmbeddingResponseDebugHook) EmbeddingOption

+ func WithEmbeddingTimeout(timeout time.Duration) EmbeddingOption

+ type EmbeddingPayloadDebug struct

+ API EmbeddingAPI

+ Headers http.Header

+ Model ModelID

+ Payload []byte

+ PayloadPreview string

+ Provider ProviderID

+ type EmbeddingPayloadDebugHook func(context.Context, EmbeddingPayloadDebug) error

+ type EmbeddingProvider interface

+ API func() EmbeddingAPI

+ Embed func(context.Context, EmbeddingModel, EmbeddingRequest, Options) (Embeddings, error)

+ type EmbeddingRequest struct

+ Dimensions int

+ InputType EmbeddingInputType

+ Inputs []string

+ ProviderMetadata map[string]any

+ func EmbeddingDocuments(texts []string) EmbeddingRequest

+ func EmbeddingQuery(text string) EmbeddingRequest

+ type EmbeddingResponseDebug struct

+ API EmbeddingAPI

+ Headers http.Header

+ Model ModelID

+ Provider ProviderID

+ RequestID string

+ StatusCode int

+ type EmbeddingResponseDebugHook func(context.Context, EmbeddingResponseDebug) error

+ type EmbeddingScore struct

+ Embedding Embedding

+ Score float64

+ func RankEmbeddingsByCosine(query []float32, candidates []Embedding) ([]EmbeddingScore, error)

+ type EmbeddingSplitPolicy struct

+ PreferNewline bool

+ PreferWhitespace bool

+ type Embeddings struct

+ Attempts []EmbeddingAttempt

+ Cost *Cost

+ Model ModelID

+ Provider ProviderID

+ ProviderMetadata map[string]any

+ Usage *Usage

+ Vectors []Embedding

+ func Embed(ctx context.Context, model EmbeddingModel, req EmbeddingRequest, ...) (Embeddings, error)

+ type ErrorClass string

+ const ErrorClassAuth

+ const ErrorClassBilling

+ const ErrorClassContextOverflow

+ const ErrorClassInvalidRequest

+ const ErrorClassProvider

+ const ErrorClassQuota

+ const ErrorClassRateLimited

+ const ErrorClassTransient

+ const ErrorClassUnknown

+ type ErrorClassification struct

+ API API

+ Class ErrorClass

+ Err error

+ Message string

+ Model ModelID

+ Provider ProviderID

+ ProviderCode string

+ RequestID string

+ RetryHint RetryHint

+ SplitRecoverable bool

+ StatusCode int

+ func ClassifyError(err error) ErrorClassification

type Event

+ Image *ContentBlock

+ PartialImage *ContentBlock

type EventKind

+ const EventKindImageDelta

+ const EventKindImageEnd

+ const EventKindImageStart

+ type HTTPAttempt struct

+ Attempt int

+ Latency time.Duration

+ RequestID string

+ StatusCode int

+ func DoHTTPWithRetryAttempts(ctx context.Context, client *http.Client, opts Options, ...) (*http.Response, []HTTPAttempt, error)

type HTTPResponseHook

+ func EmbeddingResponseDebugHTTPHook(ctx context.Context, opts Options, provider ProviderID, api EmbeddingAPI, ...) HTTPResponseHook

+ type ImageEvent struct

+ Error string

+ FinalImages *AssistantImages

+ Image *ImageInput

+ Kind ImageEventKind

+ PartialImage *ImageInput

+ SequenceIndex *int

+ StopReason StopReason

+ Usage *Usage

+ func (event ImageEvent) IsTerminal() bool

+ type ImageEventKind string

+ const ImageEventKindDone

+ const ImageEventKindError

+ const ImageEventKindImage

+ const ImageEventKindPartial

+ const ImageEventKindStart

+ func (kind ImageEventKind) IsTerminal() bool

type ImageInput

+ func ImageFileID(id string) ImageInput

+ type ImageOperation string

+ const ImageOperationEdit

+ const ImageOperationGenerate

+ const ImageOperationVariation

type ImageRequest

+ Mask *ImageInput

+ Operation ImageOperation

+ type ImageStream struct

+ func StreamImages(ctx context.Context, model ImageModel, req ImageRequest, opts ...ImageOption) *ImageStream

+ func (s *ImageStream) Close()

+ func (s *ImageStream) Done() <-chan struct{}

+ func (s *ImageStream) Err() error

+ func (s *ImageStream) Events() <-chan ImageEvent

+ func (s *ImageStream) Final() (AssistantImages, bool)

+ type ImageStreamWriter interface

+ Close func()

+ Done func(context.Context, AssistantImages) error

+ Emit func(context.Context, ImageEvent) error

+ Error func(context.Context, error, AssistantImages) error

+ type InMemoryRetrievalIndex struct

+ func NewInMemoryRetrievalIndex(client *Client, model EmbeddingModel, config InMemoryRetrievalIndexConfig, ...) *InMemoryRetrievalIndex

+ func (i *InMemoryRetrievalIndex) AddChunks(ctx context.Context, chunks []RetrievalChunk) error

+ func (i *InMemoryRetrievalIndex) AddDocuments(ctx context.Context, docs []RetrievalDocument) error

+ func (i *InMemoryRetrievalIndex) Search(ctx context.Context, query string, limit int) ([]RetrievalResult, error)

+ type InMemoryRetrievalIndexConfig struct

+ Batch EmbeddingBatchConfig

+ Dimensions int

+ Splitter RetrievalSplitterConfig

type Model

+ UnsupportedThinkingLevels []ThinkingLevel

+ type OpenAICompatibleEmbeddingModelConfig struct

+ BaseURL string

+ CostCurrency string

+ DefaultDimensions int

+ Headers map[string]string

+ ID ModelID

+ InputCostPerMillion float64

+ MaxBatchBytes int

+ MaxBatchInputs int

+ MaxDimensions int

+ MaxInputTokens int

+ MinDimensions int

+ Name string

+ Provider ProviderID

+ ProviderMetadata map[string]any

type OpenAICompatibleModelConfig

+ UnsupportedThinkingLevels []ThinkingLevel

type OpenAICompletionsReasoningFormat

+ const OpenAICompletionsReasoningAntLing

+ const OpenAICompletionsReasoningQwen

+ const OpenAICompletionsReasoningTogether

+ const OpenAICompletionsReasoningZAI

type Options

+ EmbeddingPayloadDebugHooks []EmbeddingPayloadDebugHook

+ EmbeddingResponseDebugHooks []EmbeddingResponseDebugHook

type ProviderError

+ ProviderCode string

+ ProviderMessage string

type ProviderID

+ const ProviderAntLing

+ const ProviderAzureOpenAIResponses

+ const ProviderCloudflareAIGateway

+ const ProviderCloudflareWorkersAI

+ const ProviderMiniMax

+ const ProviderMiniMaxCN

+ const ProviderMoonshotAI

+ const ProviderMoonshotAICN

+ const ProviderNVIDIA

+ const ProviderOpenAICodex

+ const ProviderVercelAIGateway

+ const ProviderZAI

+ const ProviderZAICodingCN

type ProviderInfo

+ EmbeddingAPI EmbeddingAPI

type Registry

+ func (r *Registry) EmbeddingModel(provider ProviderID, id ModelID) (EmbeddingModel, bool)

+ func (r *Registry) EmbeddingProvider(id ProviderID) (EmbeddingProvider, bool)

+ func (r *Registry) ListEmbeddingModels() []EmbeddingModel

+ func (r *Registry) RegisterEmbeddingModel(model EmbeddingModel, opts ...RegisterOption) error

+ func (r *Registry) RegisterEmbeddingProvider(id ProviderID, provider EmbeddingProvider, opts ...RegisterOption) error

type RegistrySnapshot

+ EmbeddingModels []EmbeddingModel

+ type RetrievalChunk struct

+ DocumentID string

+ EndByte int

+ ID string

+ Metadata map[string]any

+ StartByte int

+ Text string

+ func SplitRetrievalDocuments(docs []RetrievalDocument, config RetrievalSplitterConfig) ([]RetrievalChunk, error)

+ func SplitRetrievalText(text string, config RetrievalSplitterConfig) ([]RetrievalChunk, error)

+ type RetrievalDocument struct

+ ID string

+ Metadata map[string]any

+ Text string

+ type RetrievalResult struct

+ Chunk RetrievalChunk

+ Score float64

+ type RetrievalSplitterConfig struct

+ ChunkOverlap int

+ ChunkSize int

+ KeepSeparator bool

+ Separators []string

+ type RetryHint struct

+ After time.Duration

+ Retryable bool

+ type StreamingImageProvider interface

+ StreamImages func(context.Context, ImageModel, ImageRequest, Options) *ImageStream

v0.2.0

May 30, 2026

Changes in this version

+ type AnthropicCompatSupport string

+ const AnthropicCompatDefault

+ const AnthropicCompatSupported

+ const AnthropicCompatUnsupported

+ type AnthropicMessagesCompat struct

+ SupportsCacheControlOnTools AnthropicCompatSupport

+ SupportsEagerToolInputStreaming AnthropicCompatSupport

+ SupportsEmptyThinkingSignature AnthropicCompatSupport

+ SupportsLongCacheRetention AnthropicCompatSupport

+ SupportsSessionAffinity AnthropicCompatSupport

+ ThinkingFormat AnthropicThinkingFormat

+ type AnthropicThinkingFormat string

+ const AnthropicThinkingAdaptive

+ const AnthropicThinkingBudget

+ const AnthropicThinkingDefault

+ type BedrockOptions struct

+ AdditionalModelRequestFields map[string]any

+ AdditionalModelResponseFieldPaths []string

+ InterleavedThinking *bool

+ RequestMetadata map[string]string

+ StopSequences []string

+ ThinkingDisplay BedrockThinkingDisplay

+ ToolChoice *BedrockToolChoice

+ TopP *float64

+ type BedrockThinkingDisplay string

+ const BedrockThinkingDisplayOmitted

+ const BedrockThinkingDisplaySummarized

+ type BedrockToolChoice struct

+ Name string

+ Type BedrockToolChoiceType

+ type BedrockToolChoiceType string

+ const BedrockToolChoiceAny

+ const BedrockToolChoiceAuto

+ const BedrockToolChoiceNone

+ const BedrockToolChoiceTool

type GoogleOptions

+ DisableThinking *bool

+ ToolChoice string

type Model

+ AnthropicMessagesCompat *AnthropicMessagesCompat

type OpenAICompletionsCacheControlFormat

+ const OpenAICompletionsCacheControlAnthropic

type OpenAICompletionsCompat

+ SupportsReasoningEffort OpenAICompatSupport

+ SupportsToolStream OpenAICompatSupport

type OpenAIOptions

+ ParallelToolCalls *bool

+ PromptCacheRetention string

+ ResponseFormat any

+ TextVerbosity string

+ ToolChoice any

+ TopLogprobs int

type OpenRouterRoutingPreference

+ MaxPrice map[string]any

+ PreferredMaxLatency any

+ PreferredMinThroughput any

+ Quantizations []string

type Option

+ func WithBedrockOptions(bedrockOptions BedrockOptions) Option

type Options

+ BedrockOptions *BedrockOptions

v0.1.0

May 29, 2026

Changes in this version

+ const DefaultMaxRetries

+ const DefaultMaxRetryDelay

+ const DefaultRetryBaseDelay

+ const ImageInputImage

+ const ImageInputText

+ const ImageSourceBase64

+ const ImageSourceURL

+ const MetadataAPIKeyEnvVar

+ const MetadataAPIKeyEnvVars

+ const MetadataOpenAICompatible

+ const MetadataOpenAICompatibleBaseURL

+ const MetadataOpenAICompatibleHeaders

+ var ErrAborted = errors.New("generation aborted")

+ var ErrContextOverflow = errors.New("context overflow")

+ var ErrCredentialUnavailable = errors.New("credential unavailable")

+ var ErrDebugHook = errors.New("debug hook failed")

+ var ErrInvalidOptions = errors.New("invalid options")

+ var ErrModelNotFound = errors.New("model not found")

+ var ErrNoProvider = errors.New("provider unavailable")

+ var ErrProviderResponse = errors.New("provider response error")

+ var ErrRetryAfterExceedsMaxDelay = errors.New("retry-after exceeds max retry delay")

+ var ErrToolValidation = errors.New("tool validation failed")

+ func CompleteText(ctx context.Context, model Model, prompt string, opts ...Option) (string, error)

+ func ContextWithRequestTimeout(ctx context.Context, opts Options) (context.Context, context.CancelFunc)

+ func DoHTTPWithRetry(ctx context.Context, client *http.Client, opts Options, ...) (*http.Response, error)

+ func MarshalRequest(req Request) ([]byte, error)

+ func NewStream(ctx context.Context) (*Stream, StreamWriter)

+ func ParseRetryAfter(value string, now time.Time) time.Duration

+ func RegisterDefaultImageModel(model ImageModel, opts ...RegisterOption) error

+ func RegisterDefaultImageProvider(id ProviderID, provider ImageProvider, opts ...RegisterOption) error

+ func RegisterDefaultModel(model Model, opts ...RegisterOption) error

+ func RegisterDefaultTextProvider(id ProviderID, provider TextProvider, opts ...RegisterOption) error

+ func RegisterModel(registry *Registry, model Model, opts ...RegisterOption) error

+ func RegisterProvider(registry *Registry, id ProviderID, provider TextProvider, ...) error

+ func RetryAfter(header http.Header) time.Duration

+ func RetryableNetworkError(err error) bool

+ func RetryableStatusCode(status int) bool

+ func RunImagePayloadDebugHooks(ctx context.Context, opts Options, provider ProviderID, api ImageAPI, ...) error

+ func RunTextPayloadDebugHooks(ctx context.Context, opts Options, provider ProviderID, api API, model ModelID, ...) error

+ func ToolErrorMessage(call ToolCall, err error) string

+ func ValidateModelRef(ref ModelRef) error

+ func ValidateRequest(req Request) error

+ func ValidateToolCall(tools []Tool, call ToolCall) (map[string]any, error)

+ type API string

+ const APIAnthropicMessages

+ const APIAzureOpenAIResponses

+ const APIBedrockConverseStream

+ const APIGoogleGenerativeAI

+ const APIGoogleVertex

+ const APIMistralConversations

+ const APIOpenAICodexResponses

+ const APIOpenAICompletions

+ const APIOpenAIResponses

+ type AnthropicOptions struct

+ ThinkingBudgetTokens *int

+ type AssistantImages struct

+ Cost *Cost

+ Errors []ImageError

+ Images []ImageInput

+ Model ModelID

+ Provider ProviderID

+ ProviderMetadata map[string]any

+ ResponseID string

+ StopReason StopReason

+ Usage *Usage

+ func GenerateImages(ctx context.Context, model ImageModel, req ImageRequest, opts ...ImageOption) (AssistantImages, error)

+ type AssistantMessage struct

+ Content []ContentBlock

+ Cost *Cost

+ Diagnostics []Diagnostic

+ Model ModelID

+ Provider ProviderID

+ ProviderMetadata map[string]any

+ StopReason StopReason

+ Usage *Usage

+ func Collect(ctx context.Context, stream *Stream) (AssistantMessage, error)

+ func Complete(ctx context.Context, model Model, req Request, opts ...Option) (AssistantMessage, error)

+ type AuthResolver interface

+ Resolve func(context.Context, Model, Options) (Credential, error)

+ type AuthResolverFunc func(context.Context, Model, Options) (Credential, error)

+ func (f AuthResolverFunc) Resolve(ctx context.Context, model Model, opts Options) (Credential, error)

+ type AzureOpenAIResponsesConfig struct

+ APIKeyEnvVar string

+ APIVersion string

+ CredentialSource string

+ Deployment string

+ Endpoint string

+ type CacheRetention string

+ const CacheRetentionEphemeral

+ const CacheRetentionLong

+ const CacheRetentionNone

+ const CacheRetentionPersistent

+ const CacheRetentionShort

+ func (retention CacheRetention) CacheEnabled() bool

+ func (retention CacheRetention) CacheLongLived() bool

+ func (retention CacheRetention) CacheShortLived() bool

+ type ChainAuthResolver struct

+ Client AuthResolver

+ Environment AuthResolver

+ ProviderCallbacks map[ProviderID]AuthResolver

+ func (r ChainAuthResolver) Resolve(ctx context.Context, model Model, opts Options) (Credential, error)

+ type Client struct

+ func New(opts ...ClientOption) *Client

+ func NewClient(opts ...ClientOption) *Client

+ func (c *Client) Complete(ctx context.Context, model Model, req Request, opts ...Option) (AssistantMessage, error)

+ func (c *Client) CompleteText(ctx context.Context, model Model, prompt string, opts ...Option) (string, error)

+ func (c *Client) GenerateImages(ctx context.Context, model ImageModel, req ImageRequest, opts ...ImageOption) (AssistantImages, error)

+ func (c *Client) GetImageModel(provider ProviderID, id ModelID) (ImageModel, bool)

+ func (c *Client) GetModel(provider ProviderID, id ModelID) (Model, bool)

+ func (c *Client) ImageModels() []ImageModel

+ func (c *Client) Models(filters ...ModelFilter) []Model

+ func (c *Client) Registry() *Registry

+ func (c *Client) Stream(ctx context.Context, model Model, req Request, opts ...Option) *Stream

+ type ClientOption func(*Client)

+ func WithAuthResolver(resolver AuthResolver) ClientOption

+ func WithDefaultHeader(key, value string) ClientOption

+ func WithDefaultHeaders(headers map[string]string) ClientOption

+ func WithDefaultOptions(opts ...Option) ClientOption

+ func WithHTTPClient(httpClient *http.Client) ClientOption

+ func WithRegistry(registry *Registry) ClientOption

+ type CloudCredentialProvider interface

+ Credential func(context.Context, Model, Options) (Credential, error)

+ type ContentBlock struct

+ Data string

+ ImageSource string

+ MIMEType string

+ ProviderMetadata map[string]any

+ ProviderSignature string

+ Redacted bool

+ Signature string

+ Text string

+ ThinkingText string

+ ToolArguments any

+ ToolCallID string

+ ToolName string

+ Type ContentBlockType

+ URL string

+ func ImageBase64(mimeType string, data string) ContentBlock

+ func ImageURL(mimeType string, url string) ContentBlock

+ func Text(text string) ContentBlock

+ func Thinking(text string, signature string) ContentBlock

+ func ToolCallBlock(id string, name string, arguments any) ContentBlock

+ type ContentBlockType string

+ const ContentBlockImage

+ const ContentBlockText

+ const ContentBlockThinking

+ const ContentBlockToolCall

+ type Cost struct

+ CacheReadInputCost float64

+ CacheWriteInputCost float64

+ Currency string

+ InputCost float64

+ OutputCost float64

+ TotalCost float64

+ func CostForUsage(model Model, usage Usage) Cost

+ type Credential struct

+ Expiry time.Time

+ Metadata map[string]any

+ Source string

+ Type CredentialType

+ Value string

+ func (c Credential) Format(state fmt.State, verb rune)

+ func (c Credential) String() string

+ type CredentialType string

+ const CredentialTypeAPIKey

+ const CredentialTypeCloudCredential

+ const CredentialTypeOAuthToken

+ type CredentialUnavailableError struct

+ Model ModelID

+ Provider ProviderID

+ Sources []string

+ func (e *CredentialUnavailableError) Error() string

+ func (e *CredentialUnavailableError) Is(target error) bool

+ type Diagnostic struct

+ API API

+ BodyPreview string

+ Kind string

+ MaxRetryDelayMillis int64

+ Message string

+ Model ModelID

+ Provider ProviderID

+ RequestID string

+ RetryAfterMillis int64

+ StatusCode int

+ UnderlyingMessage string

+ type EnvironmentAuthResolver struct

+ LookupEnv func(string) (string, bool)

+ func (r EnvironmentAuthResolver) Resolve(_ context.Context, model Model, _ Options) (Credential, error)

+ type Error struct

+ Code ErrorCode

+ Err error

+ Message string

+ Model ModelID

+ Provider ProviderID

+ func (e *Error) Error() string

+ func (e *Error) Is(target error) bool

+ func (e *Error) Unwrap() error

+ type ErrorCode string

+ const ErrorAborted

+ const ErrorContextOverflow

+ const ErrorDebugHook

+ const ErrorInvalidOptions

+ const ErrorInvalidRequest

+ const ErrorInvalidStreamEvent

+ const ErrorModelNotFound

+ const ErrorProviderNotFound

+ const ErrorProviderResponse

+ const ErrorStream

+ const ErrorStreamClosed

+ const ErrorToolValidation

+ const ErrorUnsupported

+ type Event struct

+ ContentIndex *int

+ DeltaText string

+ Error string

+ FinalMessage *AssistantMessage

+ Kind EventKind

+ PartialMessage *AssistantMessage

+ PartialToolCall *PartialToolCall

+ StopReason StopReason

+ Text string

+ Thinking string

+ ToolCall *ToolCall

+ Usage *Usage

+ func (event Event) IsDelta() bool

+ func (event Event) IsStart() bool

+ func (event Event) IsTerminal() bool

+ type EventKind string

+ const EventKindDone

+ const EventKindError

+ const EventKindStart

+ const EventKindTextDelta

+ const EventKindTextEnd

+ const EventKindTextStart

+ const EventKindThinkingDelta

+ const EventKindThinkingEnd

+ const EventKindThinkingStart

+ const EventKindToolCallDelta

+ const EventKindToolCallEnd

+ const EventKindToolCallStart

+ func (kind EventKind) IsDelta() bool

+ func (kind EventKind) IsStart() bool

+ func (kind EventKind) IsTerminal() bool

+ func (kind EventKind) String() string

+ type GenerationError struct

+ Err error

+ Final AssistantMessage

+ func (e *GenerationError) Error() string

+ func (e *GenerationError) FinalMessage() (AssistantMessage, bool)

+ func (e *GenerationError) String() string

+ func (e *GenerationError) Unwrap() error

+ type GoogleOptions struct

+ ThinkingBudgetTokens *int

+ type HTTPResponseHook func(*http.Response) error

+ func ImageResponseDebugHTTPHook(ctx context.Context, opts Options, provider ProviderID, api ImageAPI, ...) HTTPResponseHook

+ func TextResponseDebugHTTPHook(ctx context.Context, opts Options, provider ProviderID, api API, model ModelID) HTTPResponseHook

+ type ImageAPI string

+ const ImageAPIOpenAIImages

+ const ImageAPIOpenRouterImages

+ type ImageError struct

+ Code string

+ Message string

+ ProviderMetadata map[string]any

+ type ImageInput struct

+ Data string

+ MIMEType string

+ Source string

+ Text string

+ Type string

+ URL string

+ func ImageData(mimeType string, data string) ImageInput

+ func ImageOutputData(mimeType string, data string) ImageInput

+ func ImageOutputURL(mimeType string, url string) ImageInput

+ func ImageText(text string) ImageInput

+ type ImageModel struct

+ API ImageAPI

+ ID ModelID

+ MaxHeight int

+ MaxWidth int

+ Name string

+ Provider ProviderID

+ ProviderMetadata map[string]any

+ SupportedFormats []string

+ SupportedSizes []string

+ func GetImageModel(provider ProviderID, id ModelID) (ImageModel, bool)

+ func ImageModels() []ImageModel

+ type ImageOption func(*Options)

+ func WithImageAPIKey(apiKey string) ImageOption

+ func WithImageAuthResolver(resolver AuthResolver) ImageOption

+ func WithImageHTTPClient(httpClient *http.Client) ImageOption

+ func WithImageHeader(key, value string) ImageOption

+ func WithImageHeaders(headers map[string]string) ImageOption

+ func WithImageMaxRetries(maxRetries int) ImageOption

+ func WithImageMaxRetryDelay(maxRetryDelay time.Duration) ImageOption

+ func WithImageMetadata(metadata map[string]any) ImageOption

+ func WithImageMetadataValue(key string, value any) ImageOption

+ func WithImagePayloadDebugHook(hook ImagePayloadDebugHook) ImageOption

+ func WithImageProviderAuthResolver(provider ProviderID, resolver AuthResolver) ImageOption

+ func WithImageProviderOption(provider ProviderID, key string, value any) ImageOption

+ func WithImageProviderOptions(provider ProviderID, values map[string]any) ImageOption

+ func WithImageResponseDebugHook(hook ImageResponseDebugHook) ImageOption

+ func WithImageTimeout(timeout time.Duration) ImageOption

+ type ImagePayloadDebug struct

+ API ImageAPI

+ Headers http.Header

+ Model ModelID

+ Payload []byte

+ PayloadPreview string

+ Provider ProviderID

+ type ImagePayloadDebugHook func(context.Context, ImagePayloadDebug) error

+ type ImageProvider interface

+ API func() ImageAPI

+ Generate func(context.Context, ImageModel, ImageRequest, Options) (AssistantImages, error)

+ type ImageQuality string

+ const ImageQualityHigh

+ const ImageQualityLow

+ const ImageQualityMedium

+ type ImageRequest struct

+ Count int

+ Inputs []ImageInput

+ MIMEType string

+ Model ModelID

+ Prompt string

+ Provider ProviderID

+ ProviderMetadata map[string]any

+ Quality string

+ Size string

+ type ImageResponseDebug struct

+ API ImageAPI

+ Headers http.Header

+ Model ModelID

+ Provider ProviderID

+ RequestID string

+ StatusCode int

+ type ImageResponseDebugHook func(context.Context, ImageResponseDebug) error

+ type ImageSize string

+ const ImageSize1024x1024

+ const ImageSize1024x1536

+ const ImageSize1536x1024

+ type Message struct

+ API API

+ Content []ContentBlock

+ IsError bool

+ Model ModelID

+ Provider ProviderID

+ Role Role

+ StopReason StopReason

+ ToolCallID string

+ ToolName string

+ func ToolError(toolCallID string, text string) Message

+ func ToolResult(toolCallID string, text string) Message

+ func UserContent(blocks ...ContentBlock) Message

+ func UserText(text string) Message

+ type Model struct

+ API API

+ AzureOpenAIResponses *AzureOpenAIResponsesConfig

+ CacheReadInputCostPerMillion float64

+ CacheWriteInputCostPerMillion float64

+ ContextWindow int

+ CostCurrency string

+ DefaultTransport Transport

+ ID ModelID

+ InputCostPerMillion float64

+ MaxOutputTokens int

+ Name string

+ OpenAICodexResponses *OpenAICodexResponsesConfig

+ OpenAICompletionsCompat *OpenAICompletionsCompat

+ OutputCostPerMillion float64

+ Provider ProviderID

+ ProviderMetadata map[string]any

+ SupportedInputs []ContentBlockType

+ SupportsThinking bool

+ SupportsTools bool

+ ThinkingLevelMap map[ThinkingLevel]string

+ ThinkingLevels []ThinkingLevel

+ func GetModel(provider ProviderID, id ModelID) (Model, bool)

+ func Models(filters ...ModelFilter) []Model

+ func OpenAICompatibleModel(config OpenAICompatibleModelConfig) Model

+ func (model Model) ProviderThinkingLevel(level ThinkingLevel) (string, bool)

+ func (model Model) SupportsImages() bool

+ func (model Model) SupportsInput(kind ContentBlockType) bool

+ func (model Model) SupportsReasoning() bool

+ func (model Model) SupportsThinkingLevel(level ThinkingLevel) bool

+ type ModelFilter func(Model) bool

+ type ModelID string

+ type ModelRef struct

+ ID ModelID

+ Provider ProviderID

+ type OAuthTokenProvider interface

+ Token func(context.Context, Model, Options) (Credential, error)

+ type OAuthTokenProviderFunc func(context.Context, Model, Options) (Credential, error)

+ func (f OAuthTokenProviderFunc) Token(ctx context.Context, model Model, opts Options) (Credential, error)

+ type OpenAICodexResponsesConfig struct

+ Model string

+ type OpenAICompatSupport string

+ const OpenAICompatDefault

+ const OpenAICompatSupported

+ const OpenAICompatUnsupported

+ type OpenAICompatibleModelConfig struct

+ BaseURL string

+ CacheReadInputCostPerMillion float64

+ CacheWriteInputCostPerMillion float64

+ ContextWindow int

+ CostCurrency string

+ DefaultTransport Transport

+ Headers map[string]string

+ ID ModelID

+ InputCostPerMillion float64

+ MaxOutputTokens int

+ Name string

+ OpenAICompletionsCompat *OpenAICompletionsCompat

+ OutputCostPerMillion float64

+ Provider ProviderID

+ ProviderMetadata map[string]any

+ SupportedInputs []ContentBlockType

+ SupportsThinking bool

+ SupportsTools bool

+ ThinkingLevelMap map[ThinkingLevel]string

+ ThinkingLevels []ThinkingLevel

+ type OpenAICompletionsCacheControlFormat string

+ const OpenAICompletionsCacheControlContentPart

+ const OpenAICompletionsCacheControlDefault

+ const OpenAICompletionsCacheControlMessage

+ const OpenAICompletionsCacheControlUnsupported

+ type OpenAICompletionsCompat struct

+ CacheControlFormat OpenAICompletionsCacheControlFormat

+ MaxTokensField OpenAICompletionsMaxTokensField

+ OpenRouterRouting *OpenRouterRoutingPreference

+ ReasoningFormat OpenAICompletionsReasoningFormat

+ RequiresAssistantAfterToolResult OpenAICompatSupport

+ RequiresReasoningContentOnAssistantMessages OpenAICompatSupport

+ RequiresToolResultName OpenAICompatSupport

+ SupportsDeveloperRole OpenAICompatSupport

+ SupportsSessionAffinity OpenAICompatSupport

+ SupportsStore OpenAICompatSupport

+ SupportsStreamingUsage OpenAICompatSupport

+ SupportsStrictTools OpenAICompatSupport

+ VercelAIGatewayRouting *VercelAIGatewayRoutingPreference

+ type OpenAICompletionsMaxTokensField string

+ const OpenAICompletionsMaxCompletionTokens

+ const OpenAICompletionsMaxTokens

+ const OpenAICompletionsMaxTokensDefault

+ type OpenAICompletionsReasoningFormat string

+ const OpenAICompletionsReasoningDeepSeek

+ const OpenAICompletionsReasoningDefault

+ const OpenAICompletionsReasoningEffort

+ const OpenAICompletionsReasoningFireworks

+ const OpenAICompletionsReasoningObject

+ const OpenAICompletionsReasoningStringThinking

+ const OpenAICompletionsReasoningUnsupported

+ type OpenAIOptions struct

+ ReasoningEffort ThinkingLevel

+ ReasoningSummary string

+ ServiceTier string

+ type OpenRouterRoutingPreference struct

+ AllowFallbacks *bool

+ DataCollection string

+ EnforceDistillableText *bool

+ Ignore []string

+ Only []string

+ Order []string

+ RequireParameters *bool

+ Sort string

+ ZDR *bool

+ type Option func(*Options)

+ func WithAPIKey(apiKey string) Option

+ func WithAnthropicOptions(anthropicOptions AnthropicOptions) Option

+ func WithCacheRetention(retention CacheRetention) Option

+ func WithGoogleOptions(googleOptions GoogleOptions) Option

+ func WithHeader(key, value string) Option

+ func WithHeaders(headers map[string]string) Option

+ func WithMaxRetries(maxRetries int) Option

+ func WithMaxRetryDelay(maxRetryDelay time.Duration) Option

+ func WithMaxTokens(maxTokens int) Option

+ func WithMetadata(metadata map[string]any) Option

+ func WithMetadataValue(key string, value any) Option

+ func WithOpenAIOptions(openAIOptions OpenAIOptions) Option

+ func WithProviderAuthResolver(provider ProviderID, resolver AuthResolver) Option

+ func WithProviderOption(provider ProviderID, key string, value any) Option

+ func WithProviderOptions(provider ProviderID, values map[string]any) Option

+ func WithReasoningLevel(level ThinkingLevel) Option

+ func WithSessionID(sessionID string) Option

+ func WithTemperature(temperature float64) Option

+ func WithTextPayloadDebugHook(hook TextPayloadDebugHook) Option

+ func WithTextResponseDebugHook(hook TextResponseDebugHook) Option

+ func WithThinkingBudgetTokens(tokens int) Option

+ func WithTimeout(timeout time.Duration) Option

+ func WithTransport(transport Transport) Option

+ type Options struct

+ APIKey string

+ AnthropicOptions *AnthropicOptions

+ AuthResolver AuthResolver

+ CacheRetention CacheRetention

+ GoogleOptions *GoogleOptions

+ HTTPClient *http.Client

+ Headers map[string]string

+ ImagePayloadDebugHooks []ImagePayloadDebugHook

+ ImageResponseDebugHooks []ImageResponseDebugHook

+ MaxRetries *int

+ MaxRetryDelay *time.Duration

+ MaxTokens *int

+ Metadata map[string]any

+ OpenAIOptions *OpenAIOptions

+ ProviderAuthResolvers map[ProviderID]AuthResolver

+ ProviderOptions map[ProviderID]map[string]any

+ ReasoningLevel ThinkingLevel

+ SessionID string

+ Temperature *float64

+ TextPayloadDebugHooks []TextPayloadDebugHook

+ TextResponseDebugHooks []TextResponseDebugHook

+ ThinkingBudgetTokens *int

+ Timeout *time.Duration

+ Transport Transport

+ type PartialToolCall struct

+ ArgumentsDelta string

+ ID string

+ Name string

+ ProviderMetadata map[string]any

+ ProviderSignature string

+ type ProviderError struct

+ API API

+ BodyPreview string

+ Err error

+ MaxRetryDelay time.Duration

+ Model ModelID

+ Provider ProviderID

+ RequestID string

+ RetryAfter time.Duration

+ StatusCode int

+ func NewProviderError(provider ProviderID, api API, model ModelID, statusCode int, requestID string, ...) *ProviderError

+ func (e *ProviderError) Diagnostic() Diagnostic

+ func (e *ProviderError) Error() string

+ func (e *ProviderError) Format(state fmt.State, verb rune)

+ func (e *ProviderError) Is(target error) bool

+ func (e *ProviderError) String() string

+ func (e *ProviderError) Unwrap() error

+ type ProviderID string

+ const ProviderAmazonBedrock

+ const ProviderAnthropic

+ const ProviderCerebras

+ const ProviderCustom

+ const ProviderDeepSeek

+ const ProviderFireworks

+ const ProviderGitHubCopilot

+ const ProviderGoogle

+ const ProviderGoogleVertex

+ const ProviderGroq

+ const ProviderKimi

+ const ProviderMistral

+ const ProviderOpenAI

+ const ProviderOpenCode

+ const ProviderOpenCodeGo

+ const ProviderOpenRouter

+ const ProviderTogether

+ const ProviderXAI

+ const ProviderXiaomi

+ type ProviderInfo struct

+ ID ProviderID

+ ImageAPI ImageAPI

+ TextAPI API

+ type RegisterOption func(*registerOptions)

+ func WithMetadataOnly() RegisterOption

+ func WithOverride() RegisterOption

+ type Registry struct

+ func DefaultRegistry() *Registry

+ func NewRegistry() *Registry

+ func (r *Registry) Clone() *Registry

+ func (r *Registry) ImageModel(provider ProviderID, id ModelID) (ImageModel, bool)

+ func (r *Registry) ImageProvider(id ProviderID) (ImageProvider, bool)

+ func (r *Registry) ListImageModels() []ImageModel

+ func (r *Registry) ListModels() []Model

+ func (r *Registry) ListProviders() []ProviderInfo

+ func (r *Registry) Model(provider ProviderID, id ModelID) (Model, bool)

+ func (r *Registry) RegisterImageModel(model ImageModel, opts ...RegisterOption) error

+ func (r *Registry) RegisterImageProvider(id ProviderID, provider ImageProvider, opts ...RegisterOption) error

+ func (r *Registry) RegisterModel(model Model, opts ...RegisterOption) error

+ func (r *Registry) RegisterTextProvider(id ProviderID, provider TextProvider, opts ...RegisterOption) error

+ func (r *Registry) Snapshot() RegistrySnapshot

+ func (r *Registry) TextProvider(id ProviderID) (TextProvider, bool)

+ type RegistrySnapshot struct

+ ImageModels []ImageModel

+ Models []Model

+ Providers []ProviderInfo

+ type Request struct

+ Messages []Message

+ SystemPrompt string

+ Tools []Tool

+ func UnmarshalRequest(data []byte) (Request, error)

+ type Role string

+ const RoleAssistant

+ const RoleDeveloper

+ const RoleTool

+ const RoleUser

+ type Schema map[string]any

+ type StopReason string

+ const StopReasonAborted

+ const StopReasonContentFilter

+ const StopReasonEndTurn

+ const StopReasonError

+ const StopReasonMaxTokens

+ const StopReasonStopSequence

+ const StopReasonToolCalls

+ const StopReasonUnknown

+ type Stream struct

+ func StreamModel(ctx context.Context, model Model, req Request, opts ...Option) *Stream

+ func (s *Stream) Close()

+ func (s *Stream) Done() <-chan struct{}

+ func (s *Stream) Err() error

+ func (s *Stream) Events() <-chan Event

+ func (s *Stream) Final() (AssistantMessage, bool)

+ type StreamWriter interface

+ Close func()

+ Done func(context.Context, AssistantMessage) error

+ Emit func(context.Context, Event) error

+ Error func(context.Context, error, AssistantMessage) error

+ type TextPayloadDebug struct

+ API API

+ Headers http.Header

+ Model ModelID

+ Payload []byte

+ PayloadPreview string

+ Provider ProviderID

+ type TextPayloadDebugHook func(context.Context, TextPayloadDebug) error

+ type TextProvider interface

+ API func() API

+ Stream func(context.Context, Model, Request, Options) *Stream

+ type TextResponseDebug struct

+ API API

+ Headers http.Header

+ Model ModelID

+ Provider ProviderID

+ RequestID string

+ StatusCode int

+ type TextResponseDebugHook func(context.Context, TextResponseDebug) error

+ type ThinkingLevel string

+ const ThinkingLevelHigh

+ const ThinkingLevelLow

+ const ThinkingLevelMedium

+ const ThinkingLevelMinimal

+ const ThinkingLevelOff

+ const ThinkingLevelXHigh

+ type Tool struct

+ Description string

+ InputSchema any

+ Name string

+ ProviderDefinedOptions map[string]any

+ ProviderDefinedType string

+ ProviderMetadata map[string]any

+ type ToolCall struct

+ Arguments any

+ ID string

+ Name string

+ ProviderMetadata map[string]any

+ ProviderSignature string

+ type ToolValidationError struct

+ Actual string

+ Err error

+ Expected string

+ Path string

+ Reason string

+ ToolName string

+ func (e *ToolValidationError) Error() string

+ func (e *ToolValidationError) Is(target error) bool

+ func (e *ToolValidationError) Unwrap() error

+ type Transport string

+ const TransportHTTP

+ const TransportSSE

+ const TransportWebSocket

+ type Usage struct

+ CacheReadInputTokens int

+ CacheWriteInputTokens int

+ InputTokens int

+ OutputTokens int

+ ThinkingTokens int

+ TotalTokens int

+ func (usage Usage) Total() int

+ type VercelAIGatewayRoutingPreference struct

+ BYOK map[string]any

+ Caching string

+ Models []string

+ Only []string

+ Order []string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL