Documentation
¶
Overview ¶
Package models defines the ModelAdapter interface and shared data types.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AgentEvent ¶
AgentEvent is a single observable event emitted by an agent during its run.
type CapabilitySource ¶
type CapabilitySource int
CapabilitySource indicates where a capability value was determined.
const ( SourceDefault CapabilitySource = iota // hardcoded fallback SourceConfig // user override from recipe ModelProfiles SourceAPI // discovered from provider API )
type ConversationTurn ¶
ConversationTurn is one prior exchange in the conversation history. Role is "user" or "assistant".
type EventType ¶
type EventType string
EventType is the kind of observable event emitted by an agent.
type ModelAdapter ¶
type ModelAdapter interface {
// ID returns the model identifier (e.g. "claude-sonnet-4-6").
ID() string
// Capabilities returns the model's known capabilities.
// Called once at session startup; results are cached and merged with user overrides.
Capabilities(ctx context.Context) ModelCapabilities
// RunAgent runs the multi-turn agentic tool-use loop.
// history contains prior (user, assistant) turns for this model; nil = fresh conversation.
// It calls onEvent for each tool event and text chunk.
// read_file calls execute immediately; write_file calls are intercepted
// and returned in ModelResponse.ProposedWrites.
RunAgent(
ctx context.Context,
history []ConversationTurn,
prompt string,
onEvent func(AgentEvent),
) (ModelResponse, error)
}
ModelAdapter is the interface every provider adapter must implement.
type ModelCapabilities ¶
type ModelCapabilities struct {
ModelID string
Provider string
ContextWindow int
MaxOutputTokens int
ToolFormat ToolFormat
ParallelToolCalls bool
SystemRole bool // model accepts a system role message
MidConvoSystem bool // model accepts system messages mid-conversation
SupportedInputMedia []string // e.g. ["text", "image", "pdf"]
ContextWindowSource CapabilitySource
ToolFormatSource CapabilitySource
}
ModelCapabilities describes a model's known capabilities, used by the prompt assembler to produce model-specific payloads.
type ModelResponse ¶
type ModelResponse struct {
ModelID string
Text string
LatencyMS int64
InputTokens int64 // total input tokens
OutputTokens int64
ReasoningTokens int64 // reasoning/thinking tokens (subset of OutputTokens; 0 when unavailable)
CostUSD float64
ProposedWrites []tools.FileWrite
ToolCalls map[string]int // tool_name → call count across all turns
Steps int // number of agentic loop iterations (API round-trips)
Error string // empty = success
Interrupted bool // true when run was cancelled mid-flight (partial data preserved)
StopReason StopReason `json:"stop_reason,omitempty"`
}
ModelResponse is the final result from one agent run.
func (ModelResponse) OK ¶
func (r ModelResponse) OK() bool
OK returns true when the response carries no error.
type PartialSnapshot ¶
type PartialSnapshot struct {
Text string `json:"text"`
InputTokens int64 `json:"input_tokens"`
OutputTokens int64 `json:"output_tokens"`
ReasoningTokens int64 `json:"reasoning_tokens,omitempty"`
CostUSD float64 `json:"cost_usd"`
LatencyMS int64 `json:"latency_ms"`
Writes []tools.FileWrite `json:"writes,omitempty"`
ToolCalls map[string]int `json:"tool_calls,omitempty"`
}
PartialSnapshot is emitted by adapters at turn boundaries (as JSON in AgentEvent.Data with Type "snapshot") for incremental checkpoint persistence. Placed in models (not adapters) so both adapters and runner can use it without import cycles.
type StopReason ¶
type StopReason string
StopReason indicates why a model's agentic loop terminated.
const ( StopReasonComplete StopReason = "complete" // model finished naturally (no more tool calls) StopReasonTimeout StopReason = "timeout" // context deadline exceeded StopReasonMaxSteps StopReason = "max_steps" // hit max_steps limit StopReasonContextOverflow StopReason = "context_overflow" // context window exceeded StopReasonCancelled StopReason = "cancelled" // user cancelled (ESC/Ctrl-C/SIGINT) StopReasonError StopReason = "error" // API or other error )
type ToolFormat ¶
type ToolFormat int
ToolFormat describes how a model receives tool definitions.
const ( ToolFormatNone ToolFormat = iota // no tool support ToolFormatNative // Anthropic-style (tool blocks in content) ToolFormatFunctionCall // OpenAI-style (function_call / tool_call) ToolFormatTextInPrompt // no API support; described in system prompt )
Source Files