types

Documentation

Overview

Package types 定义 GoCoder 全部共享类型

Index

• func Now() int64
• type AgentConfig
  • func NewAgentConfig() AgentConfig
• type AgentState
  • func (s AgentState) String() string
• type AppConfig
• type ChatRequest
• type ChatResponse
• type ChatStreamChunk
• type Choice
• type CompactEvent
• type Delta
• type EventType
• type FunctionCall
• type FunctionSchema
• type JSONRPCError
• type JSONRPCRequest
• type JSONRPCResponse
• type MCPConfig
• type MCPToolDefinition
• type Message
• type MessageEvent
• type ModelConfig
• type PermissionDecision
• type PermissionEvent
• type PermissionRequest
• type Preferences
• type RegisteredTool
• type SessionEvent
• type StreamCallback
• type StreamChoice
• type ToolCall
• type ToolCallEvent
• type ToolContext
• type ToolDefinition
• type ToolExecutor
• type ToolOutput
• type ToolResultEvent
• type ToolStatusCallback
• type Usage

Functions

func Now

func Now() int64

Now 返回当前 Unix 时间戳

Types

type AgentConfig

type AgentConfig struct {
	MaxToolRounds      int     // 最大工具调用轮数，默认 15
	CompactThreshold   float64 // token 用量触发 compact 的阈值，默认 0.7
	ForceSnipThreshold float64 // token 用量强制 snip 的阈值，默认 0.9
	MaxOutputPreview   int     // 大工具输出在上下文中保留的预览长度，默认 2000
	MaxOutputDisk      int     // 触发落盘的输出长度阈值，默认 5000
	WorkDir            string  // 工作目录
	ModelMaxTokens     int     // 模型上下文窗口大小
}

AgentConfig agent 运行时配置

func NewAgentConfig

func NewAgentConfig() AgentConfig

NewAgentConfig 返回带默认值的 AgentConfig

type AgentState

type AgentState int

AgentState agent 当前状态

const (
	StateIdle               AgentState = iota // 等待用户输入
	StateStreaming                            // LLM 正在流式返回
	StateExecuting                            // 正在执行工具
	StateAwaitingPermission                   // 等待用户审批
	StateError                                // 错误状态
)

func (AgentState) String

func (s AgentState) String() string

type AppConfig

type AppConfig struct {
	Model       ModelConfig          `yaml:"model"`
	Preferences Preferences          `yaml:"preferences"`
	MCPServers  map[string]MCPConfig `yaml:"mcp_servers"`
	Version     string               `yaml:"config_format_version"`
}

AppConfig 完整应用配置

type ChatRequest

type ChatRequest struct {
	Model       string           `json:"model"`
	Messages    []Message        `json:"messages"`
	Tools       []ToolDefinition `json:"tools,omitempty"`
	MaxTokens   int              `json:"max_tokens,omitempty"`
	Temperature float64          `json:"temperature,omitempty"`
	Stream      bool             `json:"stream"`
}

ChatRequest OpenAI-compatible 请求体

type ChatResponse

type ChatResponse struct {
	ID      string   `json:"id"`
	Object  string   `json:"object"`
	Model   string   `json:"model"`
	Usage   Usage    `json:"usage,omitempty"`
	Choices []Choice `json:"choices"`
}

ChatResponse 非流式响应

type ChatStreamChunk

type ChatStreamChunk struct {
	ID      string         `json:"id"`
	Object  string         `json:"object"`
	Model   string         `json:"model"`
	Choices []StreamChoice `json:"choices"`
	Usage   *Usage         `json:"usage,omitempty"` // 某些 provider 在最后一个 chunk 返回 usage
}

ChatStreamChunk SSE 流式响应的单个 chunk

type Choice

type Choice struct {
	Index        int     `json:"index"`
	Message      Message `json:"message"`
	FinishReason string  `json:"finish_reason"`
}

Choice 非流式 choice

type CompactEvent

type CompactEvent struct {
	Method        string `json:"method"`         // snip / model_compact
	CollapsedSpan []int  `json:"collapsed_span"` // [start_idx, end_idx]
	Summary       string `json:"summary,omitempty"`
}

