baseAgent

package module

Go to main page

Versions in this module

v0

v0.7.0

Oct 27, 2026

Changes in this version

type AgentSession

+ func (s *AgentSession) GetAllTools() []ToolInfo

+ func (s *AgentSession) RegisterTool(tool agent.AgentTool[any, any]) error

+ func (s *AgentSession) SetActiveToolsByName(names []string) error

+ type ToolInfo struct

+ Annotations *agent.ToolAnnotations

+ Description string

+ Name string

+ Parameters map[string]any

v0.6.0

Oct 23, 2026

Changes in this version

+ const CredentialNamespace

+ var ErrNoAuth = errors.New("no auth configured")

+ func MarshalCredential(c *ai.Credential) ([]byte, error)

+ func ScopeAuthStore(store AuthStore, ownerID string) ai.CredentialStore

+ func UnmarshalCredential(data []byte) (*ai.Credential, error)

type AuthStore

+ Delete func(ctx context.Context, ownerID, namespace, name string) error

+ Get func(ctx context.Context, ownerID, namespace, name string) ([]byte, error)

+ List func(ctx context.Context, ownerID, namespace string) ([]string, error)

+ Modify func(ctx context.Context, ownerID, namespace, name string, ...) ([]byte, error)

type CreateAgentSessionOptions

+ AmbientAuth ai.AuthContext

+ Credentials ai.CredentialStore

type ModelRegistry

+ func (r *ModelRegistry) Auth(ctx context.Context, model ai.Model[ai.API]) (ai.ModelAuth, error)

+ func (r *ModelRegistry) CheckAuth(ctx context.Context, provider ai.Provider) (*ai.AuthCheck, error)

+ func (r *ModelRegistry) Login(ctx context.Context, provider ai.Provider, typ ai.CredentialType, ...) error

+ func (r *ModelRegistry) Logout(ctx context.Context, provider ai.Provider) error

+ type ModelRegistryOptions struct

+ AmbientAuth ai.AuthContext

+ Credentials ai.CredentialStore

+ Models map[ai.Provider]map[string]ai.Model[ai.API]

+ ProviderAuth map[ai.Provider]ai.ProviderAuth

v0.5.1

Oct 22, 2026

v0.5.0

Oct 22, 2026

v0.4.0

Oct 22, 2026

v0.3.1

Oct 2, 2026

v0.3.0

Oct 2, 2026

Changes in this version

+ const EntryTypeBranchSummary

+ const EntryTypeCompaction

+ const EntryTypeCustom

+ const EntryTypeCustomMessage

+ const EntryTypeLabel

+ const EntryTypeMessage

+ const EntryTypeModelChange

+ const EntryTypeSessionInfo

+ const EntryTypeThinkingLevelChange

+ const SUMMARIZATION_PROMPT

+ const SUMMARIZATION_SYSTEM_PROMPT

+ const TURN_PREFIX_SUMMARIZATION_PROMPT

+ const UPDATE_SUMMARIZATION_PROMPT

+ var DEFAULT_COMPACTION_SETTINGS = CompactionSettings

+ var ErrCompactionCancelled = errors.New("compaction cancelled")

+ var ErrNothingToCompact = errors.New("nothing to compact")

+ var ErrSessionConflict = errors.New("session changed by another writer")

+ var ErrSessionExists = errors.New("session already exists")

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

+ func CalculateContextTokens(usage ai.Usage) int64

+ func DecodeCompactionDetails[T any](raw json.RawMessage) (details T, ok bool, err error)

+ func EstimateContextTokens(messages []agent.AgentMessage) contextUsageEstimate

+ func EstimateTokens(message agent.AgentMessage) int64

+ func FindTurnStartIndex(entries []SessionEntry, entryIndex, startIndex int) int

+ func GenerateSummary(ctx context.Context, currentMessages []agent.AgentMessage, ...) (string, error)

+ func GetLastAssistantUsage(entries []SessionEntry) *ai.Usage

+ func MarshalSessionEntry(entry SessionEntry) ([]byte, error)

+ func RegisterMessageDecoder(role string, decoder MessageDecoder)

+ func ShouldTriggerCompaction(contextTokens int64, contextWindow int64, settings CompactionSettings) bool

+ func UnmarshalAgentMessage(data []byte) (agent.AgentMessage, error)

