llm

Apr 19, 2026

Changes in this version

+ const AssistantPhaseCommentary

+ const AssistantPhaseFinalAnswer

+ const ProviderNameCodex

+ const ProviderNameDockerMR

+ type ApiType string

+ const ApiTypeAnthropicMessages

+ const ApiTypeAuto

+ const ApiTypeOpenAIChatCompletion

+ const ApiTypeOpenAIResponses

+ func (t *ApiType) UnmarshalText(b []byte) error

+ func (t ApiType) MarshalText() ([]byte, error)

+ func (t ApiType) Valid() bool

+ type AssistantPhase = msg.AssistantPhase

+ type DetectEnv struct

+ HTTPClient *http.Client

+ LLMOptions []Option

+ type DetectedProvider struct

+ Name string

+ Order int

+ Params map[string]any

+ Type string

type EventType

+ const StreamEventTokenEstimate

+ type Executor interface

+ CreateStream func(ctx context.Context, src Buildable) (Stream, error)

+ type IntentSelector struct

+ Model string

+ PreferredKinds []string

+ PreferredNames []string

+ Tags map[string]string

type Model

+ Pricing *usage.Pricing

+ type OfferingCandidate struct

+ ServiceID string

+ Source string

+ WireModel string

+ type PreferenceRule struct

+ Intent string

+ ProviderNames []string

+ ServiceIDs []string

+ type ProviderRegistry interface

+ Build func(ctx context.Context, req DetectedProvider, client *http.Client, opts []Option) (Provider, error)

+ Detect func(ctx context.Context, env DetectEnv, disabled map[string]bool) ([]DetectedProvider, error)

+ type ProviderWrapper func(RegisteredProvider, Executor) Executor

type Publisher

+ TokenEstimate func(r usage.Record)

+ UsageRecord func(r usage.Record)

+ type RegisteredProvider struct

+ Name string

+ Provider Provider

+ ServiceID string

type Request

+ ApiTypeHint ApiType

+ RequestMeta *RequestMeta

type RequestBuilder

+ func (b *RequestBuilder) ApiTypeHint(t ApiType) *RequestBuilder

+ func (b *RequestBuilder) EndUser(user string) *RequestBuilder

+ func (b *RequestBuilder) Metadata(metadata map[string]any) *RequestBuilder

+ func (b *RequestBuilder) RequestMeta(meta *RequestMeta) *RequestBuilder

type RequestEvent

+ ResolvedApiType ApiType

+ type RequestMeta struct

+ Metadata map[string]any

+ User string

+ func (m *RequestMeta) Clone() *RequestMeta

type RequestOption

+ func WithApiTypeHint(t ApiType) RequestOption

+ func WithEndUser(user string) RequestOption

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

+ func WithRequestMeta(meta *RequestMeta) RequestOption

+ type ResolvedModelSpec struct

+ Ambiguous bool

+ ExactName string

+ ExactServiceID string

+ FromIntent string

+ Offerings []OfferingCandidate

+ RawModel string

+ RequestedModel string

type Result

+ Drift func() *usage.Drift

+ TokenEstimates func() []usage.Record

+ UsageRecords func() []usage.Record

+ type RetryPolicy struct

+ EnableFallback bool

+ func DefaultRetryPolicy() RetryPolicy

+ type Service struct

+ func New(opts ...ServiceOption) (*Service, error)

+ func (s *Service) CreateStream(ctx context.Context, src Buildable) (Stream, error)

+ func (s *Service) ExplainModel(model string) (ResolvedModelSpec, []RegisteredProvider, error)

+ type ServiceConfig struct

+ AutoDetect bool

+ DetectedRequests []DetectedProvider

+ DisabledTypes map[string]bool

+ HTTPClient *http.Client

+ IntentAliases map[string]IntentSelector

+ LLMOptions []Option

+ Preferences []PreferenceRule

+ Providers []RegisteredProvider

+ Registry ProviderRegistry

+ RetryPolicy RetryPolicy

+ Wrappers []ProviderWrapper

+ type ServiceOption func(*ServiceConfig)

+ func WithAutoDetect() ServiceOption

+ func WithDetectedProvider(req DetectedProvider) ServiceOption

+ func WithIntentAlias(name string, sel IntentSelector) ServiceOption

+ func WithPreference(pref PreferenceRule) ServiceOption

+ func WithProvider(p Provider) ServiceOption

+ func WithProviderNamed(name string, p Provider) ServiceOption

+ func WithRegisteredProvider(p RegisteredProvider) ServiceOption

+ func WithRetryPolicy(p RetryPolicy) ServiceOption

+ func WithServiceHTTPClient(client *http.Client) ServiceOption

+ func WithServiceLLMOptions(opts ...Option) ServiceOption

