ai

package

Go to main page

Versions in this module

v0

v0.6.0

Sep 12, 2026

Changes in this version

+ func SetAssistantMessageModelOmitted(message *AssistantMessage, omitted bool)

+ func SetAssistantMessageProviderThinkingLevelBeforeUsage(message *AssistantMessage, before bool)

+ func SetAssistantMessageRawStopBeforeDiagnostics(message *AssistantMessage, before bool)

+ type AnthropicAllowedFallbackModel struct

+ Cost ModelCost

+ Model string

+ Provider ProviderID

type AnthropicMessagesCompat

+ AllowedFallbackModels *[]AnthropicAllowedFallbackModel

+ SupportsMidConvoEffort *bool

type AssistantMessage

+ ProviderThinkingLevel *string

type OpenAICompletionsCompat

+ SupportsThinkingTokenBudget *bool

+ ThinkingTokenBudgetField *ThinkingTokenBudgetField

+ VLLMPriority *float64

type OpenAIResponsesCompat

+ SupportsMaxOutputTokens *bool

type ThinkingContent

+ RedactedChunks []json.RawMessage

+ type ThinkingTokenBudgetField string

v0.5.2

Sep 4, 2026

v0.5.1

Sep 3, 2026

v0.5.0

Aug 18, 2026

Changes in this version

type AssistantMessage

+ EndTurn *bool

type OpenAIResponsesCompat

+ SupportsAdditionalTools *bool

type ToolCall

+ Namespace *string

v0.4.16

Aug 13, 2026

v0.4.15

Aug 11, 2026

v0.4.14

Aug 11, 2026

Changes in this version

+ func SetToolCallArgumentsNormalizedJSON(content *ToolCall, data []byte) error

v0.4.13

Aug 10, 2026

v0.4.12

Aug 10, 2026

Changes in this version

type OpenAICompletionsCompat

+ ChatTemplateArgs *map[string]any

+ SupportsFinishReason *bool

type ThinkingFormat

+ const ThinkingFormatBaseten

v0.4.11

Aug 3, 2026

v0.4.10

Jul 30, 2026

Changes in this version

+ const ImagesAPIOpenRouter

+ const ImagesProviderOpenRouter

+ const ImagesStopReasonAborted

+ const ImagesStopReasonError

+ const ImagesStopReasonStop

+ const ModelsErrorAuth

+ const ModelsErrorModelSource

+ const ModelsErrorModelValidation

+ const ModelsErrorOAuth

+ const ModelsErrorProvider

+ const ModelsErrorStream

+ var ErrStreamIncomplete = errors.New("ai: stream ended without a terminal event")

+ func CalculateCost(model *Model, usage *Usage)

+ func CleanupSessionResources(sessionID ...string) error

+ func ContentText(content any, separators ...string) string

+ func HasAPI(model *Model, api API) bool

+ func IsContextOverflow(message *AssistantMessage, contextWindow float64) bool

+ func IsRetryableAssistantError(message *AssistantMessage) bool

+ func Marshal(value any) ([]byte, error)

+ func MarshalAssistantMessageEvent(event AssistantMessageEvent) ([]byte, error)

+ func MarshalMessage(message Message) ([]byte, error)

+ func MarshalToolCallArguments(content *ToolCall) ([]byte, error)

+ func ModelsAreEqual(a, b *Model) bool

+ func NormalizeJSONStringifyJSON(data []byte) ([]byte, error)

+ func ParseStreamingJSON(input string) any

+ func RegisterSessionResourceCleanup(cleanup SessionResourceCleanup) func()

+ func SetAssistantMessageErrorBeforeResponseID(message *AssistantMessage, enabled bool)

+ func SetAssistantMessageErrorBeforeTimestamp(message *AssistantMessage, enabled bool)

+ func SetToolCallArgumentsJSON(content *ToolCall, data []byte) error

+ func SetUsageOptionalsBeforeTotals(usage *Usage)

+ func ToolCallArgumentsValue(content *ToolCall) any

+ func TotalCost(cost Cost) float64

+ func UUIDv7() (string, error)

+ type API string

+ const APIAnthropicMessages

+ const APIAzureOpenAIResponses

+ const APIBedrockConverse

+ const APIGoogleGenerativeAI

+ const APIGoogleVertex

+ const APIMistralConversations

+ const APIOpenAICodexResponses

+ const APIOpenAICompletions

+ const APIOpenAIResponses

+ const APIPiMessages

