api

package

Go to main page

Versions in this module

v0

v0.46.0

Feb 1, 2026

Changes in this version

type ChatRequest

+ StreamOptions *StreamOptions

type Provider

+ IsFunctionCallingEnabled func() bool

+ type StreamOptions struct

+ IncludeUsage bool

type StreamResponse

+ Usage *StreamUsageInfo

+ type StreamUsageInfo struct

+ CompletionTokens int

+ PromptTokens int

+ type Usage struct

+ CacheCreationTokens int

+ CachedInputTokens int

+ InputTokens int

+ OutputTokens int

+ type UsageCallback func(usage Usage)

+ type UsageReporter interface

+ SetUsageCallback func(callback UsageCallback)

v0.45.0

Jan 30, 2026

v0.44.0

Jan 26, 2026

Changes in this version

type ChatRequest

+ ToolChoice string

+ Tools []OpenAITool

type Delta

+ ToolCalls []OpenAIToolCall

type InputItem

+ Arguments string

+ CallID string

+ Name string

+ Output string

type Message

+ ToolCallID string

+ ToolCalls []OpenAIToolCall

+ type OpenAIMCPToolProvider interface

+ SetMCPTools func(tools []OpenAIToolFunction)

+ type OpenAITool struct

+ Function *OpenAIToolFunction

+ Type string

+ type OpenAIToolCall struct

+ Function OpenAIToolCallFunction

+ ID string

+ Index int

+ Type string

+ type OpenAIToolCallFunction struct

+ Arguments string

+ Name string

+ type OpenAIToolFunction struct

+ Description string

+ Name string

+ Parameters map[string]interface{}

+ Strict bool

+ func ConvertMCPToolToOpenAIFunction(name, description string, inputSchema []byte) OpenAIToolFunction

type StreamChoice

+ FinishReason string

v0.43.0

Jan 25, 2026

v0.42.1

Jan 24, 2026

v0.42.0

Jan 24, 2026

Changes in this version

+ func GetDefaultModel(model, providerName, fallback string) string

+ func HandleRateLimit(resp *http.Response) error

+ func LevelToBudgetTokens(level string) int

+ func RegisterProvider(name string, factory ProviderFactory)

+ func SanitizeErrorMessage(body []byte, statusCode int) error

+ func StartThinkingSpinner(isImage bool, customSuffix string) *ui.Spinner

+ type MCPToolProvider interface

+ SetMCPEnabled func(enabled bool)

+ SetMCPTools func(tools []GeminiFunctionDeclaration)

+ type ModelLister interface

+ ListModels func() ([]string, error)

+ type ProviderFactory func(apiKey string) (Provider, error)

v0.41.0

Jan 21, 2026

v0.40.0

Jan 20, 2026

v0.39.0

Jan 18, 2026

v0.38.0

Jan 18, 2026

v0.37.0

Jan 18, 2026

v0.36.0

Jan 18, 2026

v0.35.0

Jan 17, 2026

v0.31.0

Jan 21, 2026

Changes in this version

+ func GetToolDefinitionNames() []string

+ func HandleHTTPError(resp *http.Response, spinner *ui.Spinner, providerName string) error

+ func HandleNonStreamingResponse(resp *http.Response, spinner *ui.Spinner) (string, error)

+ func StartSpinner(message string) *ui.Spinner

+ func StopSpinner(spinner *ui.Spinner)

+ type BaseProvider struct

+ APIKey string

+ APIURL string

+ HTTPClient *http.Client

+ ProviderName string

+ func NewBaseProvider(name, apiKey, defaultURL, envURLKey string) BaseProvider

+ func (b *BaseProvider) CreateAPIRequest(ctx context.Context, body interface{}) (*http.Request, error)

+ func (b *BaseProvider) ExecuteRequest(req *http.Request) (*http.Response, error)

+ func (b *BaseProvider) SetAPIKeyAuth(req *http.Request, headerName string)

+ func (b *BaseProvider) SetBearerAuth(req *http.Request)

type ChatRequest

+ ReasoningEffort string

+ type ClaudeCacheControl struct