+ func WithWrapper(w ProviderWrapper) ServiceOption

+ func WithoutAutoDetect() ServiceOption

+ func WithoutProviderType(typeName string) ServiceOption

type StreamStartedEvent

+ Provider string

+ type TokenEstimateEvent struct

+ Estimate usage.Record

+ func (e TokenEstimateEvent) Type() EventType

type UsageUpdatedEvent

+ Record usage.Record

Apr 14, 2026

Changes in this version

+ const CacheTTL1h

+ const CacheTTL5m

+ type Buildable interface

+ BuildRequest func(ctx context.Context) (Request, error)

+ type CacheOpt = msg.CacheOpt

+ type CacheTTL = msg.CacheTTL

type Request

+ func (r Request) BuildRequest(_ context.Context) (Request, error)

type RequestBuilder

+ func (b *RequestBuilder) Append(msgs ...Message) *RequestBuilder

+ func (b *RequestBuilder) Apply(opts ...RequestOption) *RequestBuilder

+ func (b *RequestBuilder) BuildRequest(_ context.Context) (Request, error)

+ func (b *RequestBuilder) System(text string, cache ...CacheOpt) *RequestBuilder

+ func (b *RequestBuilder) ToolChoice(tc ToolChoice) *RequestBuilder

+ func (b *RequestBuilder) Tools(defs ...tool.Definition) *RequestBuilder

+ func (b *RequestBuilder) User(text string, cache ...CacheOpt) *RequestBuilder

type RequestOption

+ func WithEffort(level Effort) RequestOption

+ func WithMaxTokens(n int) RequestOption

+ func WithMessages(msgs ...Message) RequestOption

+ func WithModel(model string) RequestOption

+ func WithOutputFormat(f OutputFormat) RequestOption

+ func WithSystem(text string, cache ...CacheOpt) RequestOption

+ func WithTemperature(t float64) RequestOption

+ func WithThinking(mode ThinkingMode) RequestOption

+ func WithToolChoice(tc ToolChoice) RequestOption

+ func WithTools(defs ...tool.Definition) RequestOption

+ func WithTopK(k int) RequestOption

+ func WithTopP(p float64) RequestOption

+ func WithUser(text string, cache ...CacheOpt) RequestOption

Apr 14, 2026

Changes in this version

+ func IsRetriableHTTPStatus(code int) bool

type Effort

+ func (e *Effort) UnmarshalText(b []byte) error

+ func (e Effort) MarshalText() ([]byte, error)

type OutputFormat

+ func (f *OutputFormat) UnmarshalText(b []byte) error

+ func (f OutputFormat) MarshalText() ([]byte, error)

type ThinkingMode

+ func (m *ThinkingMode) UnmarshalText(b []byte) error

+ func (m ThinkingMode) MarshalText() ([]byte, error)

type ToolChoice

+ func ParseToolChoice(s string) (ToolChoice, error)

+ type ToolChoiceFlag struct

+ Value ToolChoice

+ func (f *ToolChoiceFlag) UnmarshalText(b []byte) error

+ func (f ToolChoiceFlag) MarshalText() ([]byte, error)

Apr 14, 2026

Changes in this version

+ type Effort string

+ const EffortHigh

+ const EffortLow

+ const EffortMax

+ const EffortMedium

+ const EffortUnspecified

+ func (e Effort) IsEmpty() bool

+ func (e Effort) ToBudget(low, high int) (int, bool)

+ func (e Effort) Valid() bool

type EventType

+ const StreamEventModelResolved

+ const StreamEventProviderFailover

+ const StreamEventRequest

+ type ModelResolvedEvent struct

+ Name string

+ Resolved string

+ Resolver string

+ func (e ModelResolvedEvent) Type() EventType

type ProviderError

+ func NewErrAllProvidersFailed(provider string, errs []error) *ProviderError

+ type ProviderFailoverEvent struct

+ Error error

+ FailoverProvider string

+ Provider string

+ func (e ProviderFailoverEvent) Type() EventType

+ type ProviderRequest struct

+ Body json.RawMessage

+ Headers map[string]string

+ Method string

+ URL string

+ func ProviderRequestFromHTTP(req *http.Request, body []byte) ProviderRequest

type Publisher

+ Failover func(from, to string, err error)

+ ModelResolved func(resolver, name, resolved string)

type Request

+ Effort Effort

+ Thinking ThinkingMode

+ func BuildRequest(opts ...RequestOption) (Request, error)

+ type RequestBuilder struct

+ func NewRequestBuilder() *RequestBuilder

+ func (b *RequestBuilder) Build(opts ...RequestOption) (Request, error)

+ func (b *RequestBuilder) Coding() *RequestBuilder