+ func UserMessageText(message ai.UserMessage) string

type AgentSession

+ func (s *AgentSession) AbortCompaction()

+ func (s *AgentSession) Compact(ctx context.Context, options *ManualCompactionOptions) (*CompactionResult, error)

+ func (s *AgentSession) GetCompactionSettings() CompactionSettings

+ func (s *AgentSession) IsCompacting() bool

+ func (s *AgentSession) SetCompactionHook(hook CompactionHook)

+ func (s *AgentSession) SetCompactionSettings(settings CompactionSettings)

+ func (s *AgentSession) Subscribe(listener AgentSessionEventListener) func()

+ type AgentSessionEvent interface

+ type AgentSessionEventListener func(event AgentSessionEvent)

+ type CompactFunc func(ctx context.Context, req CompactionRequest) (*CompactionResult, error)

+ type CompactOptions struct

+ CustomInstructions string

+ Headers map[string]string

+ Prompts SummaryPrompts

+ ThinkingLevel ai.ModelThinkingLevel

+ type CompactionEndEvent struct

+ Aborted bool

+ ErrorMessage string

+ Reason CompactionReason

+ RestoredMessages []agent.AgentMessage

+ Result *CompactionResult

+ Type string

+ WillRetry bool

+ func (CompactionEndEvent) EventType() string

+ type CompactionHook func(ctx context.Context, req CompactionRequest, next CompactFunc) (*CompactionResult, error)

+ type CompactionPreparation struct

+ FirstKeptEntryID string

+ IsSplitTurn bool

+ MessagesToSummarize []agent.AgentMessage

+ PreviousDetails json.RawMessage

+ PreviousSummary *string

+ Settings CompactionSettings

+ TokensBefore int64

+ TurnPrefixMessages []agent.AgentMessage

+ func PrepareCompaction(pathEntries []SessionEntry, settings CompactionSettings) *CompactionPreparation

+ type CompactionReason string

+ const CompactionReasonManual

+ const CompactionReasonOverflow

+ const CompactionReasonThreshold

+ type CompactionRequest struct

+ BranchEntries []SessionEntry

+ CustomInstructions string

+ Preparation *CompactionPreparation

+ Prompts SummaryPrompts

+ Reason CompactionReason

+ Session ReadonlySessionManager

+ type CompactionResult struct

+ Details any

+ FirstKeptEntryID string

+ Summary string

+ TokensBefore int64

+ func Compact(ctx context.Context, preparation *CompactionPreparation, ...) (*CompactionResult, error)

+ type CompactionSettings struct

+ Enabled bool

+ KeepRecentTokens int64

+ ReservedTokens int64

+ type CompactionStartEvent struct

+ Reason CompactionReason

+ Type string

+ func (CompactionStartEvent) EventType() string

type CreateAgentSessionOptions

+ CompactionHook CompactionHook

+ CompactionSettings *CompactionSettings

+ type CutPointResult struct

+ FirstKeptEntryIndex int

+ IsSplitTurn bool

+ TurnStartIndex int

+ func FindCutPoint(entries []SessionEntry, startIndex, endIndex int, keepRecentTokens int64) CutPointResult

+ type GenerateSummaryOptions struct

+ CustomInstructions string

+ Headers map[string]string

+ PreviousSummary string

+ Prompts SummaryPrompts

+ ThinkingLevel ai.ModelThinkingLevel

+ type LoadedSession struct

+ CurrentEntryID *string

+ Entries []SessionEntry

+ Header SessionHeader

+ type ManualCompactionOptions struct

+ CustomInstructions string

+ type MessageDecoder func(data []byte) (agent.AgentMessage, error)

+ type ReadonlySessionManager interface

+ BuildSessionContext func() SessionContext

+ GetBranch func(from ...string) []SessionEntry

+ GetBranches func() []SessionBranch

+ GetChildren func(parentID string) []SessionEntry

+ GetEntries func() []SessionEntry

+ GetEntry func(id string) SessionEntry

+ GetHeader func() *SessionHeader

+ GetLabel func(id string) *string

+ GetLeafEntry func() SessionEntry

+ GetLeafID func() *string

+ GetSessionID func() string

+ GetSessionName func() *string

+ GetTree func() []*SessionTreeNode

+ type SessionBranch struct

+ Active bool

