pi

package module

Go to main page

Versions in this module

v0

v0.12.0

Aug 18, 2026

v0.11.0

Aug 10, 2026

Changes in this version

+ var ErrNothingToResume = errors.New("nothing to resume")

type Agent

+ func (a *Agent) Resume(ctx context.Context, opts PromptOpts) (*EventStream, error)

type PromptResult

+ Suspended bool

type ToolResult

+ Suspend bool

v0.10.0

Aug 9, 2026

Changes in this version

type Message

+ func NewTextWithSignature(role, text string, thoughtSignature []byte) Message

+ func NewThinkingWithSignature(role, text string, thoughtSignature []byte) Message

+ func (m Message) TextThoughtSignature() []byte

+ func (m Message) ThinkingText() string

+ func (m Message) ThinkingThoughtSignature() []byte

+ func (m Message) Usage() *Usage

+ func (m Message) WithUsage(u Usage) Message

type TextDeltaEvent

+ ThoughtSignature []byte

type ThinkingDeltaEvent

+ ThoughtSignature []byte

v0.9.0

Jul 26, 2026

Changes in this version

type BranchSummary

+ Usage *Usage

+ type Usage struct

+ InputTokens int

+ OutputTokens int

v0.8.0

Jul 25, 2026

Changes in this version

type Message

+ Images []llm.ImageContent

+ func NewToolResultMsg(callID, toolName string, result ToolResult) Message

type Tool

+ ExecuteStream func(ctx context.Context, params P, emit func(ToolResult)) (ToolResult, error)

type ToolResult

+ Images []llm.ImageContent

+ type ToolUpdateEvent struct

+ CallID string

+ Name string

+ Result ToolResult

v0.7.0

Jul 22, 2026

Changes in this version

+ const DefaultSummarizationRetryBaseDelay

+ const DefaultSummarizationRetryMaxDelay

type AgentConfig

+ SummarizationRetry SummarizationRetryPolicy

type Hooks

+ OnSummarizationRetry func(ctx context.Context, c SummarizationRetryCtx)

+ type SummarizationRetryCtx struct

+ Attempt int

+ Delay time.Duration

+ Err error

+ MaxAttempts int

+ Phase SummarizationRetryPhase

+ Success bool

+ type SummarizationRetryPhase int

+ const SummarizationRetryAttemptStart

+ const SummarizationRetryFinished

+ const SummarizationRetryScheduled

+ type SummarizationRetryPolicy struct

+ BaseDelay time.Duration

+ MaxDelay time.Duration

+ MaxRetries int

v0.6.3

Jul 4, 2026

Changes in this version

type ToolCallStartEvent

+ ThoughtSignature []byte

v0.6.2

Jul 4, 2026

v0.6.1

Jul 4, 2026

Changes in this version

type CompactOpts

+ SessionID SessionID

v0.6.0

Jul 2, 2026

Changes in this version

type Message

+ func NewToolCallWithSignature(role string, callID, toolName string, args json.RawMessage, ...) Message

+ func (m Message) ToolCallThoughtSignature() []byte

v0.5.0

Jun 28, 2026

v0.4.0

Jun 27, 2026

Changes in this version

+ const SummarizationPrompt

+ const SummarizationSystemPrompt

+ const TurnPrefixSummarizationPrompt

+ const UpdateSummarizationPrompt

+ var DefaultCompactionSettings = CompactionSettings

+ var ErrAgentBusy = errors.New("agent is busy")

+ var ErrAgentStopped = errors.New("prompt stopped by caller")

+ var ErrCompactFailed = errors.New("compaction failed")

+ var ErrDuplicateToolName = errors.New("duplicate tool name")

+ var ErrInvalidModel = errors.New("invalid model")

+ var ErrInvalidModelRef = errors.New("invalid model reference")

+ var ErrNoPromptInFlight = errors.New("no prompt in flight")

+ var ErrPromptCancelled = errors.New("prompt cancelled by caller context")

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

+ var ErrToolLeaked = errors.New("tool execution leaked goroutine")

+ var ErrToolNotFound = errors.New("tool not found")

+ var ErrUnknownActiveTool = errors.New("active tool not registered")

+ var ErrUnsupportedFeature = errors.New("unsupported feature")

+ func DefaultConvertToLLM(messages []Message) []llm.Message

+ func EstimateTokens(messages []Message) int

+ func NewSessionID() string

+ func ShouldCompact(contextTokens, contextWindow int, settings CompactionSettings) bool

+ type AfterCompactCtx struct

+ BranchSummary BranchSummary

+ SessionID SessionID

+ type AfterProviderResponseCtx struct

+ Headers map[string]string

+ Model string

+ Provider string

+ StatusCode int

+ type AfterToolCallCtx struct

+ CallID string

+ Result ToolResult

+ ToolName string