+ func (b *RequestBuilder) Effort(level Effort) *RequestBuilder

+ func (b *RequestBuilder) MaxTokens(maxTokens int) *RequestBuilder

+ func (b *RequestBuilder) Model(modelID string) *RequestBuilder

+ func (b *RequestBuilder) OutputFormat(format OutputFormat) *RequestBuilder

+ func (b *RequestBuilder) Temperature(temperature float64) *RequestBuilder

+ func (b *RequestBuilder) Thinking(mode ThinkingMode) *RequestBuilder

+ func (b *RequestBuilder) TopK(k int) *RequestBuilder

+ func (b *RequestBuilder) TopP(p float64) *RequestBuilder

+ type RequestEvent struct

+ OriginalRequest Request

+ ProviderRequest ProviderRequest

+ func (e RequestEvent) Type() EventType

+ type RequestOption func(r *Request)

+ type ThinkingMode string

+ const ThinkingAuto

+ const ThinkingOff

+ const ThinkingOn

+ func (m ThinkingMode) IsOff() bool

+ func (m ThinkingMode) IsOn() bool

+ func (m ThinkingMode) Valid() bool

Apr 7, 2026

Changes in this version

type HttpClientOpts

+ ResponseHeaderTimeout time.Duration

+ TLSHandshakeTimeout time.Duration

Apr 2, 2026

Changes in this version

+ const ModelDefault

+ const ModelFast

+ const ModelPowerful

+ const RoleDeveloper

+ type AliasResolvingProvider struct

+ func ProviderWithAliasResolver(p Provider) *AliasResolvingProvider

+ type ContentPartEvent struct

+ Index int

+ Part msg.Part

+ func (e ContentPartEvent) Type() EventType

type DeltaEvent

+ Thinking string

+ func ThinkingDelta(text string) *DeltaEvent

type DeltaKind

+ const DeltaKindThinking

type EventType

+ const StreamEventContentPart

+ type ModelResolveFunc func(modelID string) (Model, error)

+ func (f ModelResolveFunc) Resolve(modelID string) (Model, error)

+ type ModelResolver interface

+ Resolve func(modelID string) (Model, error)

+ type Models []Model

+ func (m Models) ByAlias(alias string) (Model, bool)

+ func (m Models) ByID(id string) (Model, bool)

+ func (m Models) Models() Models

+ func (m Models) Resolve(modelID string) (Model, error)

+ type ModelsProvider interface

+ Models func() Models

+ type Named interface

+ Name func() string

+ type OptionDefaultModel struct

+ func WithDefaultModel() *OptionDefaultModel

+ type OptionModelsProvider struct

+ func WithModels(models Models) *OptionModelsProvider

+ func WithModelsProvider(modelsProvider ModelsProvider) *OptionModelsProvider

+ type OptionMultiple struct

+ func WithProviderOpts(opts ...ProviderOpt) *OptionMultiple

+ type OptionStreamer struct

+ func WithStreamer(streamer Streamer) *OptionStreamer

+ type OutputEffort string

+ const OutputEffortHigh

+ const OutputEffortLow

+ const OutputEffortMax

+ const OutputEffortMedium

+ func (e OutputEffort) Valid() bool

+ type OverageLimit struct

+ DisabledReason string

+ Status RateLimitStatus

type Provider

+ func NewProvider(name string, opts ...ProviderOpt) Provider

type ProviderError

+ RequestBody string

+ ResponseBody string

+ func NewErrAPIErrorWithRequest(provider string, requestBody string, statusCode int, responseBody string) *ProviderError

+ func (e *ProviderError) WithRequestBody(body string) *ProviderError

+ type ProviderOpt interface

type Publisher

+ ContentBlock func(evt ContentPartEvent)

+ type RateLimitStatus string

+ const RateLimitStatusAllowed

+ const RateLimitStatusBlocked

+ const RateLimitStatusOverBudget

+ type RateLimits struct

+ OrganizationID string

+ RequestID string

+ Unified *UnifiedRateLimit

+ func ParseRateLimits(headers map[string]string) *RateLimits

type Request

+ OutputEffort OutputEffort

+ ThinkingEffort ThinkingEffort

type Response

+ Thought func() string

+ ToolResults func() []tool.Result

+ type SmartCache struct

+ Threshold int

+ func NewSmartCache(threshold int) *SmartCache

+ func (sc *SmartCache) LastCachePointAt() int

+ func (sc *SmartCache) MarkCachePoint()

+ func (sc *SmartCache) Reset()

+ func (sc *SmartCache) ShouldMarkForCache() bool

+ func (sc *SmartCache) TotalTokensSeen() int

+ func (sc *SmartCache) UpdateTokenCount(n int)

+ type StreamFunc func(ctx context.Context, opts Request) (Stream, error)