+ BranchPointID *string

+ FirstEntryID string

+ FirstMessage string

+ Label *string

+ LeafID string

type SessionEntry

+ func UnmarshalSessionEntry(data []byte) (SessionEntry, error)

type SessionInfo

+ Metadata map[string]any

+ ParentSessionID *string

+ func BuildSessionInfo(header SessionHeader, entries []SessionEntry, modified time.Time) SessionInfo

+ func FindMostRecentSession(ctx context.Context, store SessionStore, metadata map[string]any) (*SessionInfo, error)

type SessionManager

+ func (s *SessionManager) BranchWithSummary(ctx context.Context, from *string, summary string, details any, fromHook *bool) (string, error)

+ func (s *SessionManager) Fork(ctx context.Context, leafID *string) (*SessionManager, error)

+ func (s *SessionManager) GetBranches() []SessionBranch

+ func (s *SessionManager) Reload(ctx context.Context) error

+ type SessionQuery struct

+ Limit int

+ Metadata map[string]any

type SessionStore

+ SetCurrentEntry func(ctx context.Context, sessionID string, expected, entryID *string) error

+ type SummaryPrompts struct

+ Initial string

+ System string

+ TurnPrefix string

+ Update string

+ func DefaultSummaryPrompts() SummaryPrompts

v0.2.0

Aug 21, 2026

v0.1.8

May 28, 2026

v0.1.7

May 27, 2026

Changes in this version

type CreateAgentSessionOptions

+ AfterToolCall func(ctx context.Context, call agent.AfterToolCallContext[any]) (*agent.AfterToolCallResult, error)

+ BeforeToolCall func(ctx context.Context, call agent.BeforeToolCallContext) (*agent.BeforeToolCallResult, error)

+ OnPayload func(payload any, model ai.Model[ai.API]) (any, error)

+ OnResponse func(response ai.ProviderResponse, model ai.Model[ai.API]) error

+ SystemPrompt *string

+ ToolExecutionMode *agent.ToolExecutionMode

+ Tools []agent.AgentTool[any, any]

v0.1.6

May 27, 2026

v0.1.5

May 26, 2026

v0.1.4

May 26, 2026

v0.1.3

May 23, 2026

Changes in this version

type SessionManager

+ func (s *SessionManager) AppendMessageWithID(ctx context.Context, id string, m agent.AgentMessage) (string, error)

v0.1.2

May 22, 2026

v0.1.1

May 22, 2026

v0.1.0

May 22, 2026

Changes in this version

+ const BranchSummaryPrefix

+ const BranchSummarySuffix

+ const CompactionSummaryPrefix

+ const CompactionSummarySuffix

+ const CurrentSessionVersion

+ const DefaultThinkingLevel

+ const MessageRoleBranchSummary

+ const MessageRoleCompactionSummary

+ const MessageRoleCustom

+ func ConvertToLLM(messages []agent.AgentMessage) []ai.Message

+ func FindInitialModel(registry *ModelRegistry) (ai.Model[ai.API], bool)

+ type AgentSession struct

+ Agent *agent.Agent

+ SessionManager *SessionManager

+ func NewAgentSession(a *agent.Agent, sm *SessionManager) *AgentSession

+ func (s *AgentSession) GetActiveToolNames() ([]string, error)

+ func (s *AgentSession) GetFollowUpMode() (string, error)

+ func (s *AgentSession) GetMessages() ([]agent.AgentMessage, error)

+ func (s *AgentSession) GetModel() (ai.Model[ai.API], error)

+ func (s *AgentSession) GetSessionID() (string, error)

+ func (s *AgentSession) GetSessionName() (*string, error)

+ func (s *AgentSession) GetState() (agent.AgentState, error)

+ func (s *AgentSession) GetSteeringMode() (string, error)

+ func (s *AgentSession) GetSystemPrompt() (string, error)

+ func (s *AgentSession) GetThinkingLevel() (ai.ModelThinkingLevel, error)

+ func (s *AgentSession) IsStreaming() bool

+ func (s *AgentSession) Prompt(ctx context.Context, text string, options *PromptOptions) error

+ type AuthStore interface

+ APIKey func(provider ai.Provider) (string, bool)

+ type BranchSummaryEntry struct

+ Details any

+ FromHook *bool

+ FromID string

+ Summary string

