common

Documentation

Index

• type Chat
• type ChatCost
• type ChatGeneration
• type ChatModel
• type ChatOptions
• type ChatResult
  • func (c *ChatResult) CalculateCosts(m *ChatModel)
• type ChatUsage

Types

type Chat

type Chat interface {
	Chat(*memory.Message, ...messages.Message) (ChatResult, error)
	ChatWithContext(context.Context, *memory.Message, ...messages.Message) (ChatResult, error)
	ChatWithOptions(context.Context, ChatOptions) (ChatResult, error)

	ChatStream(io.Writer, *memory.Message, ...messages.Message) (ChatResult, error)
	ChatStreamWithContext(context.Context, io.Writer, *memory.Message, ...messages.Message) (ChatResult, error)
	ChatStreamWithOptions(context.Context, io.Writer, ChatOptions) (ChatResult, error)
}

type ChatCost

type ChatCost struct {
	PromptCost     float64
	CompletionCost float64
	TotalCost      float64
}

type ChatGeneration

type ChatGeneration struct {
	Text         string
	Message      messages.Message
	FinishReason string
}

type ChatModel

type ChatModel schema.Model

type ChatOptions

type ChatOptions interface {
	GetRequest() interface{}
	WithMessages(messages []messages.Message) ChatOptions
	WithModel(model string) ChatOptions
	WithMaxTokens(maxTokens int) ChatOptions
	WithTemperature(temperature float32) ChatOptions
	WithTopP(topP float32) ChatOptions
	WithN(n int) ChatOptions
	WithStream(stream bool) ChatOptions
	WithStop(stop []string) ChatOptions
	WithPresencePenalty(presencePenalty float32) ChatOptions
	WithFrequencyPenalty(frequencyPenalty float32) ChatOptions
	WithLogitBias(logitBias map[string]int) ChatOptions
	WithUser(user string) ChatOptions
	GetSystemMessages() []messages.Message
	GetMessages() []messages.Message
	WithTimeout(time.Duration) ChatOptions
	GetTimeout() time.Duration
	WithSystemPrompt(promptName string) ChatOptions
	WithBootstrap(args interface{}) ChatOptions
	WithExamples(promptName string) ChatOptions
	WithFunctions([]*functions.FunctionDefinition) ChatOptions
	GetFunctions() []*functions.FunctionDefinition
	WithUserMessage(message *memory.Message) ChatOptions
	GetUserMessage() *memory.Message
}

type ChatResult

type ChatResult struct {
	Generations []ChatGeneration
	Usage       ChatUsage
	Cost        ChatCost
}

func (*ChatResult) CalculateCosts

func (c *ChatResult) CalculateCosts(m *ChatModel)

type ChatUsage

type ChatUsage struct {
	PromptTokens     int
	CompletionTokens int
	TotalTokens      int
}