Documentation
¶
Index ¶
- Constants
- Variables
- func BuildGoalFromContextPrompt(tail []ai.Message) string
- func EstimateTokens(msgs []ai.Message) int
- func GoalFromContextMessages(msgs []ai.Message, n int) ([]ai.Message, error)
- func MemoryOffSnapshot() ai.PromptSnapshot
- func WithLifecycleStart(ctx context.Context, callback func()) context.Context
- func WithMemoryOffAuthored(ctx context.Context) context.Context
- func WithRequestObserver(ctx context.Context, observer RequestObserver) context.Context
- func WithTurnSnapshot(ctx context.Context, snapshot ai.PromptSnapshot) context.Context
- func WithUserMessageID(ctx context.Context, id string) context.Context
- func WithUserMessageObserver(ctx context.Context, observe func(ai.Message) error) context.Context
- type Agent
- func (a *Agent) AddSubUsage(model string, u ai.Usage)
- func (a *Agent) AddUsage(u ai.Usage)
- func (a *Agent) AllTools() []tools.Tool
- func (a *Agent) AppendUser(content string)
- func (a *Agent) AvailableTools() []tools.Tool
- func (a *Agent) ContextTokens() int
- func (a *Agent) ContinueUser(ctx context.Context, messageID string, ev Events) (string, error)
- func (a *Agent) Experimental() []string
- func (a *Agent) FollowupTask(ctx context.Context, id, text string, ev Events) (string, error)
- func (a *Agent) KnownTools() []tools.Tool
- func (a *Agent) LastStopReason() ai.StopReason
- func (a *Agent) LaunchBackground(t *BackgroundTask, worktreePath string)
- func (a *Agent) LoadTodosJSON(s string)
- func (a *Agent) ManualCompact(ctx context.Context, ev Events) error
- func (a *Agent) ManualCompactCommit(ctx context.Context, ev Events, commit func() error) (err error)
- func (a *Agent) ManualNewContext(ctx context.Context, ev Events) error
- func (a *Agent) MemoryEnabled() bool
- func (a *Agent) MessagesSnapshot() []ai.Message
- func (a *Agent) ModelUsage() map[string]ai.Usage
- func (a *Agent) PlanMode() bool
- func (a *Agent) RefreshMemory()
- func (a *Agent) RegisterBackground(description, prompt string, o SubModel) *BackgroundTask
- func (a *Agent) RegisterBackgroundContext(parent context.Context, description, prompt string, o SubModel) *BackgroundTask
- func (a *Agent) ResetUsage()
- func (a *Agent) RestoreMessages(messages []ai.Message)
- func (a *Agent) RestoreTask(t BackgroundTask)
- func (a *Agent) RestoreUsage(usage ai.UsageSummary)
- func (a *Agent) SessionIDValue() string
- func (a *Agent) SetCacheKey(key string)
- func (a *Agent) SetMCPTools(ts []tools.Tool)
- func (a *Agent) SetMemoryEnabled(enabled bool)
- func (a *Agent) SetMemoryRuntime(runtime MemoryRuntime)
- func (a *Agent) SetMessageRewoundFrom(index int, value string)
- func (a *Agent) SetModel(model ModelConfig) error
- func (a *Agent) SetModelUsage(usage map[string]ai.Usage)
- func (a *Agent) SetOnTodos(fn func(items []Todo))
- func (a *Agent) SetPlanMode(enabled bool)
- func (a *Agent) SetPluginTools(ts []tools.Tool)
- func (a *Agent) SetSessionID(id string)
- func (a *Agent) SetSubUsage(m map[string]ai.Usage)
- func (a *Agent) SetUsage(u ai.Usage)
- func (a *Agent) StartBackground(description, prompt string, o SubModel) *BackgroundTask
- func (a *Agent) StartSession(ctx context.Context) error
- func (a *Agent) StartWait(spec WaitTaskSpec) (*waitTask, error)
- func (a *Agent) StartWaitContext(ctx context.Context, spec WaitTaskSpec) (*waitTask, error)
- func (a *Agent) Steer(text string)
- func (a *Agent) SteerImages(text string, parts []ai.ContentPart)
- func (a *Agent) SteerTask(id, text string) error
- func (a *Agent) SubUsage() map[string]ai.Usage
- func (a *Agent) Tasks() *taskRegistry
- func (a *Agent) TodosJSON() string
- func (a *Agent) TotalUsage() ai.Usage
- func (a *Agent) Turn(ctx context.Context, input string, ev Events) (string, error)
- func (a *Agent) TurnAuthored(ctx context.Context, input string, ev Events) (string, error)
- func (a *Agent) TurnParts(ctx context.Context, input string, parts []ai.ContentPart, ev Events) (string, error)
- func (a *Agent) TurnRunning() bool
- func (a *Agent) TurnWithImages(ctx context.Context, input string, parts []ai.ContentPart, ev Events) (string, error)
- func (a *Agent) Usage() ai.Usage
- func (a *Agent) UsageSummary() ai.UsageSummary
- func (a *Agent) WaitingOnSubagents() bool
- func (a *Agent) Waits() *waitRegistry
- func (a *Agent) Workflows() *workflow.Manager
- type BackgroundTask
- type CompactInfo
- type Events
- type JournaledEvent
- type MemoryRuntime
- type MemoryTurn
- type ModelConfig
- type Option
- type RequestObservation
- type RequestObserver
- type SubModel
- type TaskStatus
- type Todo
- type WaitStatus
- type WaitTaskSpec
Constants ¶
const (
FeatureWorkflows = "workflows"
)
const GoalFromContextDefaultWindow = 8
Variables ¶
var ErrBusy = errors.New("agent is busy; wait for the current turn to finish")
Functions ¶
func EstimateTokens ¶
func GoalFromContextMessages ¶
func MemoryOffSnapshot ¶ added in v0.107.6
func MemoryOffSnapshot() ai.PromptSnapshot
MemoryOffSnapshot marks a user message created while memory is off. Every path that adds a user message to History while off must attach it.
func WithLifecycleStart ¶ added in v0.107.0
func WithMemoryOffAuthored ¶ added in v0.107.6
WithMemoryOffAuthored marks the turn's user message as written while memory was off, for input that waited (a queued message) until after memory was turned back on.
func WithRequestObserver ¶ added in v0.107.0
func WithRequestObserver(ctx context.Context, observer RequestObserver) context.Context
func WithTurnSnapshot ¶ added in v0.107.6
WithTurnSnapshot attaches request-only text to the user message of the next turn. The model sees it after the user's words; history and transcripts keep only what the user typed. Desktop slash commands use it to send an expanded prompt template while the conversation still shows "/name args".
func WithUserMessageID ¶ added in v0.107.0
Types ¶
type Agent ¶
type Agent struct {
Client ai.Client
Model string
ModelName string
Provider string
MaxTokens int
Effort string
Vision bool
NativeWebSearch bool
Temperature *float64
TopP *float64
Tools []tools.Tool
// RequestToolFilter narrows schemas sent to the model; execution still uses AllTools.
RequestToolFilter func([]tools.Tool) []tools.Tool
RunTools []tools.Tool
RunToolsSet bool
Messages []ai.Message
ContextLimit int
CompactClient ai.Client
CompactModel string
CompactProvider string
CompactThreshold float64
TaskDefault SubModel
ResolveModel func(model, provider string) (SubModel, error)
MaxTurns int
WorkingDir string
WorktreeSubagents bool
Todos []Todo
BrowserDisabled bool
ComputerDisabled bool
ComputerConfig config.ComputerConfig
SandboxPolicy *sandbox.Policy
OnOrphanedSteer func(text string)
Hooks *hooks.Runner
PluginHook func(context.Context, hooks.Event) error
// contains filtered or unexported fields
}
func (*Agent) AppendUser ¶
func (*Agent) AvailableTools ¶ added in v0.107.0
func (*Agent) ContextTokens ¶ added in v0.107.0
func (*Agent) ContinueUser ¶ added in v0.107.0
ContinueUser runs the persisted tail user message without appending another user turn.
func (*Agent) Experimental ¶
func (*Agent) FollowupTask ¶
func (*Agent) KnownTools ¶ added in v0.107.6
KnownTools are the tools a run may name in its options, including memory tools the switch currently hides, so a run's validation does not depend on the switch.
func (*Agent) LastStopReason ¶ added in v0.103.0
func (a *Agent) LastStopReason() ai.StopReason
func (*Agent) LaunchBackground ¶
func (a *Agent) LaunchBackground(t *BackgroundTask, worktreePath string)
func (*Agent) LoadTodosJSON ¶
func (*Agent) ManualCompactCommit ¶ added in v0.107.0
func (a *Agent) ManualCompactCommit(ctx context.Context, ev Events, commit func() error) (err error)
ManualCompactCommit keeps the turn lock until the caller commits the new context. A cancelled or failed commit restores the previous context and usage ledger.
func (*Agent) ManualNewContext ¶ added in v0.104.0
func (*Agent) MemoryEnabled ¶ added in v0.107.6
func (*Agent) MessagesSnapshot ¶
func (*Agent) RefreshMemory ¶ added in v0.103.0
func (a *Agent) RefreshMemory()
func (*Agent) RegisterBackground ¶
func (a *Agent) RegisterBackground(description, prompt string, o SubModel) *BackgroundTask
func (*Agent) RegisterBackgroundContext ¶ added in v0.103.0
func (*Agent) ResetUsage ¶
func (a *Agent) ResetUsage()
func (*Agent) RestoreMessages ¶ added in v0.107.0
func (*Agent) RestoreTask ¶
func (a *Agent) RestoreTask(t BackgroundTask)
func (*Agent) RestoreUsage ¶ added in v0.103.0
func (a *Agent) RestoreUsage(usage ai.UsageSummary)
func (*Agent) SessionIDValue ¶
func (*Agent) SetCacheKey ¶
func (*Agent) SetMCPTools ¶
func (*Agent) SetMemoryEnabled ¶ added in v0.107.6
SetMemoryEnabled toggles memory injection, hidden extraction and memory tools from the next turn on. Stored memories are untouched.
func (*Agent) SetMemoryRuntime ¶ added in v0.107.0
func (a *Agent) SetMemoryRuntime(runtime MemoryRuntime)
func (*Agent) SetMessageRewoundFrom ¶ added in v0.107.0
func (*Agent) SetModel ¶ added in v0.103.0
func (a *Agent) SetModel(model ModelConfig) error
func (*Agent) SetModelUsage ¶ added in v0.103.0
func (*Agent) SetOnTodos ¶
func (*Agent) SetPlanMode ¶ added in v0.103.0
func (*Agent) SetPluginTools ¶ added in v0.103.0
func (*Agent) SetSessionID ¶
func (*Agent) StartBackground ¶
func (a *Agent) StartBackground(description, prompt string, o SubModel) *BackgroundTask
func (*Agent) StartSession ¶ added in v0.103.0
func (*Agent) StartWait ¶
func (a *Agent) StartWait(spec WaitTaskSpec) (*waitTask, error)
func (*Agent) StartWaitContext ¶ added in v0.103.0
func (a *Agent) StartWaitContext(ctx context.Context, spec WaitTaskSpec) (*waitTask, error)
func (*Agent) SteerImages ¶
func (a *Agent) SteerImages(text string, parts []ai.ContentPart)
func (*Agent) TotalUsage ¶
func (*Agent) TurnAuthored ¶
func (*Agent) TurnRunning ¶
func (*Agent) TurnWithImages ¶
func (*Agent) UsageSummary ¶ added in v0.103.0
func (a *Agent) UsageSummary() ai.UsageSummary
func (*Agent) WaitingOnSubagents ¶
type BackgroundTask ¶
type BackgroundTask struct {
ID string
Description string
Prompt string
Status TaskStatus
Report string
StartedAt time.Time
EndedAt time.Time
Restored bool
FollowingUp bool
Done chan struct{}
SubMessages []ai.Message
SubUsage ai.Usage
SubModelUsage map[string]ai.Usage
SubSubUsage map[string]ai.Usage
SubModel string
// contains filtered or unexported fields
}
type CompactInfo ¶
type Events ¶
type Events struct {
OnPhase func(stage string)
OnLifecycle func(event string)
OnText func(delta string)
OnThink func(delta string)
OnHostedSearch func(ai.HostedSearch)
OnToolStart func(id, name, args string)
OnToolEnd func(id, name, result string)
OnToolResult func(id, name string, result tools.Result)
OnToolCall func(id, name, args string)
OnToolOutput func(id, outputSoFar string)
OnSteer func(text string)
OnCompact func(took, kept int)
OnCompacted func(summary string, cutoff int, info CompactInfo)
OnCompactStart func(took, estTokens int)
OnNewContextStart func(took, estTokens int)
OnNewContext func(cutoff int)
OnUsage func(u ai.Usage)
OnRetry func(ev ai.RetryEvent)
OnDecay func(n int)
}
type JournaledEvent ¶
type MemoryRuntime ¶ added in v0.107.0
type MemoryRuntime interface {
Inject(context.Context, string) (string, error)
Completed(context.Context, MemoryTurn)
// Abandoned is called for a turn that ended without completing (stopped,
// failed, plan-mode exit) after its user message entered History. It must
// not take the agent's locks.
Abandoned(sessionID string, user ai.Message)
Tools(func() string) []tools.Tool
Close() error
}
MemoryRuntime owns backend memory injection and hidden extraction. Implementations must keep persistence behind the internal/memory Store seam.
type MemoryTurn ¶ added in v0.107.0
type MemoryTurn struct {
SessionID string
Workdir string
Model string
User ai.Message
History []ai.Message
}
MemoryTurn is the durable input and history snapshot supplied after a real turn.
type ModelConfig ¶ added in v0.103.0
type Option ¶
type Option func(*Agent)
func WithComputerConfig ¶ added in v0.107.6
func WithComputerConfig(cfg config.ComputerConfig) Option
func WithExperimental ¶
func WithMemoryEnabled ¶ added in v0.107.6
WithMemoryEnabled sets the memory master switch at construction.
func WithSystemPromptResolver ¶ added in v0.107.0
WithSystemPromptResolver refreshes factory instructions before each turn.
func WithTurnTimeContext ¶ added in v0.107.6
func WithTurnTimeContext() Option
WithTurnTimeContext supplies current context alongside a clock-free system prompt.
type RequestObservation ¶ added in v0.107.0
type RequestObserver ¶ added in v0.107.0
type TaskStatus ¶
type TaskStatus string
const ( TaskRunning TaskStatus = "running" TaskDone TaskStatus = "done" TaskError TaskStatus = "error" TaskCancelled TaskStatus = "cancelled" )
type WaitStatus ¶
type WaitStatus string
const ( WaitRunning WaitStatus = "running" WaitMet WaitStatus = "condition met" WaitTimeout WaitStatus = "timed out" WaitFailed WaitStatus = "command failing" WaitKilled WaitStatus = "cancelled" )
Source Files
¶
- agent.go
- background.go
- compact_transaction.go
- computer.go
- context_snapshots.go
- context_tool.go
- decay.go
- events.go
- filelocks.go
- journal.go
- lifecycle.go
- memory.go
- memory_runtime.go
- memory_store_tool.go
- memory_switch.go
- mode.go
- model.go
- model_usage.go
- prompt_resources.go
- request_observer.go
- response.go
- session_start.go
- skills.go
- subagent.go
- subagent_control.go
- todo.go
- tool_execution.go
- trajectory_child.go
- turn_observer.go
- wait.go
- workflowtool.go
- worktree.go