+ func (f StreamFunc) CreateStream(ctx context.Context, opts Request) (Stream, error)

type StreamStartedEvent

+ Extra map[string]any

+ type ThinkingEffort string

+ const ThinkingEffortHigh

+ const ThinkingEffortLow

+ const ThinkingEffortMedium

+ const ThinkingEffortMinimal

+ const ThinkingEffortNone

+ const ThinkingEffortXHigh

+ func (r ThinkingEffort) Valid() bool

type ToolChoice

+ String func() string

type ToolChoiceAuto

+ func (t ToolChoiceAuto) String() string

type ToolChoiceNone

+ func (t ToolChoiceNone) String() string

type ToolChoiceRequired

+ func (t ToolChoiceRequired) String() string

type ToolChoiceTool

+ func (t ToolChoiceTool) String() string

+ type UnifiedRateLimit struct

+ FallbackPercentage float64

+ FiveHour *WindowLimit

+ Overage *OverageLimit

+ RepresentativeClaim string

+ ResetAt time.Time

+ SevenDay *WindowLimit

+ Status RateLimitStatus

+ type WindowLimit struct

+ ResetAt time.Time

+ Status RateLimitStatus

+ Utilization float64

Mar 25, 2026

Changes in this version

type DeltaKind

+ const DeltaKindTool

Mar 25, 2026

Changes in this version

+ func ApplyAnthropicToolOverhead(tc *TokenCount, numTools int)

+ type AssistantMessage interface

+ ToolCalls func() []tool.Call

+ func Assistant(content string, toolCalls ...tool.Call) AssistantMessage

+ func AssistantWithCacheHint(content string, cacheHint *CacheHint, toolCalls ...tool.Call) AssistantMessage

+ func ToolCalls(toolCalls ...tool.Call) AssistantMessage

+ type CompletedEvent struct

+ StopReason StopReason

+ func (e CompletedEvent) Type() EventType

+ type CountOpts struct

+ Encoding string

+ PerMsgOverhead int

+ ReplyPriming int

+ type DebugEvent struct

+ Data any

+ Message string

+ func (e DebugEvent) Type() EventType

+ type DeltaEvent struct

+ Index *uint32

+ Kind DeltaKind

+ Reasoning string

+ Text string

+ func (e *DeltaEvent) Type() EventType

+ func (e *DeltaEvent) WithIndex(idx uint32) *DeltaEvent

+ type DeltaKind string

+ const DeltaKindReasoning

+ const DeltaKindText

+ type Envelope struct

+ Data any

+ Meta EventMeta

+ Type EventType

+ type ErrorEvent struct

+ Error error

+ func (e ErrorEvent) Type() EventType

+ type Event interface

+ Type func() EventType

+ type EventHandler interface

+ Handle func(e Event)

+ type EventHandlerFunc func(e Event)

+ func (h EventHandlerFunc) Handle(e Event)

+ type EventMeta struct

+ After time.Duration

+ Attrs map[string]string

+ CreatedAt time.Time

+ Model string

+ RequestID string

+ Seq uint64

+ TraceID string

+ type EventType string

+ const StreamEventClosed

+ const StreamEventCompleted

+ const StreamEventDebug

+ const StreamEventStarted

+ const StreamEventUsageUpdated

type Message

+ CacheHint func() *CacheHint

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

+ UnmarshalJSON func([]byte) error

+ type MessageOpt interface

type Messages

+ func (m *Messages) Add(all ...Message) *Messages

+ func (m *Messages) Assistant(content string, toolCalls ...tool.Call) *Messages

+ func (m *Messages) System(content string) *Messages

+ func (m *Messages) Tool(toolCallID, output string) *Messages

+ func (m *Messages) ToolErr(toolCallID, output string) *Messages

+ func (m *Messages) User(content string) *Messages

+ type Publisher interface

+ Close func()

+ Completed func(completed CompletedEvent)

+ Debug func(msg string, data any)

+ Delta func(d *DeltaEvent)

+ Error func(err error)

+ Publish func(payload Event)

+ Routed func(routed RouteInfo)

+ Started func(started StreamStartedEvent)

+ ToolCall func(tc tool.Call)

+ Usage func(usage Usage)

+ func NewEventPublisher() (Publisher, <-chan Envelope)

+ type Response interface

+ Error func() error

+ Message func() AssistantMessage

+ Reasoning func() string

+ StopReason func() StopReason

+ Text func() string

+ ToolCalls func() []tool.Call

+ Usage func() *Usage

+ type Result interface

+ Next func() Messages

+ func ProcessEvents(ctx context.Context, ch <-chan Envelope) Result

+ type RouteInfo struct

+ Errors []error

+ ModelRequested string

+ ModelResolved string

