agentkit

type Agent struct {
	// contains filtered or unexported fields
}

type BaseChatModelAgentMiddleware = adk.BaseChatModelAgentMiddleware

type ChatModel = model.BaseChatModel

type ChatModelAgentMiddleware = adk.ChatModelAgentMiddleware

type CheckpointDeleter interface {
	Delete(ctx context.Context, id string) error
}

type CheckpointStore = compose.CheckPointStore

type CheckpointStoreProvider interface {
	CheckpointStore() CheckpointStore
}

type CompactionConfig struct {
	// Model 用于生成摘要。为空时复用 Agent 的主模型。
	Model ChatModel
	// MaxTokens 在估算的上下文 token 数超过该值时压缩。
	// MaxTokens 和 MaxMessages 都为 0 时默认使用 DefaultCompactionMaxTokens。
	MaxTokens int
	// MaxMessages 在模型上下文消息数超过该值时压缩。
	MaxMessages int
	// KeepRecentTurns 原样保留最近的用户轮次，默认 1。
	KeepRecentTurns int
	// SummaryPrompt 是可选的自定义摘要指令。
	SummaryPrompt string
}

type CompactionInfo struct {
	MessagesBefore int
	MessagesAfter  int
}

type Config struct {
	Name                string
	Description         string
	SystemPrompt        string
	Model               ChatModel                  // 聊天模型（可直接使用 agentkit.ChatModel 别名）
	Tools               []Tool                     // 工具列表（可直接使用 agentkit.Tool 别名）
	ToolPolicy          *ToolPolicy                // 工具别名、分发、执行保护与中间件（可选）
	History             []*schema.Message          // 完整对话历史（可选）
	Handlers            []ChatModelAgentMiddleware // ChatModelAgent 扩展处理器
	ModelRetryConfig    *ModelRetryConfig          // 模型调用重试配置（可选）
	ModelFailoverConfig *ModelFailoverConfig       // 模型失败转移配置（可选）
	MaxIterations       int                        // 默认 20
	PersistenceTimeout  time.Duration              // 取消后的内部持久化收尾 context 超时；默认 30 秒
	CheckPointStore     compose.CheckPointStore    // 自定义 CheckPoint 存储；默认使用 Session 配套存储或内存存储
	Session             *SessionConfig             // 自动恢复并保存完整对话（可选）
	Compaction          *CompactionConfig          // 自动上下文压缩（可选）
	Skills              *SkillsConfig              // 按需加载 SKILL.md（可选）
	MCP                 *MCPConfig                 // 自动连接并管理 MCP 服务器（可选）
	ToolSearch          *ToolSearchConfig          // 大型工具集按需搜索（可选）
	ToolReduction       *ToolReductionConfig       // 大型工具结果持久化卸载与按需回取（可选）
	SubAgents           []SubAgentConfig           // 独立上下文的声明式子 Agent（可选）
	SubAgentPolicy      *SubAgentPolicy            // 子 Agent 委派次数、并发与超时策略（可选）
}

type ContentPart = schema.MessageInputPart

type CreateSessionOptions struct {
	ID      string
	Title   string
	OwnerID string
	Tags    []string
}

type DelegationInfo struct {
	ID          string
	ParentAgent string
	Agent       string
	Path        []string
}

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 struct {
	Type             EventType
	Agent            string           // 产生事件的 Agent 名称
	SessionID        string           // 产生事件的会话 ID；未启用会话时为空
	Role             RoleType         // 消息角色（message_start / message_end）
	Content          string           // 文本内容（message_end / tool_end）
	Delta            string           // 流式增量内容（message_delta / reasoning_delta）
	ReasoningContent string           // 完整推理内容（message_end，仅推理模型）
	ResponseMeta     *ResponseMeta    // 响应元数据：token 用量、完成原因（message_end）
	ToolCalls        []ToolCall       // 工具调用列表（tool_start）
	ToolCallID       string           // 工具调用 ID（tool_update / tool_end）
	ToolName         string           // 工具名称（tool_update / tool_end）
	ToolArguments    string           // 工具调用参数（tool_update / tool_end）
	Interrupt        []InterruptPoint // 中断点列表（interrupted）
	Compaction       *CompactionInfo  // 上下文压缩信息（compaction_start / compaction_end）
	Goal             *Goal            // 已持久化的目标快照（goal_update）
	Delegation       *DelegationInfo  // 子 Agent 委派信息（delegation_start / delegation_end 及子 Agent 事件）
	Error            error            // 错误信息（error）
}

