tools

Documentation

Index

• type FunctionCall
• type FunctionDefinition
• type FunctionParamaters
• type Tool
  • func (t *Tool) DisplayName() string
• type ToolAnnotation
• type ToolCall
• type ToolCallResult
• type ToolHandler
• type ToolSet
• type ToolType

Types

type FunctionCall

type FunctionCall struct {
	Name      string `json:"name,omitempty"`
	Arguments string `json:"arguments,omitempty"`
}

type FunctionDefinition

type FunctionDefinition struct {
	Name        string             `json:"name"`
	Description string             `json:"description,omitempty"`
	Strict      bool               `json:"strict,omitempty"`
	Parameters  FunctionParamaters `json:"parameters"`
	Annotations ToolAnnotation     `json:"annotations"`
}

type FunctionParamaters

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

type Tool

type Tool struct {
	Function *FunctionDefinition `json:"function,omitempty"`
	Handler  ToolHandler         `json:"handler,omitempty"`
}

func (*Tool) DisplayName

func (t *Tool) DisplayName() string

type ToolAnnotation

type ToolAnnotation struct {
	Title           string `json:"title,omitempty"`
	ReadOnlyHint    *bool  `json:"readOnlyHint,omitempty"`
	DestructiveHint *bool  `json:"destructiveHint,omitempty"`
	IdempotentHint  *bool  `json:"idempotentHint,omitempty"`
	OpenWorldHint   *bool  `json:"openWorldHint,omitempty"`
}

type ToolCall

type ToolCall struct {
	ID       string       `json:"id,omitempty"`
	Type     ToolType     `json:"type"`
	Function FunctionCall `json:"function"`
}

type ToolCallResult

type ToolCallResult struct {
	Output string `json:"output"`
}

type ToolHandler

type ToolHandler = func(ctx context.Context, toolCall ToolCall) (*ToolCallResult, error)

type ToolSet

type ToolSet interface {
	Tools(ctx context.Context) ([]Tool, error)
	Instructions() string
	Start(ctx context.Context) error
	Stop() error
}

type ToolType

type ToolType string