agentkit

package module

Go to main page

Versions in this module

v1

v1.5.0

Sep 5, 2026

Changes in this version

+ const DefaultSessionPageSize

+ const DefaultSubAgentMaxDelegations

+ const DefaultSubAgentMaxParallel

+ const DefaultSubAgentTimeout

+ const MaxSessionPageSize

+ var ErrInvalidPersistenceData = errors.New("agentkit: persistence backend returned invalid data")

+ var ErrInvalidSessionCursor = errors.New("agentkit: invalid session cursor")

+ var ErrInvalidSessionQuery = errors.New("agentkit: invalid session query")

+ var ErrSessionAccessDenied = errors.New("agentkit: session access denied")

+ var ErrSessionAlreadyExists = errors.New("agentkit: session already exists")

+ var ErrSessionArchived = errors.New("agentkit: session is archived")

+ var ErrSessionFactoryMismatch = errors.New("agentkit: session agent factory binding mismatch")

+ var ErrSessionFactoryPanic = errors.New("agentkit: session agent factory panicked")

+ var ErrSessionIDGeneratorPanic = errors.New("agentkit: session ID generator panicked")

+ var ErrSessionManagerClosed = errors.New("agentkit: session manager is closed")

+ var ErrSessionStale = errors.New("agentkit: session snapshot is stale; reopen the session")

+ var ErrSubAgentBudgetExceeded = errors.New("agentkit: sub-agent delegation budget exceeded")

+ var ErrSubAgentBusy = errors.New("agentkit: sub-agent is busy")

+ var ErrToolResultAccessDenied = errors.New("agentkit: tool result access denied")

type Config

+ SubAgentPolicy *SubAgentPolicy

+ SubAgents []SubAgentConfig

+ type CreateSessionOptions struct

+ ID string

+ OwnerID string

+ Tags []string

+ Title string

+ type DelegationInfo struct

+ Agent string

+ ID string

+ ParentAgent string

+ Path []string

type Event

+ Delegation *DelegationInfo

+ SessionID string

type EventType

+ const EventDelegationEnd

+ const EventDelegationStart

type FileSessionStore

+ func (s *FileSessionStore) QuerySessions(ctx context.Context, query SessionQuery) (SessionPage, error)

type MemorySessionStore

+ func (s *MemorySessionStore) QuerySessions(ctx context.Context, query SessionQuery) (SessionPage, error)

type Session

+ Archived bool

+ type SessionAgentFactory func(ctx context.Context, session SessionConfig) (*Agent, error)

type SessionInfo

+ Archived bool

+ type SessionManager struct

+ func NewSessionManager(cfg *SessionManagerConfig) (*SessionManager, error)

+ func (m *SessionManager) ActiveSessionIDs() []string

+ func (m *SessionManager) Archive(ctx context.Context, id string) error

+ func (m *SessionManager) Close() error

+ func (m *SessionManager) CloseContext(ctx context.Context) error

+ func (m *SessionManager) CloseSession(ctx context.Context, id string) error

+ func (m *SessionManager) Create(ctx context.Context) (*Agent, error)

+ func (m *SessionManager) CreateWithOptions(ctx context.Context, options CreateSessionOptions) (*Agent, error)

+ func (m *SessionManager) Delete(ctx context.Context, id string) error

+ func (m *SessionManager) Fork(ctx context.Context, sourceID string, options CreateSessionOptions) (*Agent, error)

+ func (m *SessionManager) Get(ctx context.Context, id string) (*Session, error)

+ func (m *SessionManager) List(ctx context.Context, query SessionQuery) (SessionPage, error)

+ func (m *SessionManager) Open(ctx context.Context, id string) (*Agent, error)

+ func (m *SessionManager) OpenOrCreate(ctx context.Context, options CreateSessionOptions) (agent *Agent, created bool, err error)

+ func (m *SessionManager) Subscribe(fn Subscriber) func()

+ func (m *SessionManager) Unarchive(ctx context.Context, id string) error

+ func (m *SessionManager) UpdateMetadata(ctx context.Context, id string, metadata SessionMetadata) (*Session, error)

+ type SessionManagerConfig struct

+ AgentConfig *Config

+ AgentFactory SessionAgentFactory

+ IDGenerator func() string

+ OwnerID string

+ Store SessionStore

+ type SessionMetadata struct

+ OwnerID string

+ Tags []string

+ Title string

+ type SessionPage struct

+ NextCursor string

+ Sessions []SessionInfo

+ func QuerySessions(ctx context.Context, store SessionStore, query SessionQuery) (SessionPage, error)

+ type SessionQuery struct

+ Archived *bool

+ Cursor string

+ Limit int

+ OwnerID string

+ Tags []string

+ type SessionQueryStore interface

+ QuerySessions func(ctx context.Context, query SessionQuery) (SessionPage, error)

+ type SubAgentConfig struct

+ Description string