+ Provider string

+ type RouteInfoEvent struct

+ RouteInfo RouteInfo

+ func (e RouteInfoEvent) Type() EventType

type StopReason

+ const StopReasonUnknown

+ type Stream <-chan Envelope

+ type StreamClosedEvent struct

+ func (e StreamClosedEvent) Type() EventType

+ type StreamCreatedEvent struct

+ func (e StreamCreatedEvent) Type() EventType

+ type StreamProcessor struct

+ func NewEventProcessor(ctx context.Context, ch <-chan Envelope) *StreamProcessor

+ func (r *StreamProcessor) HandleTool(handlers ...tool.NamedHandler) *StreamProcessor

+ func (r *StreamProcessor) OnDelta(fn TypedEventHandler[*DeltaEvent]) *StreamProcessor

+ func (r *StreamProcessor) OnEvent(fn EventHandler) *StreamProcessor

+ func (r *StreamProcessor) OnReasoningDelta(fn func(delta string)) *StreamProcessor

+ func (r *StreamProcessor) OnStart(fn TypedEventHandler[StreamStartedEvent]) *StreamProcessor

+ func (r *StreamProcessor) OnTextDelta(fn func(delta string)) *StreamProcessor

+ func (r *StreamProcessor) OnToolDelta(fn func(d ToolDeltaPart)) *StreamProcessor

+ func (r *StreamProcessor) Result() Result

+ func (r *StreamProcessor) WithAsyncToolDispatch() *StreamProcessor

+ func (r *StreamProcessor) WithToolDispatcher(d tool.DispatcherType) *StreamProcessor

+ type StreamStartedEvent struct

+ Model string

+ RequestID string

+ func (e StreamStartedEvent) Type() EventType

+ type SystemMessage interface

+ func System(content string, opts ...MessageOpt) SystemMessage

+ type TextMessage interface

+ Content func() string

+ type ToolCallEvent struct

+ ToolCall tool.Call

+ func (e ToolCallEvent) Type() EventType

+ type ToolDeltaPart struct

+ ToolArgs string

+ ToolID string

+ ToolName string

+ type ToolMessage interface

+ IsError func() bool

+ ToolCallID func() string

+ ToolOutput func() string

+ func Tool(toolCallID, output string) ToolMessage

+ func ToolErr(toolCallID, output string) ToolMessage

+ func ToolResult(tr tool.Result) ToolMessage

+ type TypedEventHandler func(e T)

+ func (h TypedEventHandler[T]) Handle(e Event)

+ type UsageUpdatedEvent struct

+ Usage Usage

+ func (e UsageUpdatedEvent) Type() EventType

+ type UserMessage interface

+ func User(content string, opts ...MessageOpt) UserMessage

Mar 23, 2026

Changes in this version

+ type OutputFormat string

+ const OutputFormatJSON

+ const OutputFormatText

+ type Request struct

+ CacheHint *CacheHint

+ MaxTokens int

+ Messages Messages

+ Model string

+ OutputFormat OutputFormat

+ ReasoningEffort ReasoningEffort

+ Temperature float64

+ ToolChoice ToolChoice

+ Tools []ToolDefinition

+ TopK int

+ TopP float64

+ func (o Request) Validate() error

Mar 23, 2026

Changes in this version

type StreamEvent

+ StopReason StopReason

Mar 23, 2026

Changes in this version

+ func CountMessage(model string, msg Message) (int, error)

+ func CountMessagesAndTools(tc *TokenCount, req TokenCountRequest, encoding string, perMsgOverhead int, ...) error

+ func CountMessagesAndToolsAnthropic(tc *TokenCount, req TokenCountRequest) error

+ func CountText(model, text string) (int, error)

type StreamResult

+ Routed *Routed

+ type TokenCount struct

+ AssistantTokens int

+ InputTokens int

+ OverheadTokens int

+ PerMessage []int

+ PerTool map[string]int

+ SystemTokens int

+ ToolResultTokens int

+ ToolsTokens int

+ UserTokens int

+ type TokenCountRequest struct

+ Messages Messages

+ Model string

+ Tools []ToolDefinition

+ type TokenCounter interface

+ CountTokens func(ctx context.Context, req TokenCountRequest) (*TokenCount, error)

Mar 23, 2026

Changes in this version

+ const ProviderNameAnthropic

+ const ProviderNameBedrock

+ const ProviderNameClaude

+ const ProviderNameOllama

+ const ProviderNameOpenAI

+ const ProviderNameOpenRouter

+ const ProviderNameRouter

+ var ErrAPIError = errors.New("API error")

+ var ErrBuildRequest = errors.New("build request error")

+ var ErrContextCancelled = errors.New("context cancelled")

+ var ErrMissingAPIKey = errors.New("missing API key")

