schema

Documentation

Index

• type Agent
• type Content
  • func Image(r io.Reader) (*Content, error)
  • func ImageData(path string) (*Content, error)
  • func ImageUrl(v, detail string) (*Content, error)
  • func Text(v string) *Content
  • func ToolResult(id string, result string) *Content
  • func ToolUse(t ToolCall) *Content
  • func (c Content) GetString(name, input string) (string, bool)
  • func (c Content) String() string
• type Embedding
  • func (e Embedding) CosineDistance(other Embedding) float64
• type Embeddings
• type Message
  • func NewMessage(role string, content ...any) *Message
  • func (m *Message) Add(content ...any) *Message
  • func (m *Message) IsValid() bool
  • func (m Message) String() string
• type MessageChoice
  • func (m MessageChoice) String() string
• type MessageChunk
  • func (m MessageChunk) String() string
• type MessageDelta
  • func (m MessageDelta) String() string
• type Model
• type TokenUsage
• type Tool
  • func NewTool(name, description string) *Tool
  • func NewToolEx(name, description string, parameters any) (*Tool, error)
  • func (tool *Tool) Add(name, description string, required bool, t reflect.Type) error
  • func (t Tool) String() string
• type ToolCall
• type ToolFunction

Types

type Agent

type Agent interface {
	// Enumerate the tools available
	Tools() []Tool

	// Run a tool with parameters and return the result
	Run(context.Context, string, any) (any, error)
}

An agent is a collection of tools that can be called

type Content

type Content struct {
	Id     string         `json:"id,omitempty"`
	Type   string         `json:"type" writer:",width:4"`
	Text   string         `json:"text,omitempty" writer:",width:60,wrap"`
	Source *contentSource `json:"source,omitempty"`
	Url    *contentImage  `json:"image_url,omitempty"`

	// Tool Result
	ToolId string `json:"tool_use_id,omitempty"`
	Result string `json:"content,omitempty"`
	// contains filtered or unexported fields
}

Message Content

func Image

func Image(r io.Reader) (*Content, error)

Return a new content object of type image, from a io.Reader

func ImageData

func ImageData(path string) (*Content, error)

Return a new content object of type image, from a file

func ImageUrl

func ImageUrl(v, detail string) (*Content, error)

Return a new content object of type image, from a Url

func Text

func Text(v string) *Content

Return a new content object of type text

func ToolResult

func ToolResult(id string, result string) *Content

Return a tool result

func ToolUse

func ToolUse(t ToolCall) *Content

Return tool usage

func (Content) GetString

func (c Content) GetString(name, input string) (string, bool)

Return an input parameter as a string, returns false if the name is incorrect or the input doesn't exist

func (Content) String

func (c Content) String() string

type Embedding

type Embedding struct {
	Embedding []float64 `json:"embedding"`
	Index     int       `json:"index"`
}

An embedding object

func (Embedding) CosineDistance

func (e Embedding) CosineDistance(other Embedding) float64

type Embeddings

type Embeddings struct {
	Id    string      `json:"id" writer:",width:32"`
	Data  []Embedding `json:"data" writer:",wrap"`
	Model string      `json:"model"`
	Usage struct {
		PromptTokerns int `json:"prompt_tokens"`
		TotalTokens   int `json:"total_tokens"`
	} `json:"usage" writer:",wrap"`
}

An set of created embeddings

type Message

type Message struct {
	// user, system or assistant
	Role string `json:"role,omitempty"`

	// Message Id
	Id string `json:"id,omitempty"`

	// Model
	Model string `json:"model,omitempty"`

	// Content can be a string, array of strings, content
	// object or an array of content objects
	Content any `json:"content,omitempty"`

	// Any tool calls
	ToolCalls []ToolCall `json:"tool_calls,omitempty"`

	// Time the message was created, in unix seconds
	Created int64 `json:"created,omitempty"`
}

A chat completion message

func NewMessage

func NewMessage(role string, content ...any) *Message

Create a new message, with optional content

func (*Message) Add

func (m *Message) Add(content ...any) *Message

Append content to the message

func (*Message) IsValid

func (m *Message) IsValid() bool

func (Message) String

func (m Message) String() string

type MessageChoice

type MessageChoice struct {
	Message      *Message      `json:"message,omitempty"`
	Delta        *MessageDelta `json:"delta,omitempty"`
	Index        int           `json:"index"`
	FinishReason string        `json:"finish_reason,omitempty"`
}

One choice of chat completion messages

func (MessageChoice) String

func (m MessageChoice) String() string

type MessageChunk

type MessageChunk struct {
	Id                string          `json:"id,omitempty"`
	Model             string          `json:"model,omitempty"`
	Created           int64           `json:"created,omitempty"`
	SystemFingerprint string          `json:"system_fingerprint,omitempty"`
	TokenUsage        *TokenUsage     `json:"usage,omitempty"`
	Choices           []MessageChoice `json:"choices,omitempty"`
}

Chat completion chunk

func (MessageChunk) String

func (m MessageChunk) String() string

type MessageDelta

type MessageDelta struct {
	Role    string `json:"role,omitempty"`
	Content string `json:"content,omitempty"`
}

Delta between messages (for streaming responses)

func (MessageDelta) String

func (m MessageDelta) String() string

type Model

type Model struct {
	Id      string `json:"id" writer:",width:30"`
	Created int64  `json:"created,omitempty"`
	Owner   string `json:"owned_by,omitempty"`
}

A model object

type TokenUsage

type TokenUsage struct {
	PromptTokens     int `json:"prompt_tokens,omitempty"`
	CompletionTokens int `json:"completion_tokens,omitempty"`
	TotalTokens      int `json:"total_tokens,omitempty"`
}

Token usage

type Tool

type Tool struct {
	Name        string          `json:"name"`
	Description string          `json:"description"`
	Type        string          `json:"type,omitempty"`
	Parameters  *toolParameters `json:"parameters,omitempty"`   // Used by OpenAI, Mistral
	InputSchema *toolParameters `json:"input_schema,omitempty"` // Used by anthropic
}

A tool function

func NewTool

func NewTool(name, description string) *Tool

func NewToolEx

func NewToolEx(name, description string, parameters any) (*Tool, error)

func (*Tool) Add

func (tool *Tool) Add(name, description string, required bool, t reflect.Type) error

func (Tool) String

func (t Tool) String() string

type ToolCall

type ToolCall struct {
	Id       string       `json:"id,omitempty"`
	Type     string       `json:"type,omitempty"`
	Function ToolFunction `json:"function,omitempty"`
}

Tool Call

type ToolFunction

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

Tool Function and Arguments