+ Handlers []ChatModelAgentMiddleware

+ IncludeHistory bool

+ MCP *MCPConfig

+ MaxIterations int

+ Model ChatModel

+ ModelFailoverConfig *ModelFailoverConfig

+ ModelRetryConfig *ModelRetryConfig

+ Name string

+ Skills *SkillsConfig

+ SystemPrompt string

+ ToolPolicy *ToolPolicy

+ ToolSearch *ToolSearchConfig

+ Tools []Tool

+ type SubAgentPolicy struct

+ MaxDelegations int

+ MaxParallel int

+ Timeout time.Duration

v1.4.0

Sep 5, 2026

Changes in this version

+ const DefaultGoalLeaseDuration

+ const DefaultMCPInitializationTimeout

+ const DefaultPersistenceTimeout

+ const DefaultToolReductionKeepRecentRounds

+ const DefaultToolReductionMaxContextTokens

+ const DefaultToolReductionMaxResultBytes

+ const DefaultToolResultMaxChars

+ const DefaultToolResultReadMaxChars

+ const ToolResultReadToolName

+ var ErrGoalBlocked = errors.New("agentkit: goal is blocked")

+ var ErrGoalConflict = errors.New("agentkit: goal revision conflict")

+ var ErrGoalEvaluatorPanic = errors.New("agentkit: goal evaluator panicked")

+ var ErrGoalExists = errors.New("agentkit: goal already exists")

+ var ErrGoalInterruptRequired = errors.New("agentkit: goal requires interrupt data")

+ var ErrGoalLeaseHeld = errors.New("agentkit: goal lease is held")

+ var ErrGoalLeaseLost = errors.New("agentkit: goal lease is lost")

+ var ErrGoalNotFound = errors.New("agentkit: goal not found")

+ var ErrGoalRecoveryRequired = errors.New("agentkit: goal recovery requires an explicit retry")

+ var ErrGoalResumeAmbiguous = errors.New("agentkit: multiple unfinished goals require an explicit goal ID")

+ var ErrGoalRunning = errors.New("agentkit: goal runner is already running")

+ var ErrMCPClosePanic = errors.New("agentkit: MCP session close panicked")

+ var ErrMCPInitializationPanic = errors.New("agentkit: MCP initialization panicked")

+ var ErrMiddlewarePanic = errors.New("agentkit: agent middleware panicked")

+ var ErrModelPanic = errors.New("agentkit: model panicked")

+ var ErrModelPolicyPanic = errors.New("agentkit: model policy callback panicked")

+ var ErrPersistencePanic = errors.New("agentkit: persistence backend panicked")

+ var ErrResumeRequired = errors.New(...)

+ var ErrSessionConflict = errors.New("agentkit: session revision conflict")

+ var ErrSkillBackendPanic = errors.New("agentkit: skill backend panicked")

+ var ErrSubscriberPanic = errors.New("agentkit: event subscriber panicked")

+ var ErrToolExecutionPanic = errors.New("agentkit: tool execution panicked")

+ var ErrToolMetadataPanic = errors.New("agentkit: tool metadata panicked")

+ var ErrToolPolicyPanic = errors.New("agentkit: tool policy callback panicked")

+ var ErrToolResultExists = errors.New("agentkit: tool result already exists")

+ var ErrToolResultNotFound = errors.New("agentkit: tool result not found")

+ func GoalOperationKey(ctx context.Context, operation string) (string, bool)

+ func RunValue[T any](ctx context.Context, key string) (T, bool)

+ func RunValues(ctx context.Context) map[string]any

+ func SetRunValue(ctx context.Context, key string, value any)

+ func WithRunConfig(ctx context.Context, config RunConfig) context.Context

type Agent

+ func (a *Agent) AbortContext(ctx context.Context) error

+ func (a *Agent) Ask(ctx context.Context, input string) (*RunResult, error)

+ func (a *Agent) AskParts(ctx context.Context, parts ...ContentPart) (*RunResult, error)

+ func (a *Agent) ClearCheckpoint(ctx context.Context) error

+ func (a *Agent) CloseContext(ctx context.Context) error

+ func (a *Agent) ContinueWithResult(ctx context.Context) (*RunResult, error)

+ func (a *Agent) PendingInterrupts() []InterruptPoint

+ func (a *Agent) ResumeWithResult(ctx context.Context, targets map[string]any) (*RunResult, error)

+ func (a *Agent) Stream(ctx context.Context, input string) (*RunStream, error)

+ func (a *Agent) StreamParts(ctx context.Context, parts ...ContentPart) (*RunStream, error)

+ func (a *Agent) ToolResultStore() ToolResultStore

+ type CheckpointDeleter interface

+ Delete func(ctx context.Context, id string) error

+ type CheckpointStore = compose.CheckPointStore

+ type CheckpointStoreProvider interface

+ CheckpointStore func() CheckpointStore

type Config

+ PersistenceTimeout time.Duration