+ func (e *BranchSummaryEntry) GetBase() *SessionEntryBase

+ type BranchSummaryMessage struct

+ FromID string

+ Role string

+ Summary string

+ Timestamp int64

+ func CreateBranchSummaryMessage(summary, fromID string, timestamp int64) BranchSummaryMessage

+ func (BranchSummaryMessage) AgentMessageType() string

+ type CompactionEntry struct

+ Details any

+ FirstKeptEntryID string

+ FromHook *bool

+ Summary string

+ TokensBefore int64

+ func GetLatestCompactionEntry(entries []SessionEntry) *CompactionEntry

+ func (e *CompactionEntry) GetBase() *SessionEntryBase

+ type CompactionSummaryMessage struct

+ Role string

+ Summary string

+ Timestamp int64

+ TokensBefore int64

+ func CreateCompactionSummaryMessage(summary string, tokensBefore, timestamp int64) CompactionSummaryMessage

+ func (CompactionSummaryMessage) AgentMessageType() string

+ type CreateAgentSessionOptions struct

+ AuthStore AuthStore

+ Model ai.Model[ai.API]

+ ModelRegistry *ModelRegistry

+ SessionManager *SessionManager

+ ThinkingLevel ai.ModelThinkingLevel

+ type CreateAgentSessionResult struct

+ ModelFallbackMessage *string

+ Session *AgentSession

+ func CreateAgentSession(ctx context.Context, options CreateAgentSessionOptions) (*CreateAgentSessionResult, error)

+ type CustomEntry struct

+ CustomType string

+ Data any

+ func (e *CustomEntry) GetBase() *SessionEntryBase

+ type CustomMessage struct

+ Content []ai.UserContent

+ CustomType string

+ Details any

+ Display bool

+ Role string

+ Timestamp int64

+ func CreateCustomMessage(customType string, content []ai.UserContent, display bool, details any, ...) CustomMessage

+ func (CustomMessage) AgentMessageType() string

+ type CustomMessageEntry struct

+ Content []ai.UserContent

+ CustomType string

+ Details any

+ Display bool

+ func (e *CustomMessageEntry) GetBase() *SessionEntryBase

+ type EnvAuthStore struct

+ func (EnvAuthStore) APIKey(provider ai.Provider) (string, bool)

+ type LabelEntry struct

+ Label *string

+ TargetID string

+ func (e *LabelEntry) GetBase() *SessionEntryBase

+ type ModelChangeEntry struct

+ ModelID string

+ Provider string

+ func (e *ModelChangeEntry) GetBase() *SessionEntryBase

+ type ModelRegistry struct

+ func NewModelRegistry(auth AuthStore) *ModelRegistry

+ func NewModelRegistryWithModels(auth AuthStore, models map[ai.Provider]map[string]ai.Model[ai.API]) *ModelRegistry

+ func (r *ModelRegistry) APIKeyAndHeaders(model ai.Model[ai.API]) (RequestAuth, error)

+ func (r *ModelRegistry) APIKeyForProvider(provider ai.Provider) (string, bool)

+ func (r *ModelRegistry) All() []ai.Model[ai.API]

+ func (r *ModelRegistry) Available() []ai.Model[ai.API]

+ func (r *ModelRegistry) Find(provider ai.Provider, modelID string) (ai.Model[ai.API], bool)

+ func (r *ModelRegistry) HasConfiguredAuth(model ai.Model[ai.API]) bool

+ func (r *ModelRegistry) ProviderDisplayName(provider ai.Provider) string

+ type PromptOptions struct

+ Images []ai.ImageContent

+ StreamingBehavior StreamingBehavior

+ type RequestAuth struct

+ APIKey *string

+ Headers map[string]string

+ type SessionContext struct

+ Messages []agent.AgentMessage

+ Model *SessionModel

+ ThinkingLevel string

+ func BuildSessionContext(entries []SessionEntry, leafID *string, byID map[string]SessionEntry) SessionContext

+ type SessionEntry interface

+ GetBase func() *SessionEntryBase

+ type SessionEntryBase struct

+ ID string

+ ParentID *string

+ Timestamp string

+ Type string

+ type SessionHeader struct

+ FirstMessage *string

+ ID string

+ MessageCount int64

+ Metadata map[string]any

+ Name *string

+ ParentSession *string