+ const APIUnknown

+ type AnthropicMessagesCompat struct

+ AllowEmptySignature *bool

+ ForceAdaptiveThinking *bool

+ SendSessionAffinityHeaders *bool

+ SupportsCacheControlOnTools *bool

+ SupportsEagerToolInputStreaming *bool

+ SupportsLongCacheRetention *bool

+ SupportsStrictTools *bool

+ SupportsTemperature *bool

+ SupportsToolReferences *bool

+ type AssistantCall func() (*AssistantMessage, error)

+ type AssistantContent []AssistantContentBlock

+ func (blocks *AssistantContent) UnmarshalJSON(data []byte) error

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

+ type AssistantContentBlock interface

+ type AssistantImages struct

+ API ImagesAPI

+ ErrorMessage *string

+ Model string

+ Output ImagesContent

+ Provider ImagesProviderID

+ ResponseID *string

+ StopReason ImagesStopReason

+ Timestamp int64

+ Usage *Usage

+ type AssistantMessage struct

+ API API

+ Content AssistantContent

+ Diagnostics *[]AssistantMessageDiagnostic

+ ErrorMessage *string

+ Model string

+ Provider ProviderID

+ RawStopReason *string

+ ResponseID *string

+ ResponseModel *string

+ StopReason StopReason

+ Timestamp int64

+ Usage Usage

+ func Collect(events AssistantMessageEventStream) (*AssistantMessage, error)

+ func RetryAssistantCall(ctx context.Context, produce AssistantCall, policy *RetryPolicy, ...) (*AssistantMessage, error)

+ func (message *AssistantMessage) UnmarshalJSON(data []byte) error

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

+ type AssistantMessageDiagnostic struct

+ Details json.RawMessage

+ Error *DiagnosticErrorInfo

+ Timestamp int64

+ Type string

+ func (diagnostic *AssistantMessageDiagnostic) UnmarshalJSON(data []byte) error

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

+ type AssistantMessageEvent interface

+ func UnmarshalAssistantMessageEvent(data []byte) (AssistantMessageEvent, error)

+ type AssistantMessageEventStream = iter.Seq2[AssistantMessageEvent, error]

+ type BedrockCompat struct

+ SupportsStrictMode *bool

+ type CacheControlFormat string

+ const CacheControlAnthropic

+ type CacheRetention string

+ const CacheRetentionLong

+ const CacheRetentionNone

+ const CacheRetentionShort

+ type ConstrainedSamplingConfig struct

+ Strict ConstrainedSamplingStrict

+ Type ConstrainedSamplingType

+ Variants *GrammarVariants

+ type ConstrainedSamplingStrict string

+ const ConstrainedSamplingPrefer

+ const ConstrainedSamplingRequire

+ type ConstrainedSamplingType string

+ const ConstrainedSamplingGrammar

+ const ConstrainedSamplingJSONSchema

+ type Context struct

+ Messages MessageList

+ SystemPrompt *string

+ Tools *[]Tool

+ type Cost struct

+ CacheRead float64

+ CacheWrite float64

+ Input float64

+ Output float64

+ Total float64

+ type CreateImagesProviderOptions struct

+ API ImagesFunction

+ Auth auth.ProviderAuth

+ ID ImagesProviderID

+ Models []ImagesModel

+ Name string

+ RefreshModels func(context.Context) ([]ImagesModel, error)

+ type DeferredToolsMode string

+ const DeferredToolsKimi

+ type DiagnosticErrorInfo struct

+ Code json.RawMessage

+ Message string

+ Name *string

+ Stack *string

+ func (info *DiagnosticErrorInfo) UnmarshalJSON(data []byte) error

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

+ type DoneEvent struct

+ Message *AssistantMessage

+ Reason StopReason

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

+ type ErrorEvent struct

+ Error *AssistantMessage

+ Reason StopReason

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

+ type GrammarVariants struct

+ OpenAILark *string

+ OpenAIRegex *string

+ type HeadersHook func(ctx context.Context, headers ProviderHeaders, model *Model) (ProviderHeaders, error)

+ type ImageContent struct

+ Data string

+ MimeType string

+ func (content *ImageContent) UnmarshalJSON(data []byte) error

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

+ type ImagesAPI string

+ type ImagesContent []ImagesContentBlock

+ func (blocks *ImagesContent) UnmarshalJSON(data []byte) error

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

+ type ImagesContentBlock interface

+ type ImagesContext struct

