agent

package
v0.0.0-...-c65d62e Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 31, 2026 License: MIT Imports: 29 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	UserRole      = "user"
	AssistantRole = "assistant"
	SystemRole    = "system"
)

Variables

View Source 
var CanStopItself = func(o *options) error {
	o.canStopItself = true
	return nil
}
View Source 
var DisableSinkState = func(o *options) error {
	o.disableSinkState = true
	return nil
}
View Source 
var EnableAutoCompaction = func(o *options) error {
	o.enableAutoCompaction = true
	return nil
}
View Source 
var EnableForceReasoning = func(o *options) error {
	o.forceReasoning = true
	return nil
}
View Source 
var EnableForceReasoningTool = func(o *options) error {
	o.forceReasoningTool = true
	return nil
}
View Source 
var EnableGuidedTools = func(o *options) error {
	o.enableGuidedTools = true
	return nil
}
View Source 
var EnableHUD = func(o *options) error {
	o.enableHUD = true
	return nil
}
View Source 
var EnableInitiateConversations = func(o *options) error {
	o.initiateConversations = true
	return nil
}
View Source 
var EnableKnowledgeBase = func(o *options) error {
	o.enableKB = true
	o.kbResults = 5
	return nil
}
View Source 
var EnableLongTermMemory = func(o *options) error {
	o.enableLongTermMemory = true
	return nil
}
View Source 
var EnablePersonality = func(o *options) error {
	o.showCharacter = true
	return nil
}
View Source 
var EnablePlanning = func(o *options) error {
	o.canPlan = true
	return nil
}
View Source 
var EnableStandaloneJob = func(o *options) error {
	o.standaloneJob = true
	return nil
}

EnableStandaloneJob is an option to enable the agent to run jobs in the background automatically

View Source 
var EnableStripThinkingTags = func(o *options) error {
	o.stripThinkingTags = true
	return nil
}
View Source 
var EnableSummaryMemory = func(o *options) error {
	o.enableSummaryMemory = true
	return nil
}
View Source 
var ErrContextCanceled = fmt.Errorf("context canceled")
View Source 
var WithPlanReviewerLLM = func(model string) Option {
	return func(o *options) error {
		o.LLMAPI.ReviewerModel = model
		return nil
	}
}

Functions

func NewKBWrapperActions 

func NewKBWrapperActions(ragdb RAGDB, kbResults int) (*SearchKnowledgeBaseAction, *AddToKnowledgeBaseAction)

NewKBWrapperActions creates factory functions for KB wrapper actions

Types

type AddToKnowledgeBaseAction 

type AddToKnowledgeBaseAction struct {
	*KBWrapperActions
}

func (*AddToKnowledgeBaseAction) Definition 

func (a *AddToKnowledgeBaseAction) Definition() types.ActionDefinition

func (*AddToKnowledgeBaseAction) Run 

func (a *AddToKnowledgeBaseAction) Run(ctx context.Context, sharedState *types.AgentSharedState, params types.ActionParams) (types.ActionResult, error)

type Agent 

type Agent struct {
	sync.Mutex

	Character Character
	// contains filtered or unexported fields
}

func New 

func New(opts ...Option) (*Agent, error)

func (*Agent) AddSubscriber 

func (a *Agent) AddSubscriber(f func(*types.ConversationMessage))

func (*Agent) Ask 

func (a *Agent) Ask(opts ...types.JobOption) *types.JobResult

Ask is a blocking call that returns the response as soon as it's ready. It discards any other computation.

func (*Agent) AskDirect 

func (a *Agent) AskDirect(opts ...types.JobOption) *types.JobResult

AskDirect executes a job synchronously without requiring Run() to be active. Unlike Ask/Execute which enqueue to the internal jobQueue (consumed by Run()), AskDirect calls consumeJob directly. This enables stateless execution where the caller manages the event loop

func (*Agent) AskDirectSystem 

func (a *Agent) AskDirectSystem(opts ...types.JobOption) *types.JobResult

