api

package

Go to main page

Versions in this module

v0

v0.8.1

Jun 27, 2026

v0.8.0

Jun 26, 2026

Changes in this version

type Agent

+ func NewAgent(name, systemPrompt string, toolNames []string, resolveFunc ToolResolveFunc) Agent

+ func (a *Agent) HasTools() bool

+ func (a *Agent) ToolBox() []ToolSpec

type Message

+ func (m *Message) IsToolCall() bool

+ type ToolResolveFunc func(names []string) ([]ToolSpec, error)

v0.7.0

Jun 13, 2026

Changes in this version

type Agent

+ func (a *Agent) HasFileSystemTool() bool

+ func (a *Agent) HasTool(name string) bool

type Message

+ func (m *Message) HasContent() bool

type MessageMeta

+ Tokens int

+ type PermissionMode int

+ const PermExec

+ const PermNone

+ const PermRead

+ const PermWrite

+ func ParsePermissionMode(s string) (PermissionMode, error)

+ func (m PermissionMode) String() string

+ type TokenCounter interface

+ CountTokens func(ctx context.Context, params RequestParameters, messages []Message) (int, error)

+ type ToolEnvelope struct

+ Call map[string]any

+ Tool ToolInfo

+ type ToolImpl func(ctx context.Context, tool *ToolSpec, args map[string]any) (string, error)

+ type ToolInfo struct

+ Config map[string]any

+ Description string

+ Environment map[string]string

+ Name string

type ToolPermission

+ func ParseToolPermission(s string) ToolPermission

+ type ToolPermissionCheck struct

+ NeedsConfirm bool

+ ToolCall ToolCall

+ func CheckToolPermissions(toolCalls []ToolCall, toolbox []ToolSpec, mode PermissionMode) []ToolPermissionCheck

type ToolSpec

+ Config any

+ Environment []string

+ ExecPath string

+ InProcess bool

v0.6.3

May 7, 2026

v0.6.2

May 4, 2026

Changes in this version

type Chunk

+ Kind ChunkKind

+ Text string

+ type ChunkKind int

+ const ChunkContent

+ const ChunkThinking

+ const ChunkToolUse

v0.6.1

Apr 30, 2026

v0.6.0

Apr 29, 2026

v0.5.1

Apr 24, 2026

Changes in this version

+ func ExtractText(parts []ContentPart) string

+ func ExtractThinking(parts []ContentPart) string

+ type Agent struct

+ Code bool

+ Name string

+ SystemPrompt string

+ Toolbox []ToolSpec

+ type ChatCompletionProvider interface

+ CreateChatCompletion func(ctx context.Context, params RequestParameters, messages []Message) (*Message, error)

+ CreateChatCompletionStream func(ctx context.Context, params RequestParameters, messages []Message, ...) (*Message, error)

+ type Chunk struct

+ Content string

+ ReasoningContent string

+ TokenCount uint

+ type ContentPart struct

+ Data []byte

+ MIMEType string

+ Text string

+ Type ContentPartType

+ func BuildContentParts(content, reasoning string) []ContentPart

+ func NewImagePart(mimeType string, data []byte) ContentPart

+ func NewTextPart(text string) ContentPart

+ func NewThinkingPart(text string) ContentPart

+ type ContentPartType string

+ const ContentPartImage

+ const ContentPartText

+ const ContentPartThinking

+ type Event struct

+ Chunk Chunk

+ Error error

+ Message *Message

+ ToolCalls []ToolCall

+ ToolResults []ToolResult

+ Type EventType

+ type EventType int

+ const EventChunk

+ const EventError

+ const EventResponseComplete

+ const EventToolCallsRequested

+ const EventToolResults

+ type Items struct

+ Type string

+ type Message struct

+ Metadata MessageMeta

+ Parts []ContentPart

+ Role MessageRole

+ ToolCalls []ToolCall

+ ToolResults []ToolResult

+ func NewMessageWithAssistant(content string, reasoning string) *Message

+ func NewMessageWithToolCalls(content string, toolCalls []ToolCall) *Message

+ func (m *Message) TextContent() string

+ func (m *Message) ThinkingContent() string

+ type MessageBuilder struct

+ func NewMessageBuilder(role MessageRole) *MessageBuilder

+ func (b *MessageBuilder) AppendContent(chunk string)

+ func (b *MessageBuilder) AppendReasoning(chunk string)

+ func (b *MessageBuilder) Build() *Message

+ func (b *MessageBuilder) InitFromParts(parts []ContentPart)

+ func (b *MessageBuilder) Parts() []ContentPart

+ func (b *MessageBuilder) Reset()

+ type MessageMeta struct

+ GenerationModel *string

+ GenerationProvider *string

+ ReasoningDetails json.RawMessage

+ ThinkingSignature *string

+ TimeToFirstToken *time.Duration

+ TotalDuration *time.Duration

+ func (m *MessageMeta) Scan(value any) error

+ func (m MessageMeta) Value() (driver.Value, error)

+ type MessageRole string

+ const MessageRoleAssistant

+ const MessageRoleSystem

+ const MessageRoleToolCall

+ const MessageRoleToolResult

+ const MessageRoleUser

+ func (m MessageRole) FriendlyRole() string

+ func (m MessageRole) IsAssistant() bool

+ func (m MessageRole) IsSystem() bool

+ func (m MessageRole) IsUser() bool

+ type Model struct

+ MaxTokens *int

+ Name string

+ Provider *Provider

+ Temperature *float32

+ type Provider struct

+ Client ChatCompletionProvider

+ Display string

+ Models []Model

+ Name string

+ type ReasoningEffort string

+ const High

+ const Low

+ const Medium

+ const Minimal

+ const None

+ const XHigh

+ type RequestParameters struct

+ Agent *Agent

+ Effort ReasoningEffort

+ MaxTokens int

+ Model *Model

+ Temperature float32

+ func NewRequestParameters(model *Model, agent *Agent, effort ReasoningEffort, temperature float32, ...) RequestParameters

+ type ToolCall struct

+ ID string

+ Name string

+ Parameters map[string]any

+ type ToolConfirmation struct

+ Approved bool

+ Reason string

+ type ToolParameter struct

+ Description string

+ Enum []string

+ Items *Items

+ Name string

+ Required bool

+ Type string

+ type ToolPermission string

+ const ToolPermExec

+ const ToolPermRead

+ const ToolPermWrite

+ type ToolResult struct

+ Result string

+ ToolCallID string

+ ToolName string

+ type ToolSpec struct

+ Description string

+ Impl func(*ToolSpec, map[string]any) (string, error)

+ Name string

+ Parameters []ToolParameter

+ Permission ToolPermission

v0.5.0

Apr 19, 2026

v0.4.0

Apr 11, 2026

v0.3.0

Apr 7, 2026

v0.2.0

Apr 4, 2026

v0.1.1

Apr 2, 2026

v0.1.0

Apr 2, 2026

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