+ Input ImagesContent

+ type ImagesFunction func(ctx context.Context, request ImagesRequest) (*AssistantImages, error)

+ type ImagesModel struct

+ API ImagesAPI

+ BaseURL string

+ Cost ModelCost

+ Headers *map[string]string

+ ID string

+ Input InputModalities

+ Name string

+ Output InputModalities

+ Provider ImagesProviderID

+ ThinkingLevelMap *map[ModelThinkingLevel]*string

+ type ImagesModels interface

+ GenerateImages func(context.Context, ImagesRequest) (*AssistantImages, error)

+ GetAuth func(context.Context, ImagesProviderID, *auth.ResolutionOverrides) (*auth.AuthResult, error)

+ GetModel func(ImagesProviderID, string) *ImagesModel

+ GetModelAuth func(context.Context, *ImagesModel, *auth.ResolutionOverrides) (*auth.AuthResult, error)

+ GetModels func(...ImagesProviderID) []ImagesModel

+ GetProvider func(ImagesProviderID) ImagesProvider

+ GetProviders func() []ImagesProvider

+ Refresh func(context.Context, ...ImagesProviderID) error

+ type ImagesModelsOptions struct

+ AuthContext auth.AuthContext

+ Credentials auth.CredentialStore

+ type ImagesOptions struct

+ APIKey *string

+ Env ProviderEnv

+ HTTPClient *http.Client

+ Headers ProviderHeaders

+ MaxRetries *int

+ MaxRetryDelayMS *int64

+ Metadata map[string]any

+ OnPayload ImagesPayloadHook

+ OnResponse ImagesResponseHook

+ TimeoutMS *int64

+ type ImagesPayloadHook func(ctx context.Context, payload any, model *ImagesModel) (replacement any, replace bool, err error)

+ type ImagesProvider interface

+ Auth func() auth.ProviderAuth

+ GenerateImages func(context.Context, ImagesRequest) (*AssistantImages, error)

+ GetModels func() ([]ImagesModel, error)

+ ID func() ImagesProviderID

+ Name func() string

+ func CreateImagesProvider(input CreateImagesProviderOptions) ImagesProvider

+ type ImagesProviderID string

+ type ImagesRequest struct

+ Context ImagesContext

+ Model *ImagesModel

+ Options *ImagesOptions

+ type ImagesResponseHook func(ctx context.Context, response ProviderResponse, model *ImagesModel) error

+ type ImagesStopReason string

+ type InputModalities []InputModality

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

+ type InputModality string

+ const InputImage

+ const InputText

+ type JSONSchema = jsonschema.Schema

+ func JSONSchemaFrom[T any]() (JSONSchema, error)

+ func JSONStringEnumSchema(values ...string) JSONSchema

+ type MaxTokensField string

+ const MaxTokensFieldCompletion

+ const MaxTokensFieldLegacy

+ type Message interface

+ func UnmarshalMessage(data []byte) (Message, error)

+ type MessageList []Message

+ func (messages *MessageList) UnmarshalJSON(data []byte) error

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

+ type Model struct

+ API API

+ BaseURL string

+ Compat json.RawMessage

+ ContextWindow float64

+ Cost ModelCost

+ Headers *map[string]string

+ ID string

+ Input InputModalities

+ MaxTokens float64

+ Name string

+ Provider ProviderID

+ Reasoning bool

+ ThinkingLevelMap *map[ModelThinkingLevel]*string

+ type ModelCost struct

+ Tiers *[]ModelCostTier

+ type ModelCostRates struct

+ CacheRead float64

+ CacheWrite float64

+ Input float64

+ Output float64

+ type ModelCostTier struct

+ InputTokensAbove float64

+ type ModelThinkingLevel string

+ const ModelThinkingHigh

+ const ModelThinkingLow

+ const ModelThinkingMax

+ const ModelThinkingMedium

+ const ModelThinkingMinimal

+ const ModelThinkingOff

+ const ModelThinkingXHigh

+ func ClampThinkingLevel(model *Model, requested ModelThinkingLevel) ModelThinkingLevel

+ func SupportedThinkingLevels(model *Model) []ModelThinkingLevel

+ type ModelsError = auth.Error

+ type MutableImagesModels interface

+ ClearProviders func()

+ DeleteProvider func(ImagesProviderID)

+ SetProvider func(ImagesProvider)

+ func CreateImagesModels(options ...ImagesModelsOptions) MutableImagesModels