+ var ErrNoProviders = errors.New("no providers configured")

+ var ErrProviderError = errors.New("provider error")

+ var ErrRequestFailed = errors.New("request failed")

+ var ErrStreamDecode = errors.New("stream decode error")

+ var ErrStreamRead = errors.New("stream read error")

+ var ErrUnknown = errors.New("unknown error")

+ var ErrUnknownModel = errors.New("unknown model")

+ func DefaultHttpClient() *http.Client

+ func DeltaIndex(i int) *uint32

+ func NewHttpClient(opts HttpClientOpts) *http.Client

+ func NewRequestID() string

+ type BoundToolSpec struct

+ func Handle[In, Out any](spec *ToolSpec[In], fn func(ctx context.Context, in In) (*Out, error)) *BoundToolSpec[In, Out]

+ func (b *BoundToolSpec[In, Out]) Definition() ToolDefinition

+ func (b *BoundToolSpec[In, Out]) Handle(ctx context.Context, call ToolCall) (string, error)

+ func (b *BoundToolSpec[In, Out]) ToolName() string

+ type Delta struct

+ Index *uint32

+ Reasoning string

+ Text string

+ ToolArgs string

+ ToolID string

+ ToolName string

+ Type DeltaType

+ func ReasoningDelta(idx *uint32, text string) *Delta

+ func TextDelta(idx *uint32, text string) *Delta

+ func ToolDelta(idx *uint32, id, name, argsFragment string) *Delta

+ type DeltaType string

+ const DeltaTypeReasoning

+ const DeltaTypeText

+ const DeltaTypeTool

+ type EventStream struct

+ func NewEventStream() *EventStream

+ func (s *EventStream) C() <-chan StreamEvent

+ func (s *EventStream) Close()

+ func (s *EventStream) Delta(d *Delta)

+ func (s *EventStream) Done(usage *Usage)

+ func (s *EventStream) Error(err *ProviderError)

+ func (s *EventStream) Routed(r Routed)

+ func (s *EventStream) Send(ev StreamEvent)

+ func (s *EventStream) Start(opts StreamStartOpts)

+ func (s *EventStream) ToolCall(tc ToolCall)

+ type HttpClientOpts struct

+ Debug bool

+ Logger *slog.Logger

type Messages

+ func (m *Messages) AddAssistantMsg(content string, toolCalls ...ToolCall)

+ func (m *Messages) AddSystemMsg(content string)

+ func (m *Messages) AddToolCallResult(toolCallID, output string, isError bool)

+ func (m *Messages) AddUserMsg(content string)

+ func (m *Messages) Append(msg ...Message)

type Option

+ func WithHTTPClient(c *http.Client) Option

+ func WithLogger(l *slog.Logger) Option

type Options

+ HTTPClient *http.Client

+ Logger *slog.Logger

+ type ProviderError struct

+ Body string

+ Cause error

+ Message string

+ Provider string

+ Sentinel error

+ StatusCode int

+ func AsProviderError(provider string, err error) *ProviderError

+ func NewErrAPIError(provider string, statusCode int, body string) *ProviderError

+ func NewErrBuildRequest(provider string, cause error) *ProviderError

+ func NewErrContextCancelled(provider string, cause error) *ProviderError

+ func NewErrMissingAPIKey(provider string) *ProviderError

+ func NewErrNoProviders(provider string) *ProviderError

+ func NewErrProviderMsg(provider string, msg string) *ProviderError

+ func NewErrRequestFailed(provider string, cause error) *ProviderError

+ func NewErrStreamDecode(provider string, cause error) *ProviderError

+ func NewErrStreamRead(provider string, cause error) *ProviderError

+ func NewErrUnknownModel(provider string, modelID string) *ProviderError

+ func (e *ProviderError) Error() string

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

+ func (e *ProviderError) MarshalJSON() ([]byte, error)

+ func (e *ProviderError) Unwrap() error

+ type Routed struct

+ Errors []error

+ ModelRequested string

+ ModelResolved string

+ Provider string

+ func (r Routed) MarshalJSON() ([]byte, error)

+ type StopReason string

+ const StopReasonCancelled

+ const StopReasonContentFilter

+ const StopReasonEndTurn

+ const StopReasonError

+ const StopReasonMaxTokens

+ const StopReasonToolUse

type StreamEvent

+ RequestID string

+ Routed *Routed

+ Seq uint64

+ Timestamp time.Time

+ func (e StreamEvent) ReasoningText() string

+ func (e StreamEvent) Text() string

type StreamEventType

+ const StreamEventCreated

+ const StreamEventRouted

+ type StreamRequest struct

+ CacheHint *CacheHint

+ Messages Messages

+ Model string

+ ReasoningEffort ReasoningEffort