+ ToolPolicy *ToolPolicy

+ ToolReduction *ToolReductionConfig

+ ToolSearch *ToolSearchConfig

+ type EnhancedInvokableToolEndpoint = compose.EnhancedInvokableToolEndpoint

+ type EnhancedInvokableToolMiddleware = compose.EnhancedInvokableToolMiddleware

+ type EnhancedInvokableToolOutput = compose.EnhancedInvokableToolOutput

+ type EnhancedStreamableToolEndpoint = compose.EnhancedStreamableToolEndpoint

+ type EnhancedStreamableToolMiddleware = compose.EnhancedStreamableToolMiddleware

+ type EnhancedStreamableToolOutput = compose.EnhancedStreamableToolOutput

type Event

+ Goal *Goal

type EventType

+ const EventGoalUpdate

+ type FileCheckpointStore struct

+ func NewFileCheckpointStore(dir string) (*FileCheckpointStore, error)

+ func (s *FileCheckpointStore) Delete(ctx context.Context, id string) error

+ func (s *FileCheckpointStore) Get(ctx context.Context, id string) ([]byte, bool, error)

+ func (s *FileCheckpointStore) Set(ctx context.Context, id string, value []byte) error

+ type FileGoalStore struct

+ func NewFileGoalStore(dir string) (*FileGoalStore, error)

+ func (s *FileGoalStore) AcquireGoalLease(ctx context.Context, goalID, workerID string, duration time.Duration) (*GoalLease, error)

+ func (s *FileGoalStore) Delete(ctx context.Context, id string) error

+ func (s *FileGoalStore) DeleteGoalWithLease(ctx context.Context, goalID string, lease *GoalLease) error

+ func (s *FileGoalStore) List(ctx context.Context) ([]GoalInfo, error)

+ func (s *FileGoalStore) Load(ctx context.Context, id string) (*Goal, error)

+ func (s *FileGoalStore) ReleaseGoalLease(ctx context.Context, lease *GoalLease) error

+ func (s *FileGoalStore) RenewGoalLease(ctx context.Context, lease *GoalLease, duration time.Duration) (*GoalLease, error)

+ func (s *FileGoalStore) Save(ctx context.Context, goal *Goal) error

+ func (s *FileGoalStore) SaveGoalWithLease(ctx context.Context, goal *Goal, lease *GoalLease) error

type FileSessionStore

+ func (s *FileSessionStore) CheckpointStore() CheckpointStore

+ func (s *FileSessionStore) GoalStore() GoalStore

+ func (s *FileSessionStore) ToolResultStore() ToolResultStore

+ type FileToolResultStore struct

+ func NewFileToolResultStore(dir string) (*FileToolResultStore, error)

+ func (s *FileToolResultStore) Delete(ctx context.Context, id string) error

+ func (s *FileToolResultStore) List(ctx context.Context) ([]ToolResultInfo, error)

+ func (s *FileToolResultStore) Load(ctx context.Context, id string) (*StoredToolResult, error)

+ func (s *FileToolResultStore) Save(ctx context.Context, result *StoredToolResult) error

+ type Goal struct

+ AttemptIteration int

+ AwaitingInterrupt bool

+ CreatedAt time.Time

+ HistoryMessageCount int

+ ID string

+ InProgress bool

+ Iteration int

+ LastError string

+ LastReason string

+ LastResponse string

+ MaxIterations int

+ NextPrompt string

+ Objective string

+ PendingEvaluation bool

+ PendingPrompt string

+ Revision uint64

+ SessionID string

+ Status GoalStatus

+ SuccessCriteria string

+ UpdatedAt time.Time

+ type GoalDecision struct

+ Complete bool

+ NextPrompt string

+ Reason string

+ type GoalEvaluation struct

+ Iteration int

+ LastResponse string

+ Objective string

+ SuccessCriteria string

+ type GoalEvaluator interface

+ Evaluate func(ctx context.Context, evaluation GoalEvaluation) (GoalDecision, error)

+ type GoalEvaluatorFunc func(context.Context, GoalEvaluation) (GoalDecision, error)

+ func (f GoalEvaluatorFunc) Evaluate(ctx context.Context, evaluation GoalEvaluation) (GoalDecision, error)

+ type GoalInfo struct

+ AttemptIteration int

+ AwaitingInterrupt bool

+ ID string

+ InProgress bool

+ Iteration int

+ LastError string

+ LastReason string

+ MaxIterations int

+ Objective string

+ PendingEvaluation bool

+ Revision uint64

+ SessionID string

+ Status GoalStatus

+ UpdatedAt time.Time

+ type GoalLease struct

+ ExpiresAt time.Time

+ GoalID string

+ Token string

+ WorkerID string

+ type GoalLeaseHeldError struct

+ Lease GoalLease

+ func (e *GoalLeaseHeldError) Error() string

+ func (e *GoalLeaseHeldError) Unwrap() error