AskDirectSystem is like AskDirect but executes with SystemRole, used for periodic autonomous runs and scheduled tasks.

func (*Agent) Context 

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

func (*Agent) Enqueue 

func (a *Agent) Enqueue(j *types.Job)

func (*Agent) Execute 

func (a *Agent) Execute(j *types.Job) *types.JobResult

Ask is a pre-emptive, blocking call that returns the response as soon as it's ready. It discards any other computation.

func (*Agent) LoadCharacter 

func (a *Agent) LoadCharacter(path string) error

func (*Agent) LoadState 

func (a *Agent) LoadState(path string) error

func (*Agent) Memory 

func (a *Agent) Memory() RAGDB

func (*Agent) Observer 

func (a *Agent) Observer() Observer

func (*Agent) Pause 

func (a *Agent) Pause()

func (*Agent) Paused 

func (a *Agent) Paused() bool

func (*Agent) Resume 

func (a *Agent) Resume()

func (*Agent) Run 

func (a *Agent) Run() error

func (*Agent) SaveCharacter 

func (a *Agent) SaveCharacter(path string) error

func (*Agent) SaveState 

func (a *Agent) SaveState(path string) error

func (*Agent) SetStreamCallback 

func (a *Agent) SetStreamCallback(fn func(cogito.StreamEvent))

SetStreamCallback sets (or replaces) the stream callback on a live agent. This allows callers to wire streaming events after agent creation,

func (*Agent) SharedState 

func (a *Agent) SharedState() *types.AgentSharedState

func (*Agent) StartConversationConsumer 

func (a *Agent) StartConversationConsumer()

StartConversationConsumer starts the goroutine that dispatches new conversation messages to subscribers. This must be called when using AskDirect() without Run(), otherwise the ConversationAction handler will deadlock on the newConversations channel.

func (*Agent) State 

func (a *Agent) State() types.AgentInternalState

func (*Agent) Stop 

func (a *Agent) Stop()

func (*Agent) TTS 

func (a *Agent) TTS(ctx context.Context, text string) ([]byte, error)

func (*Agent) Transcribe 

func (a *Agent) Transcribe(ctx context.Context, file string) (string, error)

type Character 

type Character struct {
	Name       string   `json:"name"`
	Age        string   `json:"age"`
	Occupation string   `json:"job_occupation"`
	Hobbies    []string `json:"hobbies"`
	MusicTaste []string `json:"favorites_music_genres"`
	Sex        string   `json:"sex"`
}

func Load 

func Load(path string) (*Character, error)

func (*Character) String 

func (c *Character) String() string

func (*Character) ToJSONSchema 

func (c *Character) ToJSONSchema() jsonschema.Definition

type CommonTemplateData 

type CommonTemplateData struct {
	AgentName string
}

type ConversationStorageMode 

type ConversationStorageMode string

ConversationStorageMode defines how conversations are stored in the knowledge base 

const (
	// StoreUserOnly stores only user messages (default)
	StoreUserOnly ConversationStorageMode = "user_only"
	// StoreUserAndAssistant stores both user and assistant messages separately
	StoreUserAndAssistant ConversationStorageMode = "user_and_assistant"
	// StoreWholeConversation stores the entire conversation as a single block
	StoreWholeConversation ConversationStorageMode = "whole_conversation"
)

type DynamicPrompt 

type DynamicPrompt interface {
	Render(a *Agent) (types.PromptResult, error)
	Role() string
}

type InnerMonologueTemplateData 

type InnerMonologueTemplateData struct {
	CommonTemplateData
	Task string
}

type KBWrapperActions 

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

KBWrapperActions wraps RAGDB functionality as actions

type MCPSTDIOServer 

type MCPSTDIOServer struct {
	Name string   `json:"name,omitempty"`
	Args []string `json:"args"`
	Env  []string `json:"env"`
	Cmd  string   `json:"cmd"`
}

type MCPServer 

type MCPServer struct {
	URL   string `json:"url"`
	Token string `json:"token"`
}

type Messages 

type Messages []openai.ChatCompletionMessage

func (Messages) Exist 