+ ToolChoice ToolChoice

+ Tools []ToolDefinition

+ func (o StreamRequest) Validate() error

+ type StreamResponse struct

+ func Process(ctx context.Context, ch <-chan StreamEvent) *StreamResponse

+ func (r *StreamResponse) DispatchAsync() *StreamResponse

+ func (r *StreamResponse) HandleTool(handlers ...ToolHandler) *StreamResponse

+ func (r *StreamResponse) OnReasoning(fn func(chunk string)) *StreamResponse

+ func (r *StreamResponse) OnStart(fn func(*StreamStart)) *StreamResponse

+ func (r *StreamResponse) OnText(fn func(chunk string)) *StreamResponse

+ func (r *StreamResponse) OnToolDelta(fn func(d *Delta)) *StreamResponse

+ func (r *StreamResponse) Result() <-chan *StreamResult

+ func (r *StreamResponse) WithToolDispatcher(d ToolDispatcher) *StreamResponse

+ type StreamResult struct

+ Reasoning string

+ Start *StreamStart

+ StopReason StopReason

+ Text string

+ ToolCalls []ToolCall

+ ToolResults []ToolCallResult

+ Usage *Usage

+ func (r *StreamResult) Apply(msgs *Messages)

+ func (r *StreamResult) Error() error

+ func (r *StreamResult) Message() *AssistantMsg

+ func (r *StreamResult) Next() []Message

type StreamStart

+ Model string

+ func (s StreamStart) MarshalJSON() ([]byte, error)

+ type StreamStartOpts struct

+ Model string

+ RequestID string

+ type ToolDispatcher int

+ const ToolDispatchAsync

+ const ToolDispatchSync

+ type ToolHandler interface

+ Handle func(ctx context.Context, call ToolCall) (string, error)

+ ToolName func() string

+ func NewToolHandler[In, Out any](name string, fn func(ctx context.Context, in In) (*Out, error)) ToolHandler

Mar 22, 2026

Changes in this version

+ type SortedMap struct

+ func NewSortedMap(m map[string]any) *SortedMap

+ func (sm *SortedMap) MarshalJSON() ([]byte, error)

type Usage

+ CacheReadCost float64

+ CacheReadTokens int

Mar 21, 2026

Changes in this version

type Usage

+ CacheWriteCost float64

+ CachedCost float64

+ InputCost float64

+ OutputCost float64

Mar 21, 2026

Changes in this version

type AssistantMsg

+ CacheHint *CacheHint

+ type CacheHint struct

+ Enabled bool

+ TTL string

type StreamOptions

+ CacheHint *CacheHint

type SystemMsg

+ CacheHint *CacheHint

type ToolCallResult

+ CacheHint *CacheHint

type Usage

+ CacheWriteTokens int

type UserMsg

+ CacheHint *CacheHint

Mar 19, 2026

Changes in this version

type StreamOptions

+ PromptCacheRetention string

+ type Streamer interface

+ CreateStream func(ctx context.Context, opts StreamOptions) (<-chan StreamEvent, error)

Mar 18, 2026

Changes in this version

type Model

+ Aliases []string

+ type Resolver interface

+ Resolve func(modelID string) (Model, error)

type StreamEvent

+ Start *StreamStart

type StreamEventType

+ const StreamEventStart

+ type StreamStart struct

+ ProviderModel string

+ RequestID string

+ RequestedModel string

+ ResolvedModel string

+ TimeToFirstToken time.Duration

Feb 27, 2026

Changes in this version

+ type RegisterFunc func(*Registry)

type Registry

+ func (r *Registry) RegisterAll(fns ...RegisterFunc)

Feb 26, 2026

Changes in this version

+ type Option func(*Options)

+ func APIKeyFromEnv(candidates ...string) Option

+ func WithAPIKey(key string) Option

+ func WithAPIKeyFunc(f func(ctx context.Context) (string, error)) Option

+ func WithBaseURL(url string) Option

+ type Options struct

+ APIKeyFunc func(ctx context.Context) (string, error)

+ BaseURL string

+ func Apply(opts ...Option) *Options

+ func (o *Options) ResolveAPIKey(ctx context.Context) (string, error)

Feb 16, 2026

Changes in this version

type Usage

+ CachedTokens int

+ ReasoningTokens int

Feb 16, 2026

Changes in this version

type ReasoningEffort

+ func (r ReasoningEffort) Valid() bool

type ToolDefinition

+ func (t ToolDefinition) Validate() error

Feb 16, 2026

Changes in this version

+ type ReasoningEffort string

+ const ReasoningEffortHigh

+ const ReasoningEffortLow

+ const ReasoningEffortMedium

+ const ReasoningEffortMinimal

+ const ReasoningEffortNone