+ type OpenAICompletionsCompat struct

+ CacheControlFormat *CacheControlFormat

+ ChatTemplateKwargs *map[string]any

+ DeferredToolsMode *DeferredToolsMode

+ MaxTokensField *MaxTokensField

+ OpenRouterRouting *OpenRouterRouting

+ RequiresAssistantAfterToolResult *bool

+ RequiresReasoningContentOnAssistantMessages *bool

+ RequiresThinkingAsText *bool

+ RequiresToolResultName *bool

+ SendSessionAffinityHeaders *bool

+ SessionAffinityFormat *SessionAffinityFormat

+ SupportsDeveloperRole *bool

+ SupportsLongCacheRetention *bool

+ SupportsOpenAIGrammarTools *bool

+ SupportsReasoningEffort *bool

+ SupportsStore *bool

+ SupportsStrictMode *bool

+ SupportsUsageInStreaming *bool

+ ThinkingFormat *ThinkingFormat

+ VercelGatewayRouting *VercelGatewayRouting

+ ZAIToolStream *bool

+ type OpenAIResponsesCompat struct

+ SessionAffinityFormat *SessionAffinityFormat

+ SupportsDeveloperRole *bool

+ SupportsExplicitPromptCacheMode *bool

+ SupportsLongCacheRetention *bool

+ SupportsOpenAIGrammarTools *bool

+ SupportsStrictMode *bool

+ SupportsToolSearch *bool

+ type OpenRouterRouting struct

+ AllowFallbacks *bool

+ DataCollection *string

+ EnforceDistillableText *bool

+ Ignore *[]string

+ MaxPrice json.RawMessage

+ Only *[]string

+ Order *[]string

+ PreferredMaxLatency json.RawMessage

+ PreferredMinThroughput json.RawMessage

+ Quantizations *[]string

+ RequireParameters *bool

+ Sort json.RawMessage

+ ZDR *bool

+ func (routing *OpenRouterRouting) UnmarshalJSON(data []byte) error

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

+ type PayloadHook func(ctx context.Context, payload any, model *Model) (replacement any, replace bool, err error)

+ type ProviderEnv map[string]string

+ type ProviderHeaders map[string]*string

+ type ProviderID string

+ type ProviderResponse struct

+ Headers map[string]string

+ Status int

+ type RawAssistantMessageEvent struct

+ Partial *AssistantMessage

+ Raw json.RawMessage

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

+ type Request struct

+ Context Context

+ Model *Model

+ Options *StreamOptions

+ type ResponseHook func(ctx context.Context, response ProviderResponse, model *Model) error

+ type RetryCallbacks struct

+ OnRetryAttemptStart func() error

+ OnRetryFinished func(success bool, attempt int, finalError *string) error

+ OnRetryScheduled func(attempt, maxAttempts int, delayMS int64, errorMessage string) error

+ type RetryPolicy struct

+ BaseDelayMS int64

+ Enabled bool

+ MaxRetries int

+ type SessionAffinityFormat string

+ const SessionAffinityOpenAI

+ const SessionAffinityOpenAINoSession

+ const SessionAffinityOpenRouter

+ type SessionResourceCleanup func(sessionID string) error

+ type SimpleStreamOptions struct

+ Reasoning *ThinkingLevel

+ ThinkingBudgets *ThinkingBudgets

+ ToolChoice ToolChoice

+ type StartEvent struct

+ Partial *AssistantMessage

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

+ type StopReason string

+ const StopReasonAborted

+ const StopReasonError

+ const StopReasonLength

+ const StopReasonPending

+ const StopReasonStop

+ const StopReasonToolUse

+ type StreamFn func(ctx context.Context, request Request) (AssistantMessageEventStream, error)

+ type StreamOptions struct

+ APIKey *string

+ CacheRetention *CacheRetention

+ Env ProviderEnv

+ HTTPClient *http.Client

+ Headers ProviderHeaders

+ MaxRetries *int

+ MaxRetryDelayMS *int64

+ MaxTokens *float64

+ Metadata map[string]any

+ OnPayload PayloadHook

+ OnResponse ResponseHook

+ SessionID *string

+ Temperature *float64

+ TimeoutMS *int64

+ TransformHeaders HeadersHook

+ Transport *Transport

+ WebSocketConnectTimeoutMS *int64

+ type TextContent struct

+ Index *int

+ Text string

+ TextSignature *string

+ func (content *TextContent) UnmarshalJSON(data []byte) error

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

