ai

Documentation

Index

• Variables
• func ApplyModelConfig(ai AI, cfg ModelConfig)
• func NewLimiter(rpm int64) *rate.Limiter
• type AI
• type Blob
• type ChatResponse
• type ChatSession
• type ChatStream
• type Chatbot
• type ClientConfig
• type ClientOption
  • func WithAPIKey(apiKey string) ClientOption
  • func WithEndpoint(endpoint string) ClientOption
  • func WithLimit(rpm int64) ClientOption
  • func WithModel(model string) ClientOption
  • func WithModelConfig(config ModelConfig) ClientOption
  • func WithProxy(proxy string) ClientOption
• type Content
• type Function
• type FunctionCall
• type FunctionCallingMode
  • func (m *FunctionCallingMode) UnmarshalText(text []byte) error
• type FunctionResponse
• type Image
  • func ImageData(mime string, data []byte) Image
  • func (img Image) Data() (mime string, data []byte)
  • func (img Image) MIMEType() string
• type JSONSchema
• type LLMs
  • func (m LLMs) MarshalText() ([]byte, error)
  • func (m *LLMs) UnmarshalText(text []byte) error
• type Limiter
• type Model
• type ModelConfig
• type Part
• type Schema
• type Text
• type TokenCount

Variables

var ErrAIClosed = errors.New("AI client is nil or already closed")

Functions

func ApplyModelConfig

func ApplyModelConfig(ai AI, cfg ModelConfig)

func NewLimiter

func NewLimiter(rpm int64) *rate.Limiter

Types

type AI

type AI interface {
	LLMs() LLMs
	Model(context.Context) (string, error)

	Limiter

	SetModel(string)
	Model

	Chatbot
	ChatSession() ChatSession

	Close() error
}

type Blob

type Blob struct {
	MIMEType string
	Data     []byte
}

type ChatResponse

type ChatResponse interface {
	Raw() any
	Results() []string
	FunctionCalls() []FunctionCall
	TokenCount() TokenCount
}

type ChatSession

type ChatSession interface {
	Chatbot
	History() []Content
}

type ChatStream

type ChatStream interface {
	Next() (ChatResponse, error)
	Close() error
}

type Chatbot

type Chatbot interface {
	Chat(context.Context, ...Part) (ChatResponse, error)
	ChatStream(context.Context, ...Part) (ChatStream, error)
}

type ClientConfig

type ClientConfig struct {
	LLMs LLMs

	APIKey   string
	Endpoint string
	Proxy    string

	Limit *int64

	Model       string
	ModelConfig ModelConfig
}

type ClientOption

type ClientOption interface {
	Apply(*ClientConfig)
}

func WithAPIKey

func WithAPIKey(apiKey string) ClientOption

func WithEndpoint

func WithEndpoint(endpoint string) ClientOption

func WithLimit

func WithLimit(rpm int64) ClientOption

func WithModel

func WithModel(model string) ClientOption

func WithModelConfig

func WithModelConfig(config ModelConfig) ClientOption

func WithProxy

func WithProxy(proxy string) ClientOption

type Content

type Content struct {
	Parts []Part
	Role  string
}

type Function

type Function struct {
	Name        string
	Description string
	Parameters  Schema
}

type FunctionCall

type FunctionCall struct {
	ID        string
	Name      string
	Arguments string
}

type FunctionCallingMode

type FunctionCallingMode int

const (
	FunctionCallingAuto FunctionCallingMode = iota + 1
	FunctionCallingAny
	FunctionCallingNone
)

func (*FunctionCallingMode) UnmarshalText

func (m *FunctionCallingMode) UnmarshalText(text []byte) error

type FunctionResponse

type FunctionResponse struct {
	ID       string
	Response string
}

type Image

type Image string

func ImageData

func ImageData(mime string, data []byte) Image

func (Image) Data

func (img Image) Data() (mime string, data []byte)

func (Image) MIMEType

func (img Image) MIMEType() string

type JSONSchema

type JSONSchema struct {
	Name        string
	Description string
	Schema      Schema
}

type LLMs

type LLMs string

const (
	ChatGPT   LLMs = "ChatGPT"
	Gemini    LLMs = "Gemini"
	Anthropic LLMs = "Anthropic"
)

func (LLMs) MarshalText

func (m LLMs) MarshalText() ([]byte, error)

func (*LLMs) UnmarshalText

func (m *LLMs) UnmarshalText(text []byte) error

type Limiter

type Limiter interface {
	SetLimit(rpm int64)
	Limit() (rpm int64)
}

type Model

type Model interface {
	SetFunctionCall([]Function, FunctionCallingMode)
	SetCount(x int64)
	SetMaxTokens(x int64)
	SetTemperature(x float64)
	SetTopP(x float64)
	SetJSONResponse(set bool, schema *JSONSchema)
}

type ModelConfig

type ModelConfig struct {
	Count        *int64
	MaxTokens    *int64
	Temperature  *float64
	TopP         *float64
	JSONResponse *bool
	JSONSchema   *JSONSchema
	Tools        []Function
	ToolConfig   FunctionCallingMode
}

type Part

type Part interface {
	// contains filtered or unexported methods
}

type Schema

type Schema struct {
	Type       string         `json:"type"`
	Properties map[string]any `json:"properties"`
	Enum       []string       `json:"enum,omitempty"`
	Items      *Schema        `json:"items,omitempty"`
	Required   []string       `json:"required,omitempty"`
}

type Text

type Text string

type TokenCount

type TokenCount struct {
	Prompt int64
	Result int64
	Total  int64
}