schema

Documentation

Index

• type Content
  • func Image(r io.Reader) (*Content, error)
  • func ImageData(path string) (*Content, error)
  • func Text(v string) *Content
  • func ToolResult(id string, result string) *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
• type Model
• type Tool
  • func NewTool(name, description string) *Tool
  • func (t *Tool) AddParameter(name, description string, required bool) error
  • func (t Tool) String() string

Types

type Content

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

	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 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 (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"`
	Data  []Embedding `json:"data"`
	Model string      `json:"model"`
	Usage struct {
		PromptTokerns int `json:"prompt_tokens"`
		TotalTokens   int `json:"total_tokens"`
	} `json:"usage"`
}

An set of created embeddings

type Message

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

	// 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"`
}

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      `json:"message"`
	Index        int    `json:"index"`
	FinishReason string `json:"finish_reason"`
}

One choice of chat completion messages

type Model

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

A model object

type Tool

type Tool struct {
	Name        string          `json:"name"`
	Description string          `json:"description"`
	Parameters  *toolParameters `json:"input_schema,omitempty"`
}

A tool function

func NewTool

func NewTool(name, description string) *Tool

func (*Tool) AddParameter

func (t *Tool) AddParameter(name, description string, required bool) error

func (Tool) String

func (t Tool) String() string