openai

Documentation

Index

• type OpenAI
  • func NewOpenAI(opts ...Option) (OpenAI, error)
  • func (e OpenAI) EmbedDocuments(ctx context.Context, texts []string) ([][]float64, error)
  • func (e OpenAI) EmbedQuery(ctx context.Context, text string) ([]float64, error)
• type Option
  • func WithBatchSize(batchSize int) Option
  • func WithClient(client openai.LLM) Option
  • func WithStripNewLines(stripNewLines bool) Option

Types

type OpenAI

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

OpenAI is the embedder using the OpenAI api.

func NewOpenAI

func NewOpenAI(opts ...Option) (OpenAI, error)

NewOpenAI creates a new OpenAI with options. Options for client, strip new lines and batch.

func (OpenAI) EmbedDocuments

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

EmbedDocuments creates one vector embedding for each of the texts.

func (OpenAI) EmbedQuery

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

EmbedQuery embeds a single text.

type Option

type Option func(p *OpenAI)

Option is a function type that can be used to modify the client.

func WithBatchSize

func WithBatchSize(batchSize int) Option

WithBatchSize is an option for specifying the batch size.

func WithClient

func WithClient(client openai.LLM) Option

WithClient is an option for providing the LLM client.

func WithStripNewLines

func WithStripNewLines(stripNewLines bool) Option

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