tools

README

go-openai-tools

This is a library to make tool definition and tool calls easy. The library is intended to be used with sashabaranov/go-openai.

Installation

go get -u github.com/southball/go-openai-tools

Example

package main

import (
	"context"
	"fmt"
	"os"
	"slices"

	openai "github.com/sashabaranov/go-openai"
	tools "github.com/southball/go-openai-tools"
)

type GetWeatherRequest struct {
	Location string `json:"location" required:"true" description:"City and country e.g. Bogotá, Colombia"`
}

type GetWeatherResponse struct {
	Weather string `json:"weather"`
}

func GetWeather(_ GetWeatherRequest) (GetWeatherResponse, error) {
	return GetWeatherResponse{Weather: "sunny"}, nil
}

const MODEL = "gpt-4o"

func main() {
	toolset, err := tools.NewToolSet(
		tools.F("GetWeather", "Get the current weather for a location.", GetWeather),
	)
	if err != nil {
		panic(fmt.Errorf("failed to create toolset: %w", err))
	}

	client := openai.NewClient(os.Getenv("OPENAI_API_KEY"))
	initialMessages := []openai.ChatCompletionMessage{
		{Role: openai.ChatMessageRoleSystem, Content: "You are a helpful assistant."},
		{Role: openai.ChatMessageRoleUser, Content: "What is the weather like in Bogotá, Colombia?"},
	}

	resp, err := client.CreateChatCompletion(
		context.Background(),
		openai.ChatCompletionRequest{
			Model:    MODEL,
			Messages: initialMessages,
			Tools:    toolset.OpenAITools(),
		},
	)
	if err != nil {
		panic(fmt.Errorf("failed to create chat completion: %w", err))
	}

	answer := resp.Choices[0].Message
	toolCallMessages, err := toolset.HandleToolCalls(context.Background(), answer.ToolCalls)
	if err != nil {
		panic(fmt.Errorf("failed to handle tool calls: %w", err))
	}

	resp, err = client.CreateChatCompletion(
		context.Background(),
		openai.ChatCompletionRequest{
			Model:    MODEL,
			Messages: slices.Concat(initialMessages, []openai.ChatCompletionMessage{answer}, toolCallMessages),
		},
	)
	if err != nil {
		panic(fmt.Errorf("failed to create chat completion: %w", err))
	}

	fmt.Printf("Final response: %s\n", resp.Choices[0].Message.Content)
}

Documentation

Index

• func HandleToolCall(tool Tool, toolCall openai.ToolCall) (openai.ChatCompletionMessage, error)
• func OpenAITool(tool Tool) (openai.Tool, error)
• type Tool
  • func F[U, V any](name string, description string, callFunc func(args U) (V, error)) Tool
• type ToolSet
  • func NewToolSet(toolset ...Tool) (*ToolSet, error)
  • func (t ToolSet) HandleToolCalls(ctx context.Context, toolCalls []openai.ToolCall) ([]openai.ChatCompletionMessage, error)
  • func (t ToolSet) OpenAITools() []openai.Tool

Functions

func HandleToolCall

func HandleToolCall(tool Tool, toolCall openai.ToolCall) (openai.ChatCompletionMessage, error)

Handles a single openai.ToolCall using the provided Tool.

func OpenAITool

func OpenAITool(tool Tool) (openai.Tool, error)

Convert a Tool to an openai.Tool.

Types

type Tool

type Tool interface {
	// Name of the tool.
	Name() string
	// Description of the tool.
	Description() string
	// Type of the request.
	// The type should have struct tags as specified in https://pkg.go.dev/github.com/swaggest/jsonschema-go#Reflector.Reflect.
	RequestType() reflect.Type
	// Accepts argument of the type returned by RequestType(). Returns any value or an error.
	CallFunction(args any) (any, error)
}

A Tool is an interface that can be used to derive an openai.Tool and also handle openai.ToolCall.

func F

func F[U, V any](name string, description string, callFunc func(args U) (V, error)) Tool

Create a Tool with the given name, description, and function.

type ToolSet

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

A collection of Tool.

func NewToolSet

func NewToolSet(toolset ...Tool) (*ToolSet, error)

Construct a ToolSet from the given list of Tool.

func (ToolSet) HandleToolCalls

func (t ToolSet) HandleToolCalls(
	ctx context.Context,
	toolCalls []openai.ToolCall,
) ([]openai.ChatCompletionMessage, error)

Process a list of openai.ToolCall and return a list of openai.ChatCompletionMessage corresponding to the results of those calls.

func (ToolSet) OpenAITools

func (t ToolSet) OpenAITools() []openai.Tool

Get a list of openai.Tool from the ToolSet.