+ type GoalLeaseStore interface

+ AcquireGoalLease func(ctx context.Context, goalID, workerID string, duration time.Duration) (*GoalLease, error)

+ DeleteGoalWithLease func(ctx context.Context, goalID string, lease *GoalLease) error

+ ReleaseGoalLease func(ctx context.Context, lease *GoalLease) error

+ RenewGoalLease func(ctx context.Context, lease *GoalLease, duration time.Duration) (*GoalLease, error)

+ SaveGoalWithLease func(ctx context.Context, goal *Goal, lease *GoalLease) error

+ type GoalRequest struct

+ ID string

+ MaxIterations int

+ Objective string

+ SuccessCriteria string

+ type GoalRun struct

+ func (r *GoalRun) Done() <-chan struct{}

+ func (r *GoalRun) ID() string

+ func (r *GoalRun) Pause(ctx context.Context) error

+ func (r *GoalRun) Wait() (*GoalRunResult, error)

+ func (r *GoalRun) WaitContext(ctx context.Context) (*GoalRunResult, error)

+ type GoalRunInfo struct

+ Attempt int

+ GoalID string

+ SessionID string

+ func CurrentGoalRun(ctx context.Context) (GoalRunInfo, bool)

+ type GoalRunResult struct

+ Goal *Goal

+ LastRun *RunResult

+ type GoalRunner struct

+ func NewGoalRunner(agent *Agent, cfg *GoalRunnerConfig) (*GoalRunner, error)

+ func (r *GoalRunner) Clear(ctx context.Context, id string) (retErr error)

+ func (r *GoalRunner) Get(ctx context.Context, id string) (*Goal, error)

+ func (r *GoalRunner) List(ctx context.Context) ([]GoalInfo, error)

+ func (r *GoalRunner) Pause(ctx context.Context, id string) (retErr error)

+ func (r *GoalRunner) Resume(ctx context.Context, id string) (out *GoalRunResult, retErr error)

+ func (r *GoalRunner) ResumeAsync(ctx context.Context, id string) (*GoalRun, error)

+ func (r *GoalRunner) ResumeInterrupt(ctx context.Context, id string, targets map[string]any) (out *GoalRunResult, retErr error)

+ func (r *GoalRunner) ResumeInterruptAsync(ctx context.Context, id string, targets map[string]any) (*GoalRun, error)

+ func (r *GoalRunner) ResumePending(ctx context.Context) (*GoalRunResult, error)

+ func (r *GoalRunner) ResumePendingAsync(ctx context.Context) (*GoalRun, error)

+ func (r *GoalRunner) Retry(ctx context.Context, id string) (out *GoalRunResult, retErr error)

+ func (r *GoalRunner) RetryAsync(ctx context.Context, id string) (*GoalRun, error)

+ func (r *GoalRunner) Start(ctx context.Context, request GoalRequest) (out *GoalRunResult, retErr error)

+ func (r *GoalRunner) StartAsync(ctx context.Context, request GoalRequest) (*GoalRun, error)

+ type GoalRunnerConfig struct

+ Evaluator GoalEvaluator

+ LeaseDuration time.Duration

+ MaxIterations int

+ RequireLease bool

+ Store GoalStore

+ WorkerID string

+ type GoalStatus string

+ const GoalStatusActive

+ const GoalStatusBlocked

+ const GoalStatusCompleted

+ const GoalStatusPaused

+ type GoalStore interface

+ Delete func(ctx context.Context, id string) error

+ List func(ctx context.Context) ([]GoalInfo, error)

+ Load func(ctx context.Context, id string) (*Goal, error)

+ Save func(ctx context.Context, goal *Goal) error

+ type GoalStoreProvider interface

+ GoalStore func() GoalStore

+ type InvokableToolEndpoint = compose.InvokableToolEndpoint

+ type InvokableToolMiddleware = compose.InvokableToolMiddleware

type MCPConfig

+ InitializationTimeout time.Duration

+ type MemoryCheckpointStore struct

+ func NewMemoryCheckpointStore() *MemoryCheckpointStore

+ func (s *MemoryCheckpointStore) Delete(ctx context.Context, id string) error

+ func (s *MemoryCheckpointStore) Get(ctx context.Context, id string) (value []byte, existed bool, err error)

+ func (s *MemoryCheckpointStore) Set(ctx context.Context, id string, value []byte) error

+ type MemoryGoalStore struct

+ func NewMemoryGoalStore() *MemoryGoalStore

+ func (s *MemoryGoalStore) AcquireGoalLease(ctx context.Context, goalID, workerID string, duration time.Duration) (*GoalLease, error)

+ func (s *MemoryGoalStore) Delete(ctx context.Context, id string) error

+ func (s *MemoryGoalStore) DeleteGoalWithLease(ctx context.Context, goalID string, lease *GoalLease) error

+ func (s *MemoryGoalStore) List(ctx context.Context) ([]GoalInfo, error)

