agent

package
v1.19.0 Latest Latest
Warning

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

 Go to latest Published: Jan 8, 2026 License: Apache-2.0 Imports: 10 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Agent 

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

Agent represents an AI agent

func New 

func New(name, prompt string, opts ...Opt) *Agent

New creates a new agent

func (*Agent) AddDate 

func (a *Agent) AddDate() bool

func (*Agent) AddEnvironmentInfo added in v1.0.0 

func (a *Agent) AddEnvironmentInfo() bool

func (*Agent) AddPromptFiles added in v1.6.0 

func (a *Agent) AddPromptFiles() []string

func (*Agent) Commands added in v1.6.6 

func (a *Agent) Commands() types.Commands

Commands returns the named commands configured for this agent.

func (*Agent) ConfiguredModels added in v1.19.0 

func (a *Agent) ConfiguredModels() []provider.Provider

ConfiguredModels returns the originally configured models for this agent. This is useful for listing available models in the TUI picker.

func (*Agent) Description 

func (a *Agent) Description() string

Description returns the agent's description

func (*Agent) DrainWarnings added in v1.8.2 

func (a *Agent) DrainWarnings() []string

DrainWarnings returns pending warnings and clears them.

func (*Agent) Handoffs added in v1.8.2 

func (a *Agent) Handoffs() []*Agent

Handoffs returns the list of handoff agents

func (*Agent) HasModelOverride added in v1.19.0 

func (a *Agent) HasModelOverride() bool

HasModelOverride returns true if a model override is currently set.

func (*Agent) HasSubAgents 

func (a *Agent) HasSubAgents() bool

HasSubAgents checks if the agent has sub-agents

func (*Agent) Hooks added in v1.8.2 

func (a *Agent) Hooks() *latest.HooksConfig

Hooks returns the hooks configuration for this agent.

func (*Agent) Instruction 

func (a *Agent) Instruction() string

Instruction returns the agent's instructions

func (*Agent) MaxIterations added in v1.3.6 

func (a *Agent) MaxIterations() int

func (*Agent) Model 

func (a *Agent) Model() provider.Provider

Model returns the model to use for this agent. If model override(s) are set, it returns one of the overrides (randomly for alloy). Otherwise, it returns a random model from the available models.

func (*Agent) Name 

func (a *Agent) Name() string

func (*Agent) NumHistoryItems added in v1.5.2 

func (a *Agent) NumHistoryItems() int

func (*Agent) Parents 

func (a *Agent) Parents() []*Agent

Parents returns the list of parent agent names

func (*Agent) SetModelOverride added in v1.19.0 

func (a *Agent) SetModelOverride(models ...provider.Provider)

SetModelOverride sets runtime model override(s) for this agent. The override(s) take precedence over the configured models. For alloy models, multiple providers can be passed and one will be randomly selected. Pass no arguments or nil providers to clear the override.

func (*Agent) SkillsEnabled added in v1.8.2 

func (a *Agent) SkillsEnabled() bool

SkillsEnabled returns whether skills discovery is enabled for this agent.

func (*Agent) StopToolSets 

func (a *Agent) StopToolSets(ctx context.Context) error

func (*Agent) SubAgents 

func (a *Agent) SubAgents() []*Agent

SubAgents returns the list of sub-agents

func (*Agent) ToolSets 

func (a *Agent) ToolSets() []tools.ToolSet

func (*Agent) Tools 

func (a *Agent) Tools(ctx context.Context) ([]tools.Tool, error)

Tools returns the tools available to this agent

func (*Agent) WelcomeMessage added in v1.8.2 

func (a *Agent) WelcomeMessage() string

WelcomeMessage returns the agent's welcome message

type Opt 

type Opt func(a *Agent)

func WithAddDate 

func WithAddDate(addDate bool) Opt

func WithAddEnvironmentInfo added in v1.0.0 

func WithAddEnvironmentInfo(addEnvironmentInfo bool) Opt

func WithAddPromptFiles added in v1.6.0 

func WithAddPromptFiles(addPromptFiles []string) Opt

func WithCommands added in v1.6.6 

func WithCommands(commands types.Commands) Opt

func WithDescription 

func WithDescription(description string) Opt

func WithHandoffs added in v1.8.2 

func WithHandoffs(handoffs ...*Agent) Opt

func WithHooks added in v1.8.2 

func WithHooks(hooks *latest.HooksConfig) Opt

func WithInstruction 

func WithInstruction(instruction string) Opt

func WithLoadTimeWarnings added in v1.8.2 

func WithLoadTimeWarnings(warnings []string) Opt

func WithMaxIterations added in v1.3.6 

func WithMaxIterations(maxIterations int) Opt

func WithModel 

func WithModel(model provider.Provider) Opt

func WithName 

func WithName(name string) Opt

func WithNumHistoryItems added in v1.5.2 

func WithNumHistoryItems(numHistoryItems int) Opt

func WithSkillsEnabled added in v1.8.2 

func WithSkillsEnabled(enabled bool) Opt

func WithSubAgents 

func WithSubAgents(subAgents ...*Agent) Opt

func WithToolSets 

func WithToolSets(toolSet ...tools.ToolSet) Opt

func WithTools 

func WithTools(allTools ...tools.Tool) Opt

func WithWelcomeMessage added in v1.8.2 

func WithWelcomeMessage(welcomeMessage string) Opt

type StartableToolSet added in v1.7.1 

type StartableToolSet struct {
	tools.ToolSet
	// contains filtered or unexported fields
}

func (*StartableToolSet) IsStarted added in v1.8.2 

func (s *StartableToolSet) IsStarted() bool

IsStarted returns whether the toolset has been successfully started.

func (*StartableToolSet) Start added in v1.18.6 

func (s *StartableToolSet) Start(ctx context.Context) error

Start starts the toolset.

It provides single-flight semantics: concurrent callers block until this start attempt completes. If this attempt fails, a future call will retry.

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.