+ Timestamp string

+ Type string

+ Version int

+ func NewDefaultSessionHeader(parentSession *string, metadata map[string]any) *SessionHeader

+ type SessionInfo struct

+ Created time.Time

+ FirstMessage string

+ ID string

+ MessageCount int

+ Modified time.Time

+ Name *string

+ ParentSessionPath *string

+ type SessionInfoEntry struct

+ Name *string

+ func (e *SessionInfoEntry) GetBase() *SessionEntryBase

+ type SessionListProgress func(loaded, total int)

+ type SessionManager struct

+ Entries []SessionEntry

+ Header *SessionHeader

+ Store SessionStore

+ func InMemorySessionManager(ctx context.Context) (*SessionManager, error)

+ func NewSessionManager(ctx context.Context, header *SessionHeader, sessionID *string, persist bool, ...) (*SessionManager, error)

+ func (s *SessionManager) AppendCompaction(ctx context.Context, summary, first string, tokens int64, details any, ...) (string, error)

+ func (s *SessionManager) AppendCustomEntry(ctx context.Context, t string, data any) (string, error)

+ func (s *SessionManager) AppendCustomMessageEntry(ctx context.Context, t string, c []ai.UserContent, display bool, details any) (string, error)

+ func (s *SessionManager) AppendLabelChange(ctx context.Context, target string, label *string) (string, error)

+ func (s *SessionManager) AppendMessage(ctx context.Context, m agent.AgentMessage) (string, error)

+ func (s *SessionManager) AppendModelChange(ctx context.Context, p, m string) (string, error)

+ func (s *SessionManager) AppendSessionInfo(ctx context.Context, name string) (string, error)

+ func (s *SessionManager) AppendThinkingLevelChange(ctx context.Context, v string) (string, error)

+ func (s *SessionManager) BuildSessionContext() SessionContext

+ func (s *SessionManager) CreateBranchedSession(ctx context.Context, leafID string) (*SessionManager, error)

+ func (s *SessionManager) GetBranch(from ...string) []SessionEntry

+ func (s *SessionManager) GetChildren(parentID string) []SessionEntry

+ func (s *SessionManager) GetEntries() []SessionEntry

+ func (s *SessionManager) GetEntry(id string) SessionEntry

+ func (s *SessionManager) GetHeader() *SessionHeader

+ func (s *SessionManager) GetLabel(id string) *string

+ func (s *SessionManager) GetLeafEntry() SessionEntry

+ func (s *SessionManager) GetLeafID() *string

+ func (s *SessionManager) GetSessionID() string

+ func (s *SessionManager) GetSessionName() *string

+ func (s *SessionManager) GetTree() []*SessionTreeNode

+ func (s *SessionManager) IsPersisted() bool

+ func (s *SessionManager) LoadSession(ctx context.Context, id string) error

+ func (s *SessionManager) NewSession(ctx context.Context, header *SessionHeader, metadata map[string]any) error

+ func (s *SessionManager) ResetLeaf()

+ func (s *SessionManager) SetLeaf(id string) error

+ type SessionMessageEntry struct

+ Message agent.AgentMessage

+ func (e *SessionMessageEntry) GetBase() *SessionEntryBase

+ type SessionModel struct

+ ModelID string

+ Provider string

+ type SessionStore interface

+ AppendEntry func(ctx context.Context, sessionID string, entry SessionEntry) error

+ CreateBranch func(ctx context.Context, fromLeafID string, newHeader SessionHeader) error

+ CreateSession func(ctx context.Context, header *SessionHeader) error

+ FindMostRecentSession func(ctx context.Context, metadata map[string]any) (*SessionInfo, error)

+ ListSessions func(ctx context.Context, metadata map[string]any) ([]SessionInfo, error)

+ LoadSession func(ctx context.Context, sessionID string) (*SessionHeader, []SessionEntry, error)

+ type SessionTreeNode struct

+ Children []*SessionTreeNode

+ Entry SessionEntry

+ Label *string

+ LabelTimestamp *string

+ type StreamingBehavior string

+ const StreamingBehaviorFollowUp

+ const StreamingBehaviorSteer

+ type ThinkingLevelChangeEntry struct

+ ThinkingLevel string

+ func (e *ThinkingLevelChangeEntry) GetBase() *SessionEntryBase

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