type EventType string

type FileCheckpointStore struct {
	// contains filtered or unexported fields
}

type FileGoalStore struct {
	// contains filtered or unexported fields
}

type FileSessionStore struct {
	// contains filtered or unexported fields
}

type FileSkillBackend struct {
	// contains filtered or unexported fields
}

type FileToolResultStore struct {
	// contains filtered or unexported fields
}

type Goal struct {
	ID                  string     `json:"id"`
	SessionID           string     `json:"session_id"`
	Objective           string     `json:"objective"`
	SuccessCriteria     string     `json:"success_criteria,omitempty"`
	Status              GoalStatus `json:"status"`
	Iteration           int        `json:"iteration"`
	MaxIterations       int        `json:"max_iterations"`
	LastResponse        string     `json:"last_response,omitempty"`
	LastReason          string     `json:"last_reason,omitempty"`
	NextPrompt          string     `json:"next_prompt,omitempty"`
	LastError           string     `json:"last_error,omitempty"`
	InProgress          bool       `json:"in_progress,omitempty"`
	AwaitingInterrupt   bool       `json:"awaiting_interrupt,omitempty"`
	PendingEvaluation   bool       `json:"pending_evaluation,omitempty"`
	AttemptIteration    int        `json:"attempt_iteration,omitempty"`
	HistoryMessageCount int        `json:"history_message_count,omitempty"`
	PendingPrompt       string     `json:"pending_prompt,omitempty"`
	Revision            uint64     `json:"revision"`
	CreatedAt           time.Time  `json:"created_at"`
	UpdatedAt           time.Time  `json:"updated_at"`
}

type GoalDecision struct {
	Complete   bool   `json:"complete"`
	Reason     string `json:"reason"`
	NextPrompt string `json:"next_prompt"`
}

type GoalEvaluation struct {
	Objective       string
	SuccessCriteria string
	Iteration       int
	LastResponse    string
}

type GoalEvaluator interface {
	Evaluate(ctx context.Context, evaluation GoalEvaluation) (GoalDecision, error)
}

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

type GoalInfo struct {
	ID                string     `json:"id"`
	SessionID         string     `json:"session_id"`
	Objective         string     `json:"objective"`
	Status            GoalStatus `json:"status"`
	Iteration         int        `json:"iteration"`
	MaxIterations     int        `json:"max_iterations"`
	AttemptIteration  int        `json:"attempt_iteration,omitempty"`
	InProgress        bool       `json:"in_progress,omitempty"`
	AwaitingInterrupt bool       `json:"awaiting_interrupt,omitempty"`
	PendingEvaluation bool       `json:"pending_evaluation,omitempty"`
	LastReason        string     `json:"last_reason,omitempty"`
	LastError         string     `json:"last_error,omitempty"`
	Revision          uint64     `json:"revision"`
	UpdatedAt         time.Time  `json:"updated_at"`
}

type GoalLease struct {
	GoalID    string    `json:"goal_id"`
	WorkerID  string    `json:"worker_id"`
	Token     string    `json:"token"`
	ExpiresAt time.Time `json:"expires_at"`
}

type GoalLeaseHeldError struct {
	Lease GoalLease
}

type GoalLeaseStore interface {
	AcquireGoalLease(ctx context.Context, goalID, workerID string, duration time.Duration) (*GoalLease, error)
	RenewGoalLease(ctx context.Context, lease *GoalLease, duration time.Duration) (*GoalLease, error)
	ReleaseGoalLease(ctx context.Context, lease *GoalLease) error
	SaveGoalWithLease(ctx context.Context, goal *Goal, lease *GoalLease) error
	DeleteGoalWithLease(ctx context.Context, goalID string, lease *GoalLease) error
}

type GoalRequest struct {
	ID              string // 可选；为空时自动生成 UUID
	Objective       string
	SuccessCriteria string
	MaxIterations   int
}

type GoalRun struct {
	// contains filtered or unexported fields
}

type GoalRunInfo struct {
	GoalID    string
	SessionID string
	Attempt   int
}

type GoalRunResult struct {
	Goal    *Goal
	LastRun *RunResult
}

type GoalRunner struct {
	// contains filtered or unexported fields
}