+ Type string

type ClaudeMultimodalRequest

+ Thinking *ClaudeThinkingConfig

type ClaudeRequest

+ Thinking *ClaudeThinkingConfig

+ type ClaudeSystemBlock struct

+ CacheControl *ClaudeCacheControl

+ Text string

+ Type string

+ type ClaudeThinkingConfig struct

+ BudgetTokens int

+ Type string

+ type CompactCapable interface

+ CompactHistory func(ctx context.Context, input []InputItem, model, instructions string) (*CompactResponse, error)

+ SupportsCompact func() bool

+ type CompactRequest struct

+ Input []InputItem

+ Instructions string

+ Model string

+ type CompactResponse struct

+ Model string

+ Output []InputItem

+ Usage *CompactUsage

+ type CompactUsage struct

+ InputTokens int

+ OutputTokens int

+ TotalTokens int

+ type GeminiFunctionCall struct

+ Args map[string]any

+ Name string

+ type GeminiFunctionCandidate struct

+ Content GeminiFunctionContent

+ type GeminiFunctionContent struct

+ Parts []GeminiFunctionPart

+ Role string

+ type GeminiFunctionDeclaration struct

+ Description string

+ Name string

+ Parameters *GeminiParameterSchema

+ func ConvertMCPToolToGeminiDeclaration(name, description string, inputSchema json.RawMessage) GeminiFunctionDeclaration

+ type GeminiFunctionPart struct

+ FunctionCall *GeminiFunctionCall

+ Text string

+ type GeminiFunctionResponse struct

+ Candidates []GeminiFunctionCandidate

+ type GeminiGenerationConfig struct

+ ThinkingConfig *GeminiThinkingConfig

+ type GeminiParameterSchema struct

+ Properties map[string]GeminiPropertyDef

+ Required []string

+ Type string

+ type GeminiPropertyDef struct

+ Description string

+ Enum []string

+ Items *GeminiPropertyDef

+ Type string

type GeminiProvider

+ func (p *GeminiProvider) SetMCPEnabled(enabled bool)

+ func (p *GeminiProvider) SetMCPTools(tools []GeminiFunctionDeclaration)

+ type GeminiRequestWithTools struct

+ Contents []interface{}

+ GenerationConfig *GeminiGenerationConfig

+ Tools []GeminiToolConfig

+ type GeminiThinkingConfig struct

+ ThinkingBudget int

+ type GeminiToolConfig struct

+ FunctionDeclarations []GeminiFunctionDeclaration

+ func GetCombinedToolDefinitions(mcpTools []GeminiFunctionDeclaration) []GeminiToolConfig

+ func GetGeminiToolDefinitions() []GeminiToolConfig

+ type InputContentPart struct

+ ImageURL string

+ Text string

+ Type string

+ type InputItem struct

+ Content interface{}

+ Data string

+ ID string

+ Role string

+ Status string

+ Type string

+ func ConvertHistoryToInputItems(history []Message) []InputItem

type OpenAIMultimodalRequest

+ ReasoningEffort string

type OpenAIProvider

+ func (p *OpenAIProvider) CompactHistory(ctx context.Context, input []InputItem, model, instructions string) (*CompactResponse, error)

+ func (p *OpenAIProvider) SupportsCompact() bool

+ type ReasoningConfig struct

+ Effort string

+ type ResponseMetadata struct

+ ID string

+ Model string

+ Status string

+ type ResponsesRequest struct

+ Input interface{}

+ Instructions string

+ Model string

+ Reasoning *ReasoningConfig

+ Stream bool

+ type ResponsesResult struct

+ Content string

+ ResponseID string

+ type ResponsesStreamChunk struct

+ Delta string

+ Response *ResponseMetadata

+ Type string

v0.29.0

Jan 11, 2026

Changes in this version

+ const MaxImageSize

+ func FormatImageSize(bytes int64) string

+ func SupportsImages(providerName string) bool

+ type ClaudeContentPart struct

+ Source *ClaudeImageSource

+ Text string

+ Type string

+ type ClaudeImageSource struct