func (m Messages) Exist(content string) bool

func (Messages) GetLatestUserMessage 

func (m Messages) GetLatestUserMessage() *openai.ChatCompletionMessage

func (Messages) RemoveIf 

func (m Messages) RemoveIf(f func(msg openai.ChatCompletionMessage) bool) Messages

func (Messages) RemoveLastUserMessage 

func (m Messages) RemoveLastUserMessage() Messages

func (Messages) Save 

func (m Messages) Save(path string) error

func (Messages) String 

func (m Messages) String() string

func (Messages) ToOpenAI 

func (m Messages) ToOpenAI() []openai.ChatCompletionMessage

type NoToolToCallArgs 

type NoToolToCallArgs struct {
	Reasoning string `json:"reasoning" description:"The reasoning for why no tool is being called"`
}

NoToolToCallArgs defines the arguments for the no_tool_to_call sink state tool

type NoToolToCallTool 

type NoToolToCallTool struct{}

NoToolToCallTool is a custom sink state tool that logs when no other tool is needed

func (NoToolToCallTool) Run 

func (t NoToolToCallTool) Run(args NoToolToCallArgs) (string, any, error)

Run executes the no_tool_to_call tool and logs a message

type Observer 

type Observer interface {
	NewObservable() *types.Observable
	Update(types.Observable)
	History() []types.Observable
	ClearHistory()
}

type Option 

type Option func(*options) error

func EnableEvaluation 

func EnableEvaluation() Option

func EnableKnowledgeBaseWithResults 

func EnableKnowledgeBaseWithResults(results int) Option

func FromFile 

func FromFile(path string) Option

func WithActions 

func WithActions(actions ...types.Action) Option

func WithAgentReasoningCallback 

func WithAgentReasoningCallback(cb func(types.ActionCurrentState) bool) Option

func WithAgentResultCallback 

func WithAgentResultCallback(cb func(types.ActionState)) Option

func WithAutoCompactionThreshold 

func WithAutoCompactionThreshold(threshold int) Option

func WithCancelPreviousOnNewMessage 

func WithCancelPreviousOnNewMessage(cancel bool) Option

WithCancelPreviousOnNewMessage sets whether a new job with the same conversation_id cancels the currently running job (true) or is queued (false). Nil/default means true.

func WithCharacter 

func WithCharacter(c Character) Option

func WithCharacterFile 

func WithCharacterFile(path string) Option

func WithContext 

func WithContext(ctx context.Context) Option

func WithConversationStorageMode 

func WithConversationStorageMode(mode ConversationStorageMode) Option

WithConversationStorageMode sets how conversations are stored in the knowledge base

func WithConversationsPath 

func WithConversationsPath(path string) Option

func WithInnerMonologueTemplate 

func WithInnerMonologueTemplate(template string) Option

WithInnerMonologueTemplate sets the prompt used for periodic/standalone runs. If empty, the default template is used.

func WithJobFilters 

func WithJobFilters(filters ...types.JobFilter) Option

func WithKBAutoSearch 

func WithKBAutoSearch(enabled bool) Option

func WithLLMAPIKey 

func WithLLMAPIKey(key string) Option

func WithLLMAPIURL 

func WithLLMAPIURL(url string) Option

func WithLastMessageDuration 

func WithLastMessageDuration(duration string) Option

func WithLoopDetection 

func WithLoopDetection(loops int) Option

func WithMCPPrepareScript 

func WithMCPPrepareScript(script string) Option

func WithMCPSTDIOServers 

func WithMCPSTDIOServers(servers ...MCPSTDIOServer) Option

func WithMCPServers 

func WithMCPServers(servers ...MCPServer) Option

func WithMCPSession 

func WithMCPSession(session *mcp.ClientSession) Option

WithMCPSession adds a pre-connected MCP client session (e.g. in-process skills MCP) to the agent.

func WithMaxAttempts 

func WithMaxAttempts(attempts int) Option

WithMaxAttempts sets how many times to attempt execution on failure before surfacing the error to the user (1 = no retries).