+ const ReasoningEffortXHigh

type StreamOptions

+ ReasoningEffort ReasoningEffort

Feb 16, 2026

Changes in this version

type StreamOptions

+ ToolChoice ToolChoice

+ func (o StreamOptions) Validate() error

+ type ToolChoice interface

+ type ToolChoiceAuto struct

+ type ToolChoiceNone struct

+ type ToolChoiceRequired struct

+ type ToolChoiceTool struct

+ Name string

Feb 16, 2026

Changes in this version

+ type AssistantMsg struct

+ Content string

+ ToolCalls []ToolCall

+ func (m *AssistantMsg) MarshalJSON() ([]byte, error)

+ func (m *AssistantMsg) Role() Role

+ func (m *AssistantMsg) Validate() error

type Message

+ Validate func() error

+ type Messages []Message

+ func (m *Messages) UnmarshalJSON(data []byte) error

+ type SystemMsg struct

+ Content string

+ func (m *SystemMsg) MarshalJSON() ([]byte, error)

+ func (m *SystemMsg) Role() Role

+ func (m *SystemMsg) Validate() error

type ToolCall

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

+ func (tc ToolCall) MarshalJSON() ([]byte, error)

+ func (tc ToolCall) Validate() error

type ToolCallResult

+ ToolCallID string

+ func (m *ToolCallResult) MarshalJSON() ([]byte, error)

+ func (m *ToolCallResult) Role() Role

+ func (m *ToolCallResult) Validate() error

+ type UserMsg struct

+ Content string

+ func (m *UserMsg) MarshalJSON() ([]byte, error)

+ func (m *UserMsg) Role() Role

+ func (m *UserMsg) Validate() error

Feb 14, 2026

Changes in this version

+ var ErrBadRequest = errors.New("bad request")

+ var ErrNotFound = errors.New("not found")

+ type Message struct

+ Content string

+ ID string

+ Role Role

+ ToolCallID string

+ ToolCalls []ToolCall

+ type Model struct

+ ID string

+ Name string

+ Provider string

+ type ModelFetcher interface

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

+ type OAuthConfig struct

+ Access string

+ Expires int64

+ Refresh string

+ type ParsedToolCall interface

+ ToolCallID func() string

+ ToolName func() string

+ type Provider interface

+ CreateStream func(ctx context.Context, opts StreamOptions) (<-chan StreamEvent, error)

+ Models func() []Model

+ Name func() string

+ type ProviderConfig struct

+ APIKey string

+ OAuth *OAuthConfig

+ func (c *ProviderConfig) GetAccessToken() string

+ type Registry struct

+ func NewRegistry() *Registry

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

+ func (r *Registry) CreateStream(ctx context.Context, opts StreamOptions) (<-chan StreamEvent, error)

+ func (r *Registry) FetchModels(ctx context.Context, name string) ([]Model, error)

+ func (r *Registry) Provider(name string) (Provider, error)

+ func (r *Registry) Register(p Provider)

+ func (r *Registry) ResolveModel(ref string) (Provider, string, error)

+ type Role string

+ const RoleAssistant

+ const RoleSystem

+ const RoleTool

+ const RoleUser

+ type StreamEvent struct

+ Delta string

+ Error error

+ Reasoning string

+ ToolCall *ToolCall

+ Type StreamEventType

+ Usage *Usage

+ type StreamEventType string

+ const StreamEventDelta

+ const StreamEventDone

+ const StreamEventError

+ const StreamEventReasoning

+ const StreamEventToolCall

+ type StreamOptions struct

+ Messages []Message

+ Model string

+ Tools []ToolDefinition

+ type ToolCall struct

+ Arguments map[string]any

+ ID string

+ Name string

+ Result *ToolCallResult

+ type ToolCallResult struct

+ IsError bool

+ Output string

+ type ToolDefinition struct

+ Description string

+ Name string

+ Parameters map[string]any

+ func ToolDefinitionFor[T any](name, description string) ToolDefinition

+ type ToolSet struct

+ func NewToolSet(tools ...toolRegistration) *ToolSet

+ func (ts *ToolSet) Definitions() []ToolDefinition

+ func (ts *ToolSet) Parse(calls []ToolCall) ([]ParsedToolCall, error)

+ type ToolSpec struct

+ func NewToolSpec[T any](name, description string) *ToolSpec[T]

+ func (s *ToolSpec[T]) Definition() ToolDefinition

+ type TypedToolCall struct

+ ID string

+ Name string

+ Params T

+ func (c *TypedToolCall[T]) ToolCallID() string

+ func (c *TypedToolCall[T]) ToolName() string

+ type Usage struct

+ Cost float64

+ InputTokens int

+ OutputTokens int

+ TotalTokens int