+ Data string

+ MediaType string

+ Type string

+ type ClaudeMultimodalMessage struct

+ Content []ClaudeContentPart

+ Role string

+ type ClaudeMultimodalRequest struct

+ MaxTokens int

+ Messages []interface{}

+ Model string

+ Stream bool

+ System string

type ClaudeProvider

+ func (p *ClaudeProvider) ChatWithImage(ctx context.Context, systemPrompt string, history []Message, ...) (string, error)

+ func (p *ClaudeProvider) SupportsImages() bool

type DeepSeekProvider

+ func (p *DeepSeekProvider) ChatWithImage(ctx context.Context, systemPrompt string, history []Message, ...) (string, error)

+ func (p *DeepSeekProvider) SupportsImages() bool

+ type GeminiInlineData struct

+ Data string

+ MimeType string

+ type GeminiMultimodalContent struct

+ Parts []GeminiMultimodalPart

+ Role string

+ type GeminiMultimodalPart struct

+ InlineData *GeminiInlineData

+ Text string

+ type GeminiMultimodalRequest struct

+ Contents []interface{}

type GeminiProvider

+ func (p *GeminiProvider) ChatWithImage(ctx context.Context, systemPrompt string, history []Message, ...) (string, error)

+ func (p *GeminiProvider) SupportsImages() bool

type GroqProvider

+ func (p *GroqProvider) ChatWithImage(ctx context.Context, systemPrompt string, history []Message, ...) (string, error)

+ func (p *GroqProvider) SupportsImages() bool

+ type ImageData struct

+ Base64 string

+ MediaType string

+ Path string

+ Size int64

+ func LoadImage(path string) (*ImageData, error)

+ type MultimodalMessage struct

+ Content string

+ Image *ImageData

+ Role string

+ func (m MultimodalMessage) HasImage() bool

+ func (m MultimodalMessage) ToMessage() Message

type OllamaProvider

+ func (p *OllamaProvider) ChatWithImage(ctx context.Context, systemPrompt string, history []Message, ...) (string, error)

+ func (p *OllamaProvider) SupportsImages() bool

+ type OpenAIContentPart struct

+ ImageURL *OpenAIImageURL

+ Text string

+ Type string

+ type OpenAIImageURL struct

+ URL string

+ type OpenAIMultimodalMessage struct

+ Content []OpenAIContentPart

+ Role string

+ type OpenAIMultimodalRequest struct

+ Messages []interface{}

+ Model string

+ Stream bool

type OpenAIProvider

+ func (p *OpenAIProvider) ChatWithImage(ctx context.Context, systemPrompt string, history []Message, ...) (string, error)

+ func (p *OpenAIProvider) SupportsImages() bool

type Provider

+ func NewProvider(providerName string) (Provider, error)

+ ChatWithImage func(ctx context.Context, systemPrompt string, history []Message, ...) (string, error)

+ SupportsImages func() bool

v0.28.4

Jan 10, 2026

v0.28.3

Jan 10, 2026

v0.28.2

Jan 10, 2026

v0.28.1

Jan 10, 2026

v0.28.0

Jan 10, 2026

Changes in this version

+ func AskDeepSeekStream(query string, context string, model string) (string, error)

+ func ChatWithTools(systemPrompt string, history []Message, model string) (string, error)

+ func ParseStreamingResponse(ctx context.Context, resp *http.Response, spinner *ui.Spinner, ...) (string, error)

+ func ValidateChatResponse(data []byte) error

+ func ValidateErrorResponse(data []byte) (string, error)

+ func ValidateStreamResponse(data []byte) error

+ func ValidateToolCall(toolCall interface{}) error

+ func WebSearch(query string) (string, error)

+ type ChatRequest struct

+ Messages []Message

+ Model string

+ Stream bool

+ type ChatResponse struct

+ Choices []Choice

+ type Choice struct

+ Message Message

+ type ClaudeContent struct

+ Text string

+ Type string

+ type ClaudeDelta struct

+ Text string

+ Type string

+ type ClaudeMessage struct

+ Content string

+ Role string