+ type TextDeltaEvent struct

+ ContentIndex int

+ Delta string

+ Partial *AssistantMessage

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

+ type TextEndEvent struct

+ Content string

+ ContentIndex int

+ ContentSignature *string

+ Partial *AssistantMessage

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

+ type TextSignatureV1 struct

+ ID string

+ Phase string

+ Version int

+ type TextStartEvent struct

+ ContentIndex int

+ Partial *AssistantMessage

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

+ type ThinkingBudgets struct

+ High *int

+ Low *int

+ Medium *int

+ Minimal *int

+ type ThinkingContent struct

+ Index *int

+ Redacted *bool

+ Thinking string

+ ThinkingSignature *string

+ func (content *ThinkingContent) UnmarshalJSON(data []byte) error

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

+ type ThinkingDeltaEvent struct

+ ContentIndex int

+ Delta string

+ Partial *AssistantMessage

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

+ type ThinkingEndEvent struct

+ Content string

+ ContentIndex int

+ ContentSignature *string

+ Partial *AssistantMessage

+ Redacted *bool

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

+ type ThinkingFormat string

+ const ThinkingFormatAntLing

+ const ThinkingFormatChatTemplate

+ const ThinkingFormatDeepSeek

+ const ThinkingFormatOpenAI

+ const ThinkingFormatOpenRouter

+ const ThinkingFormatQwen

+ const ThinkingFormatQwenChatTemplate

+ const ThinkingFormatString

+ const ThinkingFormatTogether

+ const ThinkingFormatZAI

+ type ThinkingLevel string

+ const ThinkingHigh

+ const ThinkingLow

+ const ThinkingMax

+ const ThinkingMedium

+ const ThinkingMinimal

+ const ThinkingXHigh

+ type ThinkingStartEvent struct

+ ContentIndex int

+ Partial *AssistantMessage

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

+ type Tool struct

+ ConstrainedSampling *ConstrainedSamplingConfig

+ Description string

+ Label string

+ Name string

+ Parameters JSONSchema

+ type ToolCall struct

+ Arguments map[string]any

+ ID string

+ Index *int

+ Name string

+ PartialArgs *string

+ PartialJSON *string

+ StreamIndex *int

+ ThoughtSignature *string

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

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

+ type ToolCallDeltaEvent struct

+ ContentIndex int

+ Delta string

+ Partial *AssistantMessage

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

+ type ToolCallEndEvent struct

+ ContentIndex int

+ Partial *AssistantMessage

+ ToolCall *ToolCall

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

+ type ToolCallStartEvent struct

+ ContentIndex int

+ ID string

+ Partial *AssistantMessage

+ ToolName string

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

+ type ToolChoice string

+ const ToolChoiceAuto

+ const ToolChoiceNone

+ const ToolChoiceRequired

+ type ToolResultContent []ToolResultContentBlock

+ func (blocks *ToolResultContent) UnmarshalJSON(data []byte) error

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

+ type ToolResultContentBlock interface

+ type ToolResultMessage struct

+ AddedToolNames *[]string

+ Content ToolResultContent

+ Details json.RawMessage

+ IsError bool

+ Timestamp int64

+ ToolCallID string

+ ToolName string

+ Usage *Usage

+ func (message *ToolResultMessage) UnmarshalJSON(data []byte) error

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

+ type Transport string

+ const TransportAuto

+ const TransportSSE

+ const TransportWebSocket

+ const TransportWebSocketCached

+ type UnknownContentBlock struct

+ Raw json.RawMessage

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

+ type Usage struct

+ CacheRead int64

+ CacheWrite int64

+ CacheWrite1h *int64

+ Cost Cost

+ Input int64

+ Output int64

+ Reasoning *int64

+ TotalTokens int64

+ func (usage *Usage) UnmarshalJSON(data []byte) error

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

+ type UserContent struct

+ Blocks UserContentBlocks

+ Text *string

+ func NewUserContent(blocks ...UserContentBlock) UserContent

+ func NewUserText(text string) UserContent

+ func (content *UserContent) UnmarshalJSON(data []byte) error

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

+ type UserContentBlock interface

+ type UserContentBlocks []UserContentBlock

+ func (blocks *UserContentBlocks) UnmarshalJSON(data []byte) error

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

+ type UserMessage struct

+ Content UserContent

+ Timestamp int64

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

+ type VercelGatewayRouting struct

+ Only *[]string

+ Order *[]string

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