+ type AfterTurnCtx struct

+ HadToolCalls bool

+ Turn int

+ type Agent struct

+ func NewAgent(cfg AgentConfig) (*Agent, error)

+ func (a *Agent) Close() error

+ func (a *Agent) Compact(ctx context.Context, opts CompactOpts) (*CompactResult, error)

+ func (a *Agent) Context() context.Context

+ func (a *Agent) FollowUp(ctx context.Context, m Message) error

+ func (a *Agent) Phase() AgentPhase

+ func (a *Agent) Prompt(ctx context.Context, msg Message, opts PromptOpts) (*EventStream, error)

+ func (a *Agent) SetActiveTools(ctx context.Context, names []string) error

+ func (a *Agent) SetModel(model string)

+ func (a *Agent) SetSkills(skills []Skill)

+ func (a *Agent) SetSystemPrompt(prompt string)

+ func (a *Agent) SetThinkingLevel(level llm.ThinkingLevel)

+ func (a *Agent) SetTools(tools []RegisteredTool) error

+ func (a *Agent) State() AgentState

+ func (a *Agent) Steer(ctx context.Context, m Message) error

+ func (a *Agent) Stop()

+ func (a *Agent) Transcript() []Message

+ type AgentConfig struct

+ ActiveToolNames []string

+ ConvertToLLM ConvertToLLMFn

+ DefaultModel string

+ DefaultThinking llm.ThinkingLevel

+ EventBufferSize int

+ Hooks Hooks

+ KeepRecentTokens int

+ MaxParallelTools int

+ Providers []llm.LLMProvider

+ ReserveTokens int

+ Session SessionRepo

+ ShutdownTimeout time.Duration

+ Skills []Skill

+ SteerBufferSize int

+ SystemPrompt string

+ ThinkingBudgets map[llm.ThinkingLevel]int

+ ToolExecution ToolExecutionMode

+ Tools []RegisteredTool

+ Transport llm.TransportPreference

+ type AgentEndEvent struct

+ Messages []Message

+ type AgentEvent interface

+ type AgentPhase int

+ const PhaseCompacting

+ const PhaseDone

+ const PhaseExecutingTools

+ const PhaseIdle

+ const PhaseShuttingDown

+ const PhaseWaitingLLM

+ type AgentStartEvent struct

+ type AgentState struct

+ ActiveModel string

+ LastActivityAt time.Time

+ LastError error

+ LastEvent AgentEvent

+ PendingToolCalls []PendingToolCall

+ Phase AgentPhase

+ SessionID SessionID

+ StartedAt time.Time

+ Thinking llm.ThinkingLevel

+ TranscriptLen int

+ TurnNumber int

+ type BeforeAgentStartCtx struct

+ PromptOpts PromptOpts

+ type BeforeCompactCtx struct

+ CutPoint int

+ SessionID SessionID

+ type BeforeProviderRequestCtx struct

+ Headers map[string]string

+ Model string

+ Provider string

+ type BeforeToolCallCtx struct

+ Args []byte

+ CallID string

+ ToolName string

+ type BranchSummary struct

+ CreatedAt time.Time

+ EndIdx int

+ StartIdx int

+ Summary string

+ type CompactOpts struct

+ KeepRecentTokens int

+ type CompactResult struct

+ RemovedCount int

+ Summary BranchSummary

+ type CompactionEndEvent struct

+ type CompactionSettings struct

+ Enabled bool

+ KeepRecentTokens int

+ ReserveTokens int

+ type CompactionStartEvent struct

+ type ConfigField string

+ const ConfigFieldActiveTools

+ const ConfigFieldModel

+ const ConfigFieldSkills

+ const ConfigFieldSystemPrompt

+ const ConfigFieldThinkingLevel

+ const ConfigFieldTools

+ type ConfigUpdateCtx struct

+ Field ConfigField

+ NewActiveTools []string

+ NewModel string

+ NewSkills []Skill

+ NewSystemPrompt string

+ NewThinkingLevel llm.ThinkingLevel

+ NewTools []RegisteredTool

+ OldActiveTools []string

+ OldModel string

+ OldSkills []Skill

+ OldSystemPrompt string

+ OldThinkingLevel llm.ThinkingLevel

+ OldTools []RegisteredTool

+ type ConvertToLLMFn func(messages []Message) []llm.Message

+ type DynamicToolOption func(*dynamicTool)

+ func WithPrepareArguments(fn PrepareArgumentsFunc) DynamicToolOption

+ type EventStream struct

+ Done <-chan PromptResult

+ Events <-chan AgentEvent

+ type FollowUpInjectedEvent struct

+ Message Message

+ type Hooks struct

+ AfterCompact func(ctx context.Context, c AfterCompactCtx) error

+ AfterProviderResponse func(ctx context.Context, c AfterProviderResponseCtx)