CompactEvent 压缩事件载荷

type Delta

type Delta struct {
	Role      string     `json:"role,omitempty"`
	Content   string     `json:"content,omitempty"`
	ToolCalls []ToolCall `json:"tool_calls,omitempty"`
}

Delta 流式增量内容

type EventType

type EventType string

EventType 会话事件类型枚举

const (
	EventMessage      EventType = "message"
	EventToolCall     EventType = "tool_call"
	EventToolResult   EventType = "tool_result"
	EventPermission   EventType = "permission"
	EventCompact      EventType = "compact"
	EventError        EventType = "error"
	EventSessionStart EventType = "session_start"
)

type FunctionCall

type FunctionCall struct {
	Name      string `json:"name"`
	Arguments string `json:"arguments"` // JSON 编码的参数
}

FunctionCall 工具调用的函数名和参数

type FunctionSchema

type FunctionSchema struct {
	Name        string         `json:"name"`
	Description string         `json:"description"`
	Parameters  map[string]any `json:"parameters"`
}

FunctionSchema JSON Schema for a function tool

type JSONRPCError

type JSONRPCError struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}

JSONRPCError JSON-RPC 错误

type JSONRPCRequest

type JSONRPCRequest struct {
	JSONRPC string          `json:"jsonrpc"`
	ID      int             `json:"id"`
	Method  string          `json:"method"`
	Params  json.RawMessage `json:"params,omitempty"`
}

JSONRPCRequest JSON-RPC 2.0 请求

type JSONRPCResponse

type JSONRPCResponse struct {
	JSONRPC string          `json:"jsonrpc"`
	ID      int             `json:"id"`
	Result  json.RawMessage `json:"result,omitempty"`
	Error   *JSONRPCError   `json:"error,omitempty"`
}

JSONRPCResponse JSON-RPC 2.0 响应

type MCPConfig

type MCPConfig struct {
	Name    string            `json:"name"`
	Command string            `json:"command"`
	Args    []string          `json:"args"`
	Env     map[string]string `json:"env,omitempty"`
	URL     string            `json:"url,omitempty"` // HTTP 模式时的 URL
}

MCPConfig MCP server 配置

type MCPToolDefinition

type MCPToolDefinition struct {
	Name        string         `json:"name"`
	Description string         `json:"description"`
	InputSchema map[string]any `json:"inputSchema"`
}

MCPToolDefinition MCP 服务端返回的工具定义

type Message

type Message struct {
	Role       string     `json:"role"`                   // system/user/assistant/tool
	Content    string     `json:"content,omitempty"`      // 文本内容（可为空，当 tool_calls 存在时）
	ToolCalls  []ToolCall `json:"tool_calls,omitempty"`   // assistant 的工具调用
	ToolCallID string     `json:"tool_call_id,omitempty"` // tool 角色时关联的 call id
	Name       string     `json:"name,omitempty"`         // tool 名称（tool 角色时可选）
}

Message 对话消息，兼容 OpenAI Chat Completion 格式

type MessageEvent

type MessageEvent struct {
	Role    string `json:"role"`
	Content string `json:"content"`
}

MessageEvent 消息事件载荷

type ModelConfig

type ModelConfig struct {
	Name       string `yaml:"name"`
	Endpoint   string `yaml:"endpoint"`
	AuthEnvVar string `yaml:"auth_env_var"`
	MaxTokens  int    `yaml:"max_tokens"`
}

ModelConfig 单个模型配置

type PermissionDecision

type PermissionDecision string

PermissionDecision 权限决策

const (
	PermAllow    PermissionDecision = "allow"
	PermDeny     PermissionDecision = "deny"
	PermAllowAll PermissionDecision = "allow_all" // 本次会话始终允许该工具
	PermDenyAll  PermissionDecision = "deny_all"  // 本次会话始终拒绝该工具
)

type PermissionEvent

type PermissionEvent struct {
	CallID   string `json:"call_id"`
	ToolName string `json:"tool_name"`
	Decision string `json:"decision"` // allow / deny
}

PermissionEvent 权限审批事件载荷

type PermissionRequest

