domain

Documentation

Index

• type Choice
• type Message
  • func (m Message) ToYaml() string
• type Provider
• type Question
• type RespChunk
• type Response
• type SourceType
• type Usage

Types

type Choice

type Choice struct {
	Index   int
	Message Message
}

type Message

type Message struct {
	SourceType SourceType `yaml:"source_type"` // system, user or assistant
	Content    string     `yaml:"content"`     // the message content
}

func (Message) ToYaml

func (m Message) ToYaml() string

type Provider

type Provider interface {
	ListModels() ([]string, error)

	// BasicAsk asks a question and returns the answer. The most primitive use case.
	BasicAsk(question Question) (Response, error)
	BasicAskStream(question Question) <-chan RespChunk
}

type Question

type Question struct {
	Messages []Message
}

type RespChunk

type RespChunk struct {
	Resp Response
	Err  error
}

type Response

type Response interface {
	GetChoices() []Choice
	GetUsage() Usage
}

type SourceType

type SourceType string

const (
	System    SourceType = "system"
	User      SourceType = "user"
	Assistant SourceType = "assistant"
)

Using openai naming here, we can change it later

type Usage

type Usage struct {
	PromptTokens     int
	CompletionTokens int
	TotalTokens      int
}