tools

type ConfirmationResponse ¶

type ConfirmationResponse int

const (
	Confirmed ConfirmationResponse = iota
	Denied
	Quit
)

type ContentItem ¶

type ContentItem struct {
	Text string `json:"text"`
	Type string `json:"type"`
}

type ToolCallsRequest ¶

type ToolCallsRequest struct {
	Prompt string `json:"prompt"`
}

type ToolCallsResult ¶

type ToolCallsResult struct {
	Text string           `json:"text"`
	List []map[string]any `json:"list"`
}

type ToolDefinition ¶

type ToolDefinition struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Function    any    `json:"-"`
}

ToolDefinition defines a tool that can be used by the ToolsAgent. It includes the tool's name, description, and the function that implements the tool's behavior. The `name` is the identifier the model uses to request the tool. The `description` helps the model understand when to use the tool. The function `fn` implements the tool's logic, taking an input of type `In`, and returning an output of type `Out`. The input and output types determine the `inputSchema` and `outputSchema` in the tool's definition, which guide the model on how to provide input and interpret output.

type ToolExecution ¶

type ToolExecution struct {
	OnExecuted func(toolName string, toolInput any, toolCallRef string, output any, err error)
}

type ToolExecutionConfirmation ¶

type ToolExecutionConfirmation struct {
	Question func(toolName string, toolInput any, toolCallRef string) ConfirmationResponse

	OnConfirmed func(toolName string, toolInput any, toolCallRef string, output any, err error)
	OnDenied    func(toolName string, toolInput any, toolCallRef string)
	OnQuit      func(toolName string, toolInput any, toolCallRef string)
	Default     func()
}

type ToolOutput ¶

type ToolOutput struct {
	Content []ContentItem `json:"content"`
}

type ToolsAgent ¶

type ToolsAgent struct {
	Name               string
	SystemInstructions string
	ModelID            string
	Messages           []*ai.Message

	Config models.ModelConfig

	ToolsIndex []ai.ToolRef
	// contains filtered or unexported fields
}

ToolsAgent is an implementation of an AI agent that can utilize various tools to perform tasks. IMPORTANT: ToolsAgent is not a chat agent.

func NewToolsAgent(
	ctx context.Context,
	toolsAgentConfig agents.AgentConfig,
	modelConfig models.ModelConfig,

	opts ...ToolsAgentOption,
) (*ToolsAgent, error)

func (toolsAgent *ToolsAgent) GetCurrentContextSize() int

func (toolsAgent *ToolsAgent) GetInfo() (agents.ToolsAgentInfo, error)

func (toolsAgent *ToolsAgent) GetMessages() []*ai.Message

func (toolsAgent *ToolsAgent) GetName() string

func (toolsAgent *ToolsAgent) Kind() agents.AgentKind

func (toolsAgent *ToolsAgent) RunToolCalls(prompt string) (ToolCallsResult, error)

type ToolsAgentOption ¶

type ToolsAgentOption func(*ToolsAgent)

AgentOption defines a functional option for configuring LocalAIAgent

func EnableAutoToolCallFlow() ToolsAgentOption

func EnableToolCallFlow() ToolsAgentOption

func WithConfirmation(toolExecutionConfirmation ToolExecutionConfirmation) ToolsAgentOption

func WithLogLevel(level logger.LogLevel) ToolsAgentOption

func WithLogger(log logger.Logger) ToolsAgentOption

func WithToolExecution(toolExecution ToolExecution) ToolsAgentOption

func WithVerbose(verbose bool) ToolsAgentOption