+ type ClaudeProvider struct

+ func NewClaudeProvider(apiKey string) *ClaudeProvider

+ func (p *ClaudeProvider) ChatWithTools(ctx context.Context, systemPrompt string, history []Message, model string) (string, error)

+ func (p *ClaudeProvider) Name() string

+ type ClaudeRequest struct

+ MaxTokens int

+ Messages []ClaudeMessage

+ Model string

+ Stream bool

+ System string

+ type ClaudeResponse struct

+ Content []ClaudeContent

+ type ClaudeStreamEvent struct

+ Delta ClaudeDelta

+ Type string

+ type Client struct

+ Provider Provider

+ Timeout time.Duration

+ func NewClient(provider Provider) *Client

+ func (c *Client) ChatWithTools(systemPrompt string, history []Message, model string) (string, error)

+ type DeepSeekProvider struct

+ func NewDeepSeekProvider(apiKey string) *DeepSeekProvider

+ func (p *DeepSeekProvider) ChatWithTools(ctx context.Context, systemPrompt string, history []Message, model string) (string, error)

+ func (p *DeepSeekProvider) Name() string

+ type Delta struct

+ Content string

+ type GeminiCandidate struct

+ Content GeminiContent

+ type GeminiContent struct

+ Parts []GeminiPart

+ Role string

+ type GeminiPart struct

+ Text string

+ type GeminiProvider struct

+ func NewGeminiProvider(apiKey string) *GeminiProvider

+ func (p *GeminiProvider) ChatWithTools(ctx context.Context, systemPrompt string, history []Message, model string) (string, error)

+ func (p *GeminiProvider) Name() string

+ type GeminiRequest struct

+ Contents []GeminiContent

+ type GeminiResponse struct

+ Candidates []GeminiCandidate

+ type GroqProvider struct

+ func NewGroqProvider(apiKey string) *GroqProvider

+ func (p *GroqProvider) ChatWithTools(ctx context.Context, systemPrompt string, history []Message, model string) (string, error)

+ func (p *GroqProvider) Name() string

+ type Message struct

+ Content string

+ Role string

+ type OllamaMessageContent struct

+ Content string

+ type OllamaModel struct

+ Name string

+ type OllamaProvider struct

+ func NewOllamaProvider(baseURL string) *OllamaProvider

+ func (p *OllamaProvider) ChatWithTools(ctx context.Context, systemPrompt string, history []Message, model string) (string, error)

+ func (p *OllamaProvider) ListModels() ([]string, error)

+ func (p *OllamaProvider) Name() string

+ type OllamaRequest struct

+ Messages []Message

+ Model string

+ Stream bool

+ type OllamaStreamResponse struct

+ Done bool

+ Message OllamaMessageContent

+ type OllamaTagsResponse struct

+ Models []OllamaModel

+ type OpenAIProvider struct

+ func NewOpenAIProvider(apiKey string) *OpenAIProvider

+ func (p *OpenAIProvider) ChatWithTools(ctx context.Context, systemPrompt string, history []Message, model string) (string, error)

+ func (p *OpenAIProvider) Name() string

+ type Provider interface

+ ChatWithTools func(ctx context.Context, systemPrompt string, history []Message, model string) (string, error)

+ Name func() string

+ type RAGRequest struct

+ Model string

+ Query string

+ TopK int

+ UserID string

+ type RAGResponse struct

+ Count int

+ Query string

+ Results []RAGResult

+ func SearchRAG(query string, userID string, topK int) (*RAGResponse, error)

+ type RAGResult struct

+ Content string

+ DocumentID string

+ DocumentTitle string

+ DocumentType string

+ ID string

+ Similarity float64

+ type SerperResponse struct

+ Organic []SerperSearchResult

+ type SerperSearchRequest struct

+ Gl string

+ Hl string

+ Q string

+ type SerperSearchResult struct

+ Link string

+ Snippet string

+ Title string

+ type StreamChoice struct

+ Delta Delta

+ type StreamParser func(line string) (content string, done bool, err error)

+ type StreamResponse struct

+ Choices []StreamChoice

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