tools

Documentation

Index

• Variables
• func Invoke(call Call) string
• func NewValidationError(fieldsMissing []string) error
• type AiTool
• type Call
  • func (c Call) Json() string
• type FileTreeTool
  • func (f FileTreeTool) Call(input Input) (string, error)
  • func (f FileTreeTool) UserFunction() UserFunction
• type Input
• type InputSchema
• type ParameterObject
• type UserFunction
• type ValidationError
  • func (v ValidationError) Error() string

Variables

var FileTree = FileTreeTool{
	Name:        "local_file_tree",
	Description: "List the filetree of some directory. Uses linux command 'tree'.",
	Inputs: InputSchema{
		Type: "object",
		Properties: map[string]ParameterObject{
			"directory": {
				Type:        "string",
				Description: "The directory to list the filetree of.",
			},
			"level": {
				Type:        "integer",
				Description: "The depth of the tree to display.",
			},
		},
		Required: []string{"directory"},
	},
}

Functions

func Invoke

func Invoke(call Call) string

Invoke the call, and gather both error and output in the same string

func NewValidationError

func NewValidationError(fieldsMissing []string) error

Types

type AiTool

type AiTool interface {
	// Call the AI tool with the given Input. Returns output from the tool or an error
	// if the call returned an error-like. An error-like is either exit code non-zero or
	// restful response non 2xx.
	Call(Input) (string, error)

	// Return the UserFunction, later on used
	// by text queriers to send to their respective
	// models
	UserFunction() UserFunction
}

type Call

type Call struct {
	Name   string `json:"name"`
	Inputs Input  `json:"inputs"`
}

func (Call) Json

func (c Call) Json() string

type FileTreeTool

type FileTreeTool UserFunction

func (FileTreeTool) Call

func (f FileTreeTool) Call(input Input) (string, error)

func (FileTreeTool) UserFunction

func (f FileTreeTool) UserFunction() UserFunction

type Input

type Input map[string]any

type InputSchema

type InputSchema struct {
	Type       string                     `json:"type"`
	Properties map[string]ParameterObject `json:"properties"`
	Required   []string                   `json:"required"`
}

type ParameterObject

type ParameterObject struct {
	Type        string   `json:"type"`
	Description string   `json:"description"`
	Enum        []string `json:"enum,omitempty"`
}

type UserFunction

type UserFunction struct {
	Name        string      `json:"name"`
	Description string      `json:"description"`
	Inputs      InputSchema `json:"input_schema"`
}

type ValidationError

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

func (ValidationError) Error

func (v ValidationError) Error() string