Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrModelProviderMismatch = errors.New("model-provider mismatch")
ErrModelProviderMismatch indicates a model name belongs to a different provider.
Functions ¶
func GetSupportedProviders ¶
func GetSupportedProviders() []string
GetSupportedProviders returns a list of all supported provider IDs.
func ValidateModelProvider ¶ added in v0.6.0
ValidateModelProvider checks whether the given model name is clearly incompatible with the provider type. Returns ErrModelProviderMismatch when the model prefix matches a known exclusion for the provider.
An empty model is always valid (the provider will use its default).
Types ¶
type GenerateParams ¶
type GenerateParams struct {
Model string
Messages []Message
Tools []Tool
Temperature float64
MaxTokens int
}
GenerateParams contains parameters for generation.
type Message ¶
type Message struct {
Role string
Content string
ToolCalls []ToolCall
Metadata map[string]interface{}
}
Message represents a chat message.
type ModelInfo ¶
type ModelInfo struct {
ID string
Name string
ContextWindow int
SupportsVision bool
SupportsTools bool
IsReasoning bool
}
ModelInfo describes an available model.
type Provider ¶
type Provider interface {
// ID returns the unique identifier of the provider (e.g., "openai", "anthropic").
ID() string
// Generate streams responses for the given conversation.
// It returns an iterator that yields StreamEvents.
Generate(ctx context.Context, params GenerateParams) (iter.Seq2[StreamEvent, error], error)
// ListModels returns a list of available models.
ListModels(ctx context.Context) ([]ModelInfo, error)
}
Provider defines the interface for LLM providers.
type Registry ¶
type Registry struct {
// contains filtered or unexported fields
}
Registry manages the registration and lookup of providers.
type StreamEvent ¶
type StreamEvent struct {
Type StreamEventType
Text string
ToolCall *ToolCall
Error error
ThoughtLen int // length of filtered thought text (diagnostics only)
Usage *Usage
}
StreamEvent represents a single event in the generation stream.
type StreamEventType ¶
type StreamEventType string
StreamEventType defines the type of event in a generation stream.
const ( StreamEventPlainText StreamEventType = "text_delta" StreamEventToolCall StreamEventType = "tool_call" StreamEventThought StreamEventType = "thought" StreamEventError StreamEventType = "error" StreamEventDone StreamEventType = "done" )
func (StreamEventType) Valid ¶
func (t StreamEventType) Valid() bool
Valid reports whether t is a known stream event type.
func (StreamEventType) Values ¶
func (t StreamEventType) Values() []StreamEventType
Values returns all known stream event types.
type Tool ¶
type Tool struct {
Name string
Description string
Parameters map[string]interface{} // JSON schema
}
Tool represents a tool definition.
type ToolCall ¶
type ToolCall struct {
Index *int // streaming chunk correlation (OpenAI Index field)
ID string
Name string
Arguments string // JSON string
Thought bool // Gemini: part is a thinking step
ThoughtSignature []byte // Gemini: opaque signature to echo back
}
ToolCall represents a request for tool execution.
Source Files
Directories