type GoalRunnerConfig struct {
	Store         GoalStore
	Evaluator     GoalEvaluator
	MaxIterations int
	// WorkerID 用于租约诊断；为空时自动生成当前 GoalRunner 实例的唯一 ID。
	WorkerID string
	// LeaseDuration 是 worker 租约时长，默认一分钟；续期频率约为其三分之一。
	LeaseDuration time.Duration
	// RequireLease 要求 Store 实现 GoalLeaseStore，避免生产环境意外退化为单 worker 模式。
	RequireLease bool
}

type GoalStatus string

type GoalStore interface {
	Load(ctx context.Context, id string) (*Goal, error)
	Save(ctx context.Context, goal *Goal) error
	Delete(ctx context.Context, id string) error
	List(ctx context.Context) ([]GoalInfo, error)
}

type GoalStoreProvider interface {
	GoalStore() GoalStore
}

type ImageURLDetail = schema.ImageURLDetail

type InterruptPoint struct {
	ID   string // 中断点唯一标识，Resume 时传入此 ID
	Info any    // 中断原因/上下文信息
}

type InvokableToolEndpoint = compose.InvokableToolEndpoint

type InvokableToolMiddleware = compose.InvokableToolMiddleware

type MCPClientSession interface {
	officialmcp.ClientSession
	Close() error
}

type MCPConfig struct {
	Servers []MCPServerConfig

	ClientName    string        // MCP 客户端名称，默认 "agentkit"
	ClientVersion string        // MCP 客户端版本，默认 "dev"
	KeepAlive     time.Duration // 大于 0 时定期 ping 服务器
	// InitializationTimeout 限制每个服务器的连接与初始工具发现；零值使用 30 秒默认值。
	InitializationTimeout time.Duration

	// 0 使用安全默认值，-1 关闭限制，正数使用指定限制。
	MaxResultChars      int
	MaxDescriptionChars int
}

type MCPServerConfig struct {
	Name       string
	Transport  MCPTransport
	URL        string
	Command    string
	Args       []string
	Env        map[string]string
	WorkingDir string
	Headers    map[string]string
	HTTPClient *http.Client

	Session    MCPClientSession
	ToolNames  []string // 为空时加载服务器的全部工具
	ToolPrefix string   // 暴露给模型的工具名前缀，用于避免多服务器重名
}

type MCPTransport string

type MemoryCheckpointStore struct {
	// contains filtered or unexported fields
}

type MemoryGoalStore struct {
	// contains filtered or unexported fields
}

type MemorySessionStore struct {
	// contains filtered or unexported fields
}

type MemorySkillBackend struct {
	// contains filtered or unexported fields
}

type MemoryToolResultStore struct {
	// contains filtered or unexported fields
}

type Message struct {
	Role             RoleType
	Agent            string // 产生消息的 Agent 名称
	Content          string
	ReasoningContent string // 推理模型的思考内容（如 DeepSeek-R1、o1），非推理模型为空
}

type MockChatModel struct {
	// contains filtered or unexported fields
}

type MockModelCall struct {
	Input     []*schema.Message
	Options   []model.Option
	Streaming bool
}

type MockModelExpectation func(call MockModelCall) error

type MockModelResponse struct {
	Message   *schema.Message
	Chunks    []*schema.Message
	Err       error
	StreamErr error
	Expect    MockModelExpectation
	Build     func(call MockModelCall) MockModelResponse
}

type MockTool[T, D any] struct {
	Tool Tool
	Name string
}

type MockToolCallProvider interface {
	MockToolCall() schema.ToolCall
}

type MockToolInvocation[D any] struct {
	Tool      Tool
	CallID    string
	Name      string
	Arguments string
}

type MockToolProvider interface {
	MockTool() Tool
}

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

type ModelGoalEvaluator struct {
	// contains filtered or unexported fields
}

type ModelOption = model.Option

type ModelRetryConfig = adk.ModelRetryConfig

type QueueMode string

type ResponseMeta = schema.ResponseMeta

type RetentionPolicy struct {
	// SessionIdleTime 删除超过该时长未更新的会话；删除内置会话时会级联清理关联资源。
	SessionIdleTime time.Duration
	// CompletedGoalAge 删除超过该时长未更新的已完成目标；不会删除 active、paused 或 blocked 目标。
	CompletedGoalAge time.Duration
	// DetachedToolResultAge 删除超过该时长且 SessionID 为空的工具结果。
	DetachedToolResultAge time.Duration
}