+ func (s *MemoryGoalStore) Load(ctx context.Context, id string) (*Goal, error)

+ func (s *MemoryGoalStore) ReleaseGoalLease(ctx context.Context, lease *GoalLease) error

+ func (s *MemoryGoalStore) RenewGoalLease(ctx context.Context, lease *GoalLease, duration time.Duration) (*GoalLease, error)

+ func (s *MemoryGoalStore) Save(ctx context.Context, goal *Goal) error

+ func (s *MemoryGoalStore) SaveGoalWithLease(ctx context.Context, goal *Goal, lease *GoalLease) error

type MemorySessionStore

+ func (s *MemorySessionStore) CheckpointStore() CheckpointStore

+ func (s *MemorySessionStore) GoalStore() GoalStore

+ func (s *MemorySessionStore) ToolResultStore() ToolResultStore

+ type MemoryToolResultStore struct

+ func NewMemoryToolResultStore() *MemoryToolResultStore

+ func (s *MemoryToolResultStore) Delete(ctx context.Context, id string) error

+ func (s *MemoryToolResultStore) List(ctx context.Context) ([]ToolResultInfo, error)

+ func (s *MemoryToolResultStore) Load(ctx context.Context, id string) (*StoredToolResult, error)

+ func (s *MemoryToolResultStore) Save(ctx context.Context, result *StoredToolResult) error

+ type ModelGoalEvaluator struct

+ func NewModelGoalEvaluator(model ChatModel) (*ModelGoalEvaluator, error)

+ func (e *ModelGoalEvaluator) Evaluate(ctx context.Context, evaluation GoalEvaluation) (GoalDecision, error)

+ type ModelOption = model.Option

+ type RetentionPolicy struct

+ CompletedGoalAge time.Duration

+ DetachedToolResultAge time.Duration

+ SessionIdleTime time.Duration

+ type RetentionReport struct

+ CompletedGoalsDeleted int

+ DetachedToolResultsDeleted int

+ SessionsDeleted int

+ func PruneResources(ctx context.Context, sessions SessionStore, policy RetentionPolicy) (RetentionReport, error)

+ type RunConfig struct

+ ModelOptions []ModelOption

+ ToolOptions []ToolOption

+ Values map[string]any

+ type RunResult struct

+ FinishReason string

+ Interrupts []InterruptPoint

+ Messages []*schema.Message

+ ReasoningContent string

+ Response *schema.Message

+ Text string

+ ToolCalls []ToolCall

+ Usage *TokenUsage

+ func (r *RunResult) IsInterrupted() bool

+ type RunStream struct

+ func (s *RunStream) Cancel()

+ func (s *RunStream) Close() error

+ func (s *RunStream) Done() <-chan struct{}

+ func (s *RunStream) Events() <-chan Event

+ func (s *RunStream) Wait() (*RunResult, error)

+ func (s *RunStream) WaitContext(ctx context.Context) (*RunResult, error)

type Session

+ CheckpointID string

+ PendingInterrupts []InterruptPoint

+ Revision uint64

type SessionInfo

+ PendingInterruptCount int

+ Revision uint64

+ type StoredToolResult struct

+ Content string

+ CreatedAt time.Time

+ ID string

+ SessionID string

+ type StreamToolOutput = compose.StreamToolOutput

+ type StreamableToolEndpoint = compose.StreamableToolEndpoint

+ type StreamableToolMiddleware = compose.StreamableToolMiddleware

+ type ToolAlias struct

+ Arguments map[string][]string

+ Names []string

+ type ToolInput = compose.ToolInput

+ type ToolInvocation struct

+ Arguments string

+ CallID string

+ Name string

+ type ToolMiddleware = compose.ToolMiddleware

+ type ToolOption = tool.Option

+ type ToolOutcome struct

+ Duration time.Duration

+ Err error

+ OutputChars int

+ Truncated bool

+ type ToolOutput = compose.ToolOutput

+ type ToolPolicy struct

+ AfterTool func(ctx context.Context, call ToolInvocation, outcome ToolOutcome)

+ Aliases map[string]ToolAlias

+ BeforeTool func(ctx context.Context, call ToolInvocation) error

+ MaxResultChars int

+ Middlewares []ToolMiddleware

+ RewriteArguments func(ctx context.Context, name, arguments string) (string, error)

+ Sequential bool

+ Timeout time.Duration

+ UnknownTool func(ctx context.Context, name, arguments string) (string, error)

+ type ToolReductionConfig struct

+ KeepRecentToolRounds int

+ MaxContextTokens int64

+ MaxResultBytes int

+ Store ToolResultStore

+ type ToolResultInfo struct

+ CreatedAt time.Time

+ ID string

+ SessionID string

+ Size int

+ type ToolResultStore interface

+ Delete func(ctx context.Context, id string) error

+ List func(ctx context.Context) ([]ToolResultInfo, error)

