openaichat

Documentation

Index

• type ChatOpenAI
  • func NewChatOpenAI(opts ...ChatOption) (ChatOpenAI, error)
  • func (e ChatOpenAI) EmbedDocuments(ctx context.Context, texts []string) ([][]float64, error)
  • func (e ChatOpenAI) EmbedQuery(ctx context.Context, text string) ([]float64, error)
• type ChatOption
  • func WithBatchSize(batchSize int) ChatOption
  • func WithClient(client openai.Chat) ChatOption
  • func WithStripNewLines(stripNewLines bool) ChatOption

Types

type ChatOpenAI

type ChatOpenAI struct {
	StripNewLines bool
	BatchSize     int
	// contains filtered or unexported fields
}

ChatOpenAI is the embedder using the OpenAI api.

func NewChatOpenAI

func NewChatOpenAI(opts ...ChatOption) (ChatOpenAI, error)

NewChatOpenAI creates a new ChatOpenAI with options. Options for client, strip new lines and batch.

func (ChatOpenAI) EmbedDocuments

func (e ChatOpenAI) EmbedDocuments(ctx context.Context, texts []string) ([][]float64, error)

func (ChatOpenAI) EmbedQuery

func (e ChatOpenAI) EmbedQuery(ctx context.Context, text string) ([]float64, error)

type ChatOption

type ChatOption func(p *ChatOpenAI)

func WithBatchSize

func WithBatchSize(batchSize int) ChatOption

WithBatchSize is an option for specifying the batch size.

func WithClient

func WithClient(client openai.Chat) ChatOption

WithClient is an option for providing the LLM client.

func WithStripNewLines

func WithStripNewLines(stripNewLines bool) ChatOption

WithStripNewLines is an option for specifying the should it strip new lines.