type RetentionReport struct {
	SessionsDeleted            int
	CompletedGoalsDeleted      int
	DetachedToolResultsDeleted int
}

type RoleType string

type RunConfig struct {
	// ModelOptions 会传给本次请求中的每次模型调用。
	ModelOptions []ModelOption
	// ToolOptions 会传给本次请求中的每次工具调用。
	ToolOptions []ToolOption
	// Values 可用于 SystemPrompt 的 {name} 占位符，也可在工具和中间件中通过 RunValue 读取。
	Values map[string]any
}

type RunResult struct {
	Response         *schema.Message   // 本次执行最后一条 assistant 消息；可能为 nil
	Messages         []*schema.Message // 本次执行新增的完整消息
	Text             string            // Response.Content 的便捷访问
	ReasoningContent string            // Response.ReasoningContent 的便捷访问
	FinishReason     string            // Response.ResponseMeta.FinishReason 的便捷访问
	Usage            *TokenUsage       // 本次执行所有模型调用的累计 token 用量
	ToolCalls        []ToolCall        // 本次执行请求的全部工具调用
	Interrupts       []InterruptPoint  // 当前等待 Resume 的中断点
}

type RunStream struct {
	// contains filtered or unexported fields
}

type Session struct {
	SessionMetadata
	ID                string            `json:"id"`
	CreatedAt         time.Time         `json:"created_at"`
	UpdatedAt         time.Time         `json:"updated_at"`
	Messages          []*schema.Message `json:"messages"`                     // 未删减的完整对话
	Context           []*schema.Message `json:"context,omitempty"`            // 压缩后的模型上下文；nil 表示与 Messages 相同
	CheckpointID      string            `json:"checkpoint_id,omitempty"`      // 当前可恢复执行的检查点标识
	PendingInterrupts []InterruptPoint  `json:"pending_interrupts,omitempty"` // 等待 Resume 的中断点
	Archived          bool              `json:"archived,omitempty"`           // 归档后不可再运行，但仍可查询和恢复
	Revision          uint64            `json:"revision"`                     // 乐观并发控制版本
}

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

type SessionConfig struct {
	ID    string       // 在存储中唯一且稳定的会话标识
	Store SessionStore // 会话存储
}

type SessionInfo struct {
	SessionMetadata
	ID                    string    `json:"id"`
	CreatedAt             time.Time `json:"created_at"`
	UpdatedAt             time.Time `json:"updated_at"`
	MessageCount          int       `json:"message_count"`
	ContextMessageCount   int       `json:"context_message_count"`
	PendingInterruptCount int       `json:"pending_interrupt_count"`
	Archived              bool      `json:"archived,omitempty"`
	Revision              uint64    `json:"revision"`
}

type SessionManager struct {
	// contains filtered or unexported fields
}

type SessionManagerConfig struct {
	Store        SessionStore
	AgentConfig  *Config
	AgentFactory SessionAgentFactory
	OwnerID      string
	IDGenerator  func() string
}

type SessionMetadata struct {
	Title   string   `json:"title,omitempty"`
	OwnerID string   `json:"owner_id,omitempty"`
	Tags    []string `json:"tags,omitempty"`
}

type SessionPage struct {
	Sessions   []SessionInfo `json:"sessions"`
	NextCursor string        `json:"next_cursor,omitempty"`
}

type SessionQuery struct {
	OwnerID  string
	Tags     []string
	Archived *bool
	Limit    int
	Cursor   string
}

type SessionQueryStore interface {
	QuerySessions(ctx context.Context, query SessionQuery) (SessionPage, error)
}

type SessionStore interface {
	Load(ctx context.Context, id string) (*Session, error)
	Save(ctx context.Context, session *Session) error
	Delete(ctx context.Context, id string) error
	List(ctx context.Context) ([]SessionInfo, error)
}

type Skill = einoskill.Skill

type SkillBackend = einoskill.Backend

type SkillInfo = einoskill.FrontMatter

type SkillsConfig struct {
	Paths    []string
	Backend  SkillBackend
	ToolName string // 模型用于加载技能的工具名称，默认 "skill"
}

type State struct {
	// contains filtered or unexported fields
}

type StoredToolResult struct {
	ID        string    `json:"id"`
	SessionID string    `json:"session_id,omitempty"` // 为空表示不随会话自动删除
	Content   string    `json:"content"`
	CreatedAt time.Time `json:"created_at"`
}

type StreamToolOutput = compose.StreamToolOutput