func WithMaxEvaluationLoops 

func WithMaxEvaluationLoops(loops int) Option

func WithModel 

func WithModel(model string) Option

func WithMultimodalModel 

func WithMultimodalModel(model string) Option

func WithNewConversationSubscriber 

func WithNewConversationSubscriber(sub func(*types.ConversationMessage)) Option

func WithObserver 

func WithObserver(observer Observer) Option

func WithParallelJobs 

func WithParallelJobs(jobs int) Option

func WithPeriodicRuns 

func WithPeriodicRuns(duration string) Option

func WithPermanentGoal 

func WithPermanentGoal(goal string) Option

func WithPrompts 

func WithPrompts(prompts ...DynamicPrompt) Option

WithPrompts adds additional block prompts to the agent to be rendered internally in the conversation when processing the conversation to the LLM

func WithRAGDB 

func WithRAGDB(db RAGDB) Option

func WithRandomIdentity 

func WithRandomIdentity(guidance ...string) Option

func WithSchedulerPollInterval 

func WithSchedulerPollInterval(duration string) Option

func WithSchedulerStorePath 

func WithSchedulerStorePath(path string) Option

WithSchedulerStorePath sets the path for the scheduler's JSON storage file

func WithSchedulerTaskTemplate 

func WithSchedulerTaskTemplate(template string) Option

WithSchedulerTaskTemplate sets the prompt used for scheduled/recurring tasks run by the scheduler. If empty, the default inner monologue template is used with the task injected.

func WithSkillPromptTemplate 

func WithSkillPromptTemplate(template string) Option

WithSkillPromptTemplate sets the template for rendering skills in the prompt. If empty, the default template is used.

func WithStateFile 

func WithStateFile(path string) Option

func WithStreamCallback 

func WithStreamCallback(fn func(cogito.StreamEvent)) Option

WithStreamCallback sets a callback to receive streaming events from cogito during final answer generation. This enables live token-by-token delivery.

func WithSystemPrompt 

func WithSystemPrompt(prompt string) Option

func WithTTSModel 

func WithTTSModel(model string) Option

func WithTimeout 

func WithTimeout(timeout string) Option

func WithTranscriptionLanguage 

func WithTranscriptionLanguage(language string) Option

func WithTranscriptionModel 

func WithTranscriptionModel(model string) Option

type PromptHUD 

type PromptHUD struct {
	Character     Character                `json:"character"`
	CurrentState  types.AgentInternalState `json:"current_state"`
	PermanentGoal string                   `json:"permanent_goal"`
	ShowCharacter bool                     `json:"show_character"`
}

PromptHUD contains all information that should be displayed to the LLM in the prompts

type RAGDB 

type RAGDB interface {
	Store(s string) error
	Reset() error
	Search(s string, similarEntries int) ([]string, error)
	Count() int
}

type SSEObserver 

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

func NewSSEObserver 

func NewSSEObserver(agent string, manager sse.Manager) *SSEObserver

func (*SSEObserver) ClearHistory 

func (s *SSEObserver) ClearHistory()

func (*SSEObserver) History 

func (s *SSEObserver) History() []types.Observable

func (*SSEObserver) NewObservable 

func (s *SSEObserver) NewObservable() *types.Observable

func (*SSEObserver) Update 

func (s *SSEObserver) Update(obs types.Observable)

type SearchKnowledgeBaseAction 

type SearchKnowledgeBaseAction struct {
	*KBWrapperActions
}

func (*SearchKnowledgeBaseAction) Definition 

func (a *SearchKnowledgeBaseAction) Definition() types.ActionDefinition

func (*SearchKnowledgeBaseAction) Run 

func (a *SearchKnowledgeBaseAction) Run(ctx context.Context, sharedState *types.AgentSharedState, params types.ActionParams) (types.ActionResult, error)

type ToolInputSchema 

type ToolInputSchema struct {
	Type       string                 `json:"type"`
	Properties map[string]interface{} `json:"properties,omitempty"`
	Required   []string               `json:"required,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.