+ AfterToolCall func(ctx context.Context, c AfterToolCallCtx) error

+ BeforeAgentStart func(ctx context.Context, c BeforeAgentStartCtx) error

+ BeforeCompact func(ctx context.Context, c BeforeCompactCtx) error

+ BeforeProviderRequest func(ctx context.Context, c BeforeProviderRequestCtx) error

+ BeforeToolCall func(ctx context.Context, c BeforeToolCallCtx) error

+ OnConfigUpdate func(ConfigUpdateCtx)

+ ShouldStopAfterTurn func(ctx context.Context, c AfterTurnCtx) bool

+ TransformContext func(ctx context.Context, c TransformContextCtx) ([]Message, error)

+ type LLMErrorEvent struct

+ Error error

+ Transient bool

+ type LLMRetryEvent struct

+ Attempt int

+ Model string

+ NextDelay int64

+ Provider string

+ Reason string

+ ServerHint bool

+ type Message struct

+ Body json.RawMessage

+ Role string

+ Type string

+ func BuildLLMContext(transcript []Message, summaries []BranchSummary) []Message

+ func NewActiveToolsChange(names []string) Message

+ func NewBranchSummaryMessage(summary string) Message

+ func NewSystem(text string) Message

+ func NewText(role, text string) Message

+ func NewThinking(role, text string) Message

+ func NewToolCall(role string, callID, toolName string, args json.RawMessage) Message

+ func NewToolResult(role string, callID, toolName, content string, data json.RawMessage, ...) Message

+ func (m Message) ActiveToolNames() (names []string, ok bool)

+ func (m Message) Text() string

+ func (m Message) ToolCall() (callID, toolName string, args json.RawMessage, ok bool)

+ func (m Message) ToolResult() (callID, toolName, content string, data json.RawMessage, isError bool, ok bool)

+ type MessageEndEvent struct

+ Message Message

+ type MessageStartEvent struct

+ MessageType string

+ Role string

+ type PendingToolCall struct

+ CallID string

+ ToolName string

+ type PrepareArgumentsFunc func(ctx context.Context, raw json.RawMessage) (json.RawMessage, error)

+ type PromptOpts struct

+ Model string

+ ProviderHints llm.ProviderHints

+ SessionID SessionID

+ SystemPrompt string

+ Thinking llm.ThinkingLevel

+ type PromptResult struct

+ Err error

+ Messages []Message

+ type RegisteredTool interface

+ Description func() string

+ Execute func(ctx context.Context, callID string, args json.RawMessage) (ToolResult, error)

+ IsSequential func() bool

+ Name func() string

+ Schema func() json.RawMessage

+ func NewDynamicTool(name, description string, schema json.RawMessage, ...) RegisteredTool

+ func NewTool[P any](t Tool[P]) RegisteredTool

+ type SessionID string

+ type SessionMeta struct

+ CreatedAt time.Time

+ ID SessionID

+ UpdatedAt time.Time

+ type SessionRepo interface

+ Append func(ctx context.Context, id SessionID, msgs ...Message) error

+ AppendBranchSummary func(ctx context.Context, id SessionID, summary BranchSummary) error

+ Create func(ctx context.Context) (SessionID, error)

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

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

+ Load func(ctx context.Context, id SessionID) ([]Message, error)

+ LoadBranchSummaries func(ctx context.Context, id SessionID) ([]BranchSummary, error)

+ type Skill struct

+ Content string

+ Description string

+ DisableModelInvocation bool

+ FilePath string

+ Name string

+ type SteerInjectedEvent struct

+ Message Message

+ type TextDeltaEvent struct

+ Delta string

+ type ThinkingDeltaEvent struct

+ Delta string

+ type ThinkingUnsupportedEvent struct

+ Model string

+ Provider string

+ Reason string

+ Requested string

+ type Tool struct

+ Description string

+ Execute func(ctx context.Context, params P) (ToolResult, error)

+ Name string

+ PrepareArguments PrepareArgumentsFunc

+ Sequential bool

+ type ToolCallEndEvent struct

+ CallID string

+ Result ToolResult

+ ToolName string

+ type ToolCallStartEvent struct

+ Args []byte

+ CallID string

+ ToolName string

+ type ToolErrorEvent struct

+ CallID string

+ Error error

+ ToolName string

+ type ToolExecutionMode int

+ const ToolExecParallel

+ const ToolExecSequential

+ type ToolLeakEvent struct

+ CallID string

+ Duration int64

+ ToolName string

+ type ToolResult struct

+ Content string

+ Data json.RawMessage

+ IsError bool

+ Terminate bool

+ type TransformContextCtx struct

+ Messages []Message

+ type TurnEndEvent struct

+ Turn int

+ type TurnStartEvent struct

+ Turn int

+ type UserMessageEvent struct

+ Message Message

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