+ Load func(ctx context.Context, id string) (*StoredToolResult, error)

+ Save func(ctx context.Context, result *StoredToolResult) error

+ type ToolResultStoreProvider interface

+ ToolResultStore func() ToolResultStore

+ type ToolSearchConfig struct

+ Tools []Tool

+ UseModelNative bool

v1.3.0

Sep 4, 2026

Changes in this version

+ const DefaultCompactionMaxTokens

+ const DefaultMCPMaxDescriptionChars

+ const DefaultMCPMaxResultChars

+ var ErrAgentClosed = errors.New("agentkit: agent is closed")

+ var ErrAgentRunning = errors.New("agent is already running")

+ var ErrCannotContinue = errors.New(...)

+ var ErrNoMessagesToContinue = errors.New("no messages in state to continue from")

+ var ErrSessionDisabled = errors.New("agentkit: session persistence is not configured")

+ var ErrSessionNotFound = errors.New("agentkit: session not found")

+ var ErrSkillNotFound = errors.New("agentkit: skill not found")

type Agent

+ func (a *Agent) Cancel()

+ func (a *Agent) ContextHistory() []*schema.Message

+ func (a *Agent) SaveSession(ctx context.Context) error

+ func (a *Agent) Session() *Session

+ type CompactionConfig struct

+ KeepRecentTurns int

+ MaxMessages int

+ MaxTokens int

+ Model ChatModel

+ SummaryPrompt string

+ type CompactionInfo struct

+ MessagesAfter int

+ MessagesBefore int

type Config

+ Compaction *CompactionConfig

+ MCP *MCPConfig

+ Session *SessionConfig

+ Skills *SkillsConfig

type Event

+ Compaction *CompactionInfo

type EventType

+ const EventCompactionEnd

+ const EventCompactionStart

+ type FileSessionStore struct

+ func NewFileSessionStore(dir string) (*FileSessionStore, error)

+ func (s *FileSessionStore) Delete(ctx context.Context, id string) error

+ func (s *FileSessionStore) List(ctx context.Context) ([]SessionInfo, error)

+ func (s *FileSessionStore) Load(ctx context.Context, id string) (*Session, error)

+ func (s *FileSessionStore) Save(ctx context.Context, session *Session) error

+ type FileSkillBackend struct

+ func NewFileSkillBackend(paths ...string) (*FileSkillBackend, error)

+ func (b *FileSkillBackend) Get(ctx context.Context, name string) (Skill, error)

+ func (b *FileSkillBackend) List(ctx context.Context) ([]SkillInfo, error)

+ type MCPClientSession interface

+ Close func() error

+ type MCPConfig struct

+ ClientName string

+ ClientVersion string

+ KeepAlive time.Duration

+ MaxDescriptionChars int

+ MaxResultChars int

+ Servers []MCPServerConfig

+ type MCPServerConfig struct

+ Args []string

+ Command string

+ Env map[string]string

+ HTTPClient *http.Client

+ Headers map[string]string

+ Name string

+ Session MCPClientSession

+ ToolNames []string

+ ToolPrefix string

+ Transport MCPTransport

+ URL string

+ WorkingDir string

+ type MCPTransport string

+ const MCPTransportSSE

+ const MCPTransportStdio

+ const MCPTransportStreamableHTTP

+ type MemorySessionStore struct

+ func NewMemorySessionStore() *MemorySessionStore

+ func (s *MemorySessionStore) Delete(ctx context.Context, id string) error

+ func (s *MemorySessionStore) List(ctx context.Context) ([]SessionInfo, error)

+ func (s *MemorySessionStore) Load(ctx context.Context, id string) (*Session, error)

+ func (s *MemorySessionStore) Save(ctx context.Context, session *Session) error

+ type MemorySkillBackend struct

+ func NewMemorySkillBackend(skills ...Skill) (*MemorySkillBackend, error)

+ func (b *MemorySkillBackend) Delete(name string) error

+ func (b *MemorySkillBackend) Get(ctx context.Context, name string) (Skill, error)

+ func (b *MemorySkillBackend) List(ctx context.Context) ([]SkillInfo, error)

+ func (b *MemorySkillBackend) Set(item Skill) error

+ type Session struct

+ Context []*schema.Message

+ CreatedAt time.Time

+ ID string

+ Messages []*schema.Message

+ UpdatedAt time.Time

+ type SessionConfig struct

+ ID string

+ Store SessionStore

+ type SessionInfo struct

+ ContextMessageCount int

+ CreatedAt time.Time

+ ID string

+ MessageCount int

+ UpdatedAt time.Time

+ type SessionStore interface

+ Delete func(ctx context.Context, id string) error

+ List func(ctx context.Context) ([]SessionInfo, error)

+ Load func(ctx context.Context, id string) (*Session, error)

+ Save func(ctx context.Context, session *Session) error

+ type Skill = einoskill.Skill

