api

package

Go to main page

Versions in this module

v0

v0.6.0

Sep 12, 2026

Changes in this version

type AnthropicMessageParam

+ OutputConfig *anthropicOutputConfig

type AnthropicMessagesPayload

+ Betas []string

+ Fallbacks []anthropicFallback

type BedrockReasoningContent

+ RedactedContent []byte

type OpenAICompletionsOptions

+ ThinkingBudgets *ai.ThinkingBudgets

v0.5.2

Sep 4, 2026

v0.5.1

Sep 3, 2026

v0.5.0

Aug 18, 2026

v0.4.16

Aug 13, 2026

v0.4.15

Aug 11, 2026

v0.4.14

Aug 11, 2026

v0.4.13

Aug 10, 2026

v0.4.12

Aug 10, 2026

v0.4.11

Aug 3, 2026

v0.4.10

Jul 30, 2026

Changes in this version

+ func CloseOpenAICodexWebSocketSessions(sessionID ...string)

+ func CompleteSimple(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (*ai.AssistantMessage, error)

+ func GenerateImages(ctx context.Context, model *ai.ImagesModel, imagesContext ai.ImagesContext, ...) (*ai.AssistantImages, error)

+ func GenerateOpenRouterImages(ctx context.Context, model *ai.ImagesModel, imagesContext ai.ImagesContext, ...) (*ai.AssistantImages, error)

+ func ResetOpenAICodexWebSocketDebugStats(sessionID ...string)

+ func StreamAnthropicMessages(ctx context.Context, request ai.Request) (ai.AssistantMessageEventStream, error)

+ func StreamAnthropicMessagesWithOptions(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamAzureOpenAIResponses(ctx context.Context, request ai.Request) (ai.AssistantMessageEventStream, error)

+ func StreamAzureOpenAIResponsesWithOptions(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamBedrockConverse(ctx context.Context, request ai.Request) (ai.AssistantMessageEventStream, error)

+ func StreamBedrockConverseWithOptions(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamGoogleGenerativeAI(ctx context.Context, request ai.Request) (ai.AssistantMessageEventStream, error)

+ func StreamGoogleGenerativeAIWithOptions(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamGoogleVertex(ctx context.Context, request ai.Request) (ai.AssistantMessageEventStream, error)

+ func StreamGoogleVertexWithOptions(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamMistralConversations(ctx context.Context, request ai.Request) (ai.AssistantMessageEventStream, error)

+ func StreamMistralConversationsWithOptions(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamOpenAICodexResponses(ctx context.Context, request ai.Request) (ai.AssistantMessageEventStream, error)

+ func StreamOpenAICodexResponsesWithOptions(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamOpenAICompletions(ctx context.Context, request ai.Request) (ai.AssistantMessageEventStream, error)

+ func StreamOpenAICompletionsWithOptions(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamOpenAIResponses(ctx context.Context, request ai.Request) (ai.AssistantMessageEventStream, error)

+ func StreamOpenAIResponsesWithOptions(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamPiMessages(ctx context.Context, request ai.Request) (ai.AssistantMessageEventStream, error)

+ func StreamPiMessagesWithOptions(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamSimple(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamSimpleAnthropicMessages(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamSimpleAnthropicMessagesWithClient(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamSimpleAzureOpenAIResponses(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamSimpleBedrockConverse(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamSimpleGoogleGenerativeAI(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamSimpleGoogleVertex(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamSimpleMistralConversations(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamSimpleOpenAICodexResponses(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamSimpleOpenAICompletions(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamSimpleOpenAIResponses(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ func StreamSimplePiMessages(ctx context.Context, model *ai.Model, requestContext ai.Context, ...) (ai.AssistantMessageEventStream, error)

+ type AnthropicEffort string

+ const AnthropicEffortHigh

+ const AnthropicEffortLow

+ const AnthropicEffortMax

+ const AnthropicEffortMedium

+ const AnthropicEffortXHigh

+ type AnthropicMessageParam struct

+ Content any

+ Role string

+ type AnthropicMessagesOptions struct

+ Client *anthropic.Client

+ Effort *AnthropicEffort

+ InterleavedThinking *bool

+ ThinkingBudgetTokens *float64

+ ThinkingDisplay *AnthropicThinkingDisplay

+ ThinkingEnabled *bool

+ ToolChoice *AnthropicToolChoice

+ type AnthropicMessagesPayload struct

+ MaxTokens float64

+ Messages []AnthropicMessageParam

+ Metadata *anthropicMetadata

+ Model string

+ OutputConfig *anthropicOutputConfig

+ Stream bool

+ System []anthropicTextBlock

+ Temperature *float64

+ Thinking any

+ ToolChoice *AnthropicToolChoice

+ Tools []anthropicToolParam

+ type AnthropicThinkingDisplay string

+ const AnthropicThinkingOmitted

+ const AnthropicThinkingSummarized

+ type AnthropicToolChoice struct

+ Name *string

+ Type string

+ func (choice *AnthropicToolChoice) UnmarshalJSON(data []byte) error

+ type AzureOpenAIResponsesOptions struct

+ AzureAPIVersion *string

+ AzureBaseURL *string

+ AzureDeploymentName *string

+ AzureResourceName *string

+ ReasoningEffort *string

+ ReasoningSummary *string

+ ToolChoice any

+ type BedrockCachePoint struct

+ TTL *string

+ Type string

+ type BedrockContentBlock struct

+ CachePoint *BedrockCachePoint

+ Image *BedrockImageBlock

+ ReasoningContent *BedrockReasoningContent

+ Text *string

+ ToolResult *BedrockToolResultBlock

+ ToolUse *BedrockToolUseBlock

+ type BedrockConverseStreamOptions struct

+ BearerToken string

+ InterleavedThinking *bool

+ Profile string

+ Reasoning *ai.ThinkingLevel

+ Region string

+ RequestMetadata map[string]string

+ ThinkingBudgets *ai.ThinkingBudgets

+ ThinkingDisplay *BedrockThinkingDisplay

+ ToolChoice *BedrockToolChoice

+ type BedrockConverseStreamPayload struct

+ AdditionalModelRequestFields map[string]any

+ Extra map[string]json.RawMessage

+ InferenceConfig BedrockInferenceConfig

+ Messages []BedrockMessage

+ ModelID string

+ RequestMetadata map[string]string

+ System []BedrockSystemContentBlock

+ ToolConfig *BedrockToolConfiguration

+ type BedrockImageBlock struct

+ Format string

+ Source BedrockImageSource

+ type BedrockImageSource struct

+ Bytes string

+ type BedrockInferenceConfig struct

+ MaxTokens *float64

+ StopSequences []string

+ Temperature *float64

+ TopP *float64

+ type BedrockMessage struct

+ Content []BedrockContentBlock

+ Role string

+ type BedrockReasoningContent struct

+ ReasoningText BedrockReasoningText

+ type BedrockReasoningText struct

+ Signature *string

+ Text string

+ type BedrockSystemContentBlock struct

+ CachePoint *BedrockCachePoint

+ Text *string

+ type BedrockThinkingDisplay string

+ const BedrockThinkingOmitted

+ const BedrockThinkingSummarized

+ type BedrockTool struct

+ ToolSpec BedrockToolSpecification

+ type BedrockToolChoice struct

+ Name string

+ Type string

+ func (choice *BedrockToolChoice) UnmarshalJSON(data []byte) error

+ type BedrockToolConfiguration struct

+ ToolChoice any

+ Tools []BedrockTool

+ type BedrockToolInputSchema struct

+ JSON jsonschema.Schema

+ type BedrockToolResultBlock struct

+ Content []BedrockToolResultContentBlock

+ Status string

+ ToolUseID string

+ type BedrockToolResultContentBlock struct

+ Image *BedrockImageBlock

+ Text *string

+ type BedrockToolSpecification struct

+ Description string

+ InputSchema BedrockToolInputSchema

+ Name string

+ Strict *bool

+ type BedrockToolUseBlock struct

+ Input any

+ Name string

+ ToolUseID string

+ type GoogleContent struct

+ Parts []GooglePart

+ Role string

+ type GoogleFunctionCall struct

+ Args json.RawMessage

+ ID string

+ Name string

+ type GoogleFunctionCallingConfig struct

+ AllowedFunctionNames []string

+ Mode string

+ StreamArguments json.RawMessage

+ type GoogleFunctionDeclaration struct

+ Description string

+ Name string

+ ParametersJSONSchema jsonschema.Schema

+ type GoogleFunctionResponse struct

+ ID string

+ Name string

+ Parts []GoogleFunctionResponsePart

+ Response GoogleFunctionResponseValue

+ type GoogleFunctionResponseInlineData struct

+ Data string

+ MimeType string

+ type GoogleFunctionResponsePart struct

+ InlineData *GoogleFunctionResponseInlineData

+ type GoogleFunctionResponseValue struct

+ Error *string

+ Output *string

+ type GoogleGenerateContentConfig struct

+ CachedContent *string

+ CandidateCount *int64

+ EnableEnhancedCivicAnswers *bool

+ FrequencyPenalty *float64

+ ImageConfig json.RawMessage

+ Logprobs *int64

+ MaxOutputTokens *float64

+ MediaResolution *string

+ PresencePenalty *float64

+ ResponseJSONSchema json.RawMessage

+ ResponseLogprobs *bool

+ ResponseMimeType *string

+ ResponseModalities []string

+ ResponseSchema json.RawMessage

+ SafetySettings []GoogleSafetySetting

+ Seed *int64

+ ServiceTier *string

+ SpeechConfig json.RawMessage

+ StopSequences []string

+ SystemInstruction json.RawMessage

+ Temperature *float64

+ ThinkingConfig *GoogleThinkingConfig

+ ToolConfig *GoogleToolConfig

+ Tools []GoogleTool

+ TopK *float64

+ TopP *float64

+ type GoogleGenerateContentParameters struct

+ Config GoogleGenerateContentConfig

+ Contents []GoogleContent

+ Model string

+ type GoogleInlineData struct

+ Data string

+ MimeType string

+ type GoogleOptions struct

+ Thinking *GoogleThinkingOptions

+ ToolChoice GoogleToolChoice

+ type GooglePart struct

+ FunctionCall *GoogleFunctionCall

+ FunctionResponse *GoogleFunctionResponse

+ InlineData *GoogleInlineData

+ Text *string

+ Thought bool

+ ThoughtSignature *string

+ type GoogleSafetySetting struct

+ Category string

+ Threshold string

+ type GoogleThinkingConfig struct

+ IncludeThoughts *bool

+ ThinkingBudget *int64

+ ThinkingLevel *GoogleThinkingLevel

+ type GoogleThinkingLevel string

+ const GoogleThinkingHigh

+ const GoogleThinkingLow

+ const GoogleThinkingMedium

+ const GoogleThinkingMinimal

+ const GoogleThinkingUnspecified

+ type GoogleThinkingOptions struct

+ BudgetTokens *int64

+ Enabled bool

+ Level *GoogleThinkingLevel

+ type GoogleTool struct

+ CodeExecution json.RawMessage

+ ComputerUse json.RawMessage

+ FileSearch json.RawMessage

+ FunctionDeclarations []GoogleFunctionDeclaration

+ GoogleMaps json.RawMessage

+ GoogleSearch json.RawMessage

+ GoogleSearchRetrieval json.RawMessage

+ MCPServers json.RawMessage

+ URLContext json.RawMessage

+ type GoogleToolChoice string

+ const GoogleToolChoiceAny

+ const GoogleToolChoiceAuto

+ const GoogleToolChoiceNone

+ type GoogleToolConfig struct

+ FunctionCallingConfig *GoogleFunctionCallingConfig

+ IncludeServerSideToolInvocations *bool

+ RetrievalConfig json.RawMessage

+ type GoogleVertexOptions struct

+ Location string

+ Project string

+ Thinking *GoogleThinkingOptions

+ ToolChoice GoogleToolChoice

+ type MistralChatPayload = MistralConversationsPayload

+ type MistralConversationFunction struct

+ Description string

+ Name string

+ Parameters jsonschema.Schema

+ Strict bool

+ type MistralConversationTool struct

+ Function MistralConversationFunction

+ Type string

+ type MistralConversationsOptions struct

+ PromptMode *string

+ ReasoningEffort *string

+ ToolChoice any

+ type MistralConversationsPayload struct

+ MaxTokens *float64

+ Messages []any

+ Model string

+ PromptCacheKey *string

+ PromptMode *string

+ ReasoningEffort *string

+ Stream bool

+ Temperature *float64

+ ToolChoice any

+ Tools []MistralConversationTool

+ type OpenAICodexResponsesOptions struct

+ ReasoningEffort *string

+ ReasoningSummary *string

+ ServiceTier *string

+ TextVerbosity *string

+ ToolChoice *string

+ type OpenAICodexResponsesPayload struct

+ Include []string

+ Input []any

+ Instructions string

+ Model string

+ ParallelToolCalls bool

+ PromptCacheKey *string

+ Reasoning *OpenAIReasoningParams

+ ServiceTier *string

+ Store bool

+ Stream bool

+ Temperature *float64

+ Text openAICodexText

+ ToolChoice string

+ Tools []openAICodexResponsesTool

+ type OpenAICodexWebSocketDebugStats struct

+ CachedContextRequests int

+ ConnectionsCreated int

+ ConnectionsReused int

+ DeltaRequests int

+ FullContextRequests int

+ LastDeltaInputItems *int

+ LastInputItems int

+ LastPreviousResponseID *string

+ LastWebSocketError *string

+ Requests int

+ SSEFallbacks int

+ StoreTrueRequests int

+ WebSocketFailures int

+ WebSocketFallbackActive bool

+ func GetOpenAICodexWebSocketDebugStats(sessionID string) *OpenAICodexWebSocketDebugStats

+ type OpenAICompletionsOptions struct

+ ReasoningEffort *ai.ThinkingLevel

+ ToolChoice any

+ type OpenAIPromptCacheOptions struct

+ Mode string

+ type OpenAIReasoningParams struct

+ Effort string

+ Summary *string

+ type OpenAIResponsesGrammarFormat struct

+ Definition string

+ Syntax string

+ Type string

+ type OpenAIResponsesOptions struct

+ ReasoningEffort *string

+ ReasoningSummary *string

+ ServiceTier *string

+ ToolChoice any

+ type OpenAIResponsesPayload struct

+ Include []string

+ Input []any

+ MaxOutputTokens *float64

+ Model string

+ PromptCacheKey *string

+ PromptCacheOptions *OpenAIPromptCacheOptions

+ PromptCacheRetention *string

+ Reasoning *OpenAIReasoningParams

+ ServiceTier *string

+ Store bool

+ Stream bool

+ Temperature *float64

+ ToolChoice any

+ Tools []OpenAIResponsesTool

+ type OpenAIResponsesTool struct

+ DeferLoading *bool

+ Description string

+ Format *OpenAIResponsesGrammarFormat

+ Name string

+ Parameters jsonschema.Schema

+ Strict *bool

+ StrictNull bool

+ Type string

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

+ type PiMessagesOptions struct

+ Debug bool

+ Reasoning *ai.ThinkingLevel

+ ToolChoice PiMessagesToolChoice

+ func (options *PiMessagesOptions) UnmarshalJSON(data []byte) error

+ type PiMessagesPayload struct

+ Context ai.Context

+ Model string

+ Options PiMessagesPayloadOptions

+ type PiMessagesPayloadOptions struct

+ CacheRetention *ai.CacheRetention

+ MaxTokens *float64

+ Reasoning *ai.ThinkingLevel

+ SessionID *string

+ Temperature *float64

+ ToolChoice PiMessagesToolChoice

+ type PiMessagesResponseError struct

+ Code *string

+ DiagnosticDetails json.RawMessage

+ Message string

+ func (err *PiMessagesResponseError) Error() string

+ type PiMessagesRewriteImpact struct

+ Changed bool

+ MessageCountChange int64

+ PolicyID string

+ PolicyVersion int64

+ SystemPromptChanged bool

+ TokenCountChange int64

+ type PiMessagesToolChoice any

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