type PermissionRequest struct {
	CallID      string `json:"call_id"`
	ToolName    string `json:"tool_name"`
	Description string `json:"description"`       // 人类可读的操作描述
	Diff        string `json:"diff,omitempty"`    // 文件修改时附带 diff
	Command     string `json:"command,omitempty"` // shell 命令时附带完整命令
	RiskLevel   string `json:"risk_level"`
}

PermissionRequest 权限审批请求

type Preferences

type Preferences struct {
	MaxToolRounds    int     `yaml:"max_tool_rounds"`
	CompactThreshold float64 `yaml:"compact_threshold"`
	ProjectDir       string  `yaml:"project_dir"`
}

Preferences 用户偏好设置

type RegisteredTool

type RegisteredTool struct {
	Definition       ToolDefinition
	Executor         ToolExecutor
	RequiresApproval bool   // 是否需要用户审批
	RiskLevel        string // "readonly" / "write" / "shell"
}

RegisteredTool 内部注册的工具（包含执行器和元数据）

type SessionEvent

type SessionEvent struct {
	Type      EventType `json:"type"`
	Timestamp int64     `json:"ts"`
	Data      any       `json:"data"` // 具体事件载荷
}

SessionEvent JSONL 会话中的单个事件

type StreamCallback

type StreamCallback func(content string, done bool, err error)

StreamCallback 流式输出回调 content 是累积的全部文本，done 表示是否结束，err 是可能的错误

type StreamChoice

type StreamChoice struct {
	Index        int    `json:"index"`
	Delta        Delta  `json:"delta"`
	FinishReason string `json:"finish_reason,omitempty"`
}

StreamChoice 流式 choice

type ToolCall

type ToolCall struct {
	Index    int          `json:"index,omitempty"` // 流式响应中的工具调用序号
	ID       string       `json:"id"`
	Type     string       `json:"type"` // "function"
	Function FunctionCall `json:"function"`
}

ToolCall 表示 LLM 请求调用一个工具

type ToolCallEvent

type ToolCallEvent struct {
	CallID    string         `json:"call_id"`
	ToolName  string         `json:"tool_name"`
	Arguments map[string]any `json:"arguments"`
}

ToolCallEvent 工具调用事件载荷

type ToolContext

type ToolContext struct {
	WorkDir   string // 当前工作目录
	SessionID string // 当前会话 ID
}

ToolContext 工具执行的上下文

type ToolDefinition

type ToolDefinition struct {
	Type     string         `json:"type"` // "function"
	Function FunctionSchema `json:"function"`
}

ToolDefinition 工具定义，序列化为 OpenAI function schema

type ToolExecutor

type ToolExecutor func(ctx ToolContext, input map[string]any) (string, error)

ToolExecutor 工具执行函数签名 ctx 提供工具执行的上下文信息（工作目录、session 等） input 是模型传入的 JSON 参数，已解码为 map 返回工具执行结果字符串和可能的错误

type ToolOutput

type ToolOutput struct {
	ToolCallID string `json:"tool_call_id"`        // 关联的 tool_call id
	Name       string `json:"name"`                // 工具名称
	Output     string `json:"output"`              // 输出内容
	Truncated  bool   `json:"truncated"`           // 是否被截断
	DiskPath   string `json:"disk_path,omitempty"` // 完整输出落盘路径
}

ToolOutput 工具执行的输出结果

type ToolResultEvent

type ToolResultEvent struct {
	CallID    string `json:"call_id"`
	ToolName  string `json:"tool_name"`
	Output    string `json:"output"`
	Truncated bool   `json:"truncated"`
	DiskPath  string `json:"disk_path,omitempty"`
	Duration  int64  `json:"duration_ms"`
}

ToolResultEvent 工具结果事件载荷

type ToolStatusCallback

type ToolStatusCallback func(status string, toolName string, detail string)

ToolStatusCallback 工具执行状态回调

type Usage

type Usage struct {
	PromptTokens     int `json:"prompt_tokens"`
	CompletionTokens int `json:"completion_tokens"`
	TotalTokens      int `json:"total_tokens"`
}

Usage token 用量信息