+ type SkillBackend = einoskill.Backend

+ type SkillInfo = einoskill.FrontMatter

+ type SkillsConfig struct

+ Backend SkillBackend

+ Paths []string

+ ToolName string

v1.2.0

Jun 8, 2026

Changes in this version

+ var ErrMockModelNoResponse = errors.New("mock chat model has no response configured")

type Agent

+ func (a *Agent) SetHistory(history []*schema.Message)

+ type BaseChatModelAgentMiddleware = adk.BaseChatModelAgentMiddleware

+ type ChatModelAgentMiddleware = adk.ChatModelAgentMiddleware

type Config

+ Handlers []ChatModelAgentMiddleware

+ History []*schema.Message

+ ModelFailoverConfig *ModelFailoverConfig

+ ModelRetryConfig *ModelRetryConfig

type Event

+ Role RoleType

+ ToolArguments string

+ ToolCallID string

+ ToolName string

+ type MockChatModel struct

+ func NewMockChatModel(responses ...MockModelResponse) *MockChatModel

+ func (m *MockChatModel) AddResponses(responses ...MockModelResponse)

+ func (m *MockChatModel) Calls() []MockModelCall

+ func (m *MockChatModel) Generate(ctx context.Context, input []*schema.Message, opts ...model.Option) (*schema.Message, error)

+ func (m *MockChatModel) LastCall() (MockModelCall, bool)

+ func (m *MockChatModel) RemainingResponses() int

+ func (m *MockChatModel) Stream(ctx context.Context, input []*schema.Message, opts ...model.Option) (*schema.StreamReader[*schema.Message], error)

+ type MockModelCall struct

+ Input []*schema.Message

+ Options []model.Option

+ Streaming bool

+ type MockModelExpectation func(call MockModelCall) error

+ func MockExpectToolResults(callIDs ...string) MockModelExpectation

+ type MockModelResponse struct

+ Build func(call MockModelCall) MockModelResponse

+ Chunks []*schema.Message

+ Err error

+ Expect MockModelExpectation

+ Message *schema.Message

+ StreamErr error

+ func MockExpect(response MockModelResponse, expect MockModelExpectation) MockModelResponse

+ func MockModelAfterToolResult(callID string, response MockModelResponse) MockModelResponse

+ func MockModelAfterToolResults(response MockModelResponse, callIDs ...string) MockModelResponse

+ func MockModelCalls(invocations ...MockToolCallProvider) MockModelResponse

+ func MockModelCallsAfter(wait MockToolCallProvider, calls ...MockToolCallProvider) MockModelResponse

+ func MockModelCallsAfterAll(wait []MockToolCallProvider, calls ...MockToolCallProvider) MockModelResponse

+ func MockModelError(err error) MockModelResponse

+ func MockModelMessage(message *schema.Message) MockModelResponse

+ func MockModelReasoning(content, reasoning string) MockModelResponse

+ func MockModelRespondsAfterToolResult(callID string, reply func(result string) MockModelResponse) MockModelResponse

+ func MockModelRespondsAfterToolResultAs[D any](callID string, reply func(D) MockModelResponse) MockModelResponse

+ func MockModelRespondsAfter[D any](call *MockToolInvocation[D], reply func(D) MockModelResponse) MockModelResponse

+ func MockModelStream(chunks ...string) MockModelResponse

+ func MockModelStreamError(err error, chunks ...string) MockModelResponse

+ func MockModelText(content string) MockModelResponse

+ func MockModelTextAfterAll(content string, calls ...MockToolCallProvider) MockModelResponse

+ func MockModelTextAfterToolResult(callID string) MockModelResponse

+ func MockModelTextAfter[D any](call *MockToolInvocation[D], reply func(D) string) MockModelResponse

+ func MockModelToolCall(name, arguments string) MockModelResponse

+ func MockModelToolCallWithID(id, name, arguments string) MockModelResponse

+ func MockModelToolCalls(calls ...schema.ToolCall) MockModelResponse

+ type MockTool struct

+ Name string

+ Tool Tool

+ func MustMockTool[T, D any](name, desc string, fn func(context.Context, T) (D, error)) *MockTool[T, D]

+ func NewMockTool[T, D any](name, desc string, fn func(context.Context, T) (D, error)) (*MockTool[T, D], error)

+ func (f *MockTool[T, D]) Call(callID string, input T) *MockToolInvocation[D]

+ func (f *MockTool[T, D]) Invocation(callID string, input T) (*MockToolInvocation[D], error)

+ func (f *MockTool[T, D]) MockTool() Tool

+ func (f *MockTool[T, D]) MustInvocation(callID string, input T) *MockToolInvocation[D]

+ type MockToolCallProvider interface

+ MockToolCall func() schema.ToolCall

+ type MockToolInvocation struct

+ Arguments string

+ CallID string

+ Name string

+ Tool Tool