type StreamableToolEndpoint = compose.StreamableToolEndpoint

type StreamableToolMiddleware = compose.StreamableToolMiddleware

type SubAgentConfig struct {
	Name         string
	Description  string
	SystemPrompt string

	// Model 为空时继承父 Agent 的模型。
	Model ChatModel
	// Tools 只属于当前子 Agent；父 Agent 的工具不会自动继承。
	Tools      []Tool
	ToolPolicy *ToolPolicy
	Handlers   []ChatModelAgentMiddleware

	// ModelRetryConfig 与 ModelFailoverConfig 为空时继承父 Agent 的策略。
	ModelRetryConfig    *ModelRetryConfig
	ModelFailoverConfig *ModelFailoverConfig
	MaxIterations       int

	Skills     *SkillsConfig
	MCP        *MCPConfig
	ToolSearch *ToolSearchConfig

	// IncludeHistory 显式允许把父 Agent 的聊天历史改写后交给子 Agent。
	// 默认 false，只传递本次委派请求以保持上下文隔离。
	IncludeHistory bool
}

type SubAgentPolicy struct {
	MaxDelegations int
	MaxParallel    int
	Timeout        time.Duration
}

type Subscriber func(Event)

type TokenUsage = schema.TokenUsage

type Tool = tool.BaseTool

type ToolAlias struct {
	Names     []string            // 工具名称别名
	Arguments map[string][]string // canonical argument -> aliases
}

type ToolCall = schema.ToolCall

type ToolInput = compose.ToolInput

type ToolInvocation struct {
	// Name 是解析别名后的正式工具名。
	Name string
	// Arguments 是传给工具的 JSON 参数。
	Arguments string
	// CallID 是模型生成的工具调用 ID。
	CallID string
}

type ToolMiddleware = compose.ToolMiddleware

type ToolOption = tool.Option

type ToolOutcome struct {
	// Err 是工具或保护策略返回的错误。
	Err error
	// Truncated 表示文本结果是否因超过上限而被截断。
	Truncated bool
	// OutputChars 是最终保留的原始文本字符数，不包含截断提示。
	OutputChars int
	// Duration 是从前置钩子开始到工具结果处理完成的耗时。
	Duration time.Duration
}

type ToolOutput = compose.ToolOutput

type ToolPolicy struct {
	Aliases          map[string]ToolAlias
	UnknownTool      func(ctx context.Context, name, arguments string) (string, error)
	RewriteArguments func(ctx context.Context, name, arguments string) (string, error)
	Sequential       bool
	// Timeout 限制单次工具调用（含钩子）的最长执行时间。零值表示不限制。
	Timeout time.Duration
	// MaxResultChars 限制返回给模型的文本字符数。零值使用 DefaultToolResultMaxChars，-1 表示不限制。
	MaxResultChars int
	// BeforeTool 在工具执行前调用；返回错误可拒绝本次调用。
	BeforeTool func(ctx context.Context, call ToolInvocation) error
	// AfterTool 在工具结束后调用，可用于审计和指标记录。
	AfterTool   func(ctx context.Context, call ToolInvocation, outcome ToolOutcome)
	Middlewares []ToolMiddleware
}

type ToolReductionConfig struct {
	Store ToolResultStore
	// MaxResultBytes 是单个工具结果触发卸载的字节数，默认 50,000。
	MaxResultBytes int
	// MaxContextTokens 是开始清理旧工具轮次的上下文 token 估算值，默认 160,000。
	MaxContextTokens int64
	// KeepRecentToolRounds 是清理时原样保留的最近工具调用轮数，默认 1。
	KeepRecentToolRounds int
}

type ToolResultInfo struct {
	ID        string    `json:"id"`
	SessionID string    `json:"session_id,omitempty"`
	Size      int       `json:"size"` // Content 的字节数
	CreatedAt time.Time `json:"created_at"`
}

type ToolResultStore interface {
	Load(ctx context.Context, id string) (*StoredToolResult, error)
	Save(ctx context.Context, result *StoredToolResult) error
	Delete(ctx context.Context, id string) error
	List(ctx context.Context) ([]ToolResultInfo, error)
}

type ToolResultStoreProvider interface {
	ToolResultStore() ToolResultStore
}

type ToolSearchConfig struct {
	Tools []Tool
	// UseModelNative 使用模型提供商原生的工具搜索协议。大多数模型保持 false 即可。
	UseModelNative bool
}