+ func MockToolCallFunc[T, D any](name, desc string, input T, fn func(context.Context, T) (D, error)) (*MockToolInvocation[D], error)

+ func MustMockToolCallFunc[T, D any](name, desc string, input T, fn func(context.Context, T) (D, error)) *MockToolInvocation[D]

+ func (i *MockToolInvocation[D]) MockTool() Tool

+ func (i *MockToolInvocation[D]) MockToolCall() schema.ToolCall

+ type MockToolProvider interface

+ MockTool func() Tool

+ type ModelFailoverConfig = adk.ModelFailoverConfig[*schema.Message]

+ type ModelRetryConfig = adk.ModelRetryConfig

type Tool

+ func MockTools(items ...MockToolProvider) []Tool

v1.1.0

Mar 17, 2026

Changes in this version

type Agent

+ func (a *Agent) Send(ctx context.Context, parts ...ContentPart) error

+ type ContentPart = schema.MessageInputPart

+ func AudioBase64(data, mimeType string) ContentPart

+ func AudioURL(url string) ContentPart

+ func FileBase64(data, mimeType string, name ...string) ContentPart

+ func FileURL(url string) ContentPart

+ func ImageBase64(data, mimeType string, detail ...ImageURLDetail) ContentPart

+ func ImageURL(url string, detail ...ImageURLDetail) ContentPart

+ func Text(s string) ContentPart

+ func VideoBase64(data, mimeType string) ContentPart

+ func VideoURL(url string) ContentPart

+ type ImageURLDetail = schema.ImageURLDetail

+ const ImageDetailAuto

+ const ImageDetailHigh

+ const ImageDetailLow

v1.0.0

Mar 17, 2026

Changes in this version

+ func EmitToolUpdate(ctx context.Context, content string)

+ func GetInterruptState[T any](ctx context.Context) (wasInterrupted bool, hasState bool, state T)

+ func GetResumeContext[T any](ctx context.Context) (isResumeTarget bool, hasData bool, data T)

+ func Interrupt(ctx context.Context, info any) error

+ func StatefulInterrupt(ctx context.Context, info any, state any) error

+ type Agent struct

+ func New(ctx context.Context, cfg *Config) (*Agent, error)

+ func (a *Agent) Abort()

+ func (a *Agent) ClearAllQueues()

+ func (a *Agent) ClearFollowUpQueue()

+ func (a *Agent) ClearSteeringQueue()

+ func (a *Agent) Close() error

+ func (a *Agent) Continue(ctx context.Context) error

+ func (a *Agent) FollowUp(content string)

+ func (a *Agent) History() []*schema.Message

+ func (a *Agent) Name() string

+ func (a *Agent) Prompt(ctx context.Context, input string) error

+ func (a *Agent) Reset()

+ func (a *Agent) Resume(ctx context.Context, targets map[string]any) error

+ func (a *Agent) SetFollowUpMode(mode QueueMode)

+ func (a *Agent) SetSteeringMode(mode QueueMode)

+ func (a *Agent) State() *State

+ func (a *Agent) Steer(content string)

+ func (a *Agent) Subscribe(fn Subscriber) func()

+ type ChatModel = model.BaseChatModel

+ type Config struct

+ CheckPointStore compose.CheckPointStore

+ Description string

+ MaxIterations int

+ Middlewares []adk.AgentMiddleware

+ Model ChatModel

+ ModelMiddlewares []adk.ChatModelAgentMiddleware

+ Name string

+ SystemPrompt string

+ Tools []Tool

+ type Event struct

+ Agent string

+ Content string

+ Delta string

+ Error error

+ Interrupt []InterruptPoint

+ ReasoningContent string

+ ResponseMeta *ResponseMeta

+ ToolCalls []ToolCall

+ Type EventType

+ type EventType string

+ const EventAgentEnd

+ const EventAgentStart

+ const EventError

+ const EventInterrupted

+ const EventMessageDelta

+ const EventMessageEnd

+ const EventMessageStart

+ const EventReasoningDelta

+ const EventToolEnd

+ const EventToolStart

+ const EventToolUpdate

+ const EventTransfer

+ const EventTurnEnd

+ const EventTurnStart

+ type InterruptPoint struct

+ ID string

+ Info any

+ type Message struct

+ Agent string

+ Content string

+ ReasoningContent string

+ Role RoleType

+ type QueueMode string

+ const QueueModeAll

+ const QueueModeOneAtATime

+ type ResponseMeta = schema.ResponseMeta

+ type RoleType string

+ const RoleAssistant

+ const RoleTool

+ const RoleUser

+ type State struct

+ func (s *State) AddMessage(msg Message)

+ func (s *State) Clear()

+ func (s *State) IsStreaming() bool

+ func (s *State) Messages() []Message

+ type Subscriber func(Event)

+ type TokenUsage = schema.TokenUsage

+ type Tool = tool.BaseTool

+ type ToolCall = schema.ToolCall

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