embedding

Documentation

Overview

Package embedding contains the implementation to create vector embeddings from text using different APIs

Index

• type AzureOpenAIOptions
• type Fake
  • func NewFake(size int) *Fake
  • func (e *Fake) EmbedDocuments(ctx context.Context, texts []string) ([][]float64, error)
  • func (e *Fake) EmbedQuery(ctx context.Context, text string) ([]float64, error)
• type OpenAI
  • func NewAzureOpenAI(apiKey, baseURL string, optFns ...func(o *AzureOpenAIOptions)) (*OpenAI, error)
  • func NewOpenAI(apiKey string, optFns ...func(o *OpenAIOptions)) (*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 OpenAIOptions

Types

type AzureOpenAIOptions

type AzureOpenAIOptions struct {
	OpenAIOptions
	APIVersion string
	Deployment string
}

type Fake

type Fake struct {
	Size int
}

func NewFake

func NewFake(size int) *Fake

func (*Fake) EmbedDocuments

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

func (*Fake) EmbedQuery

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

type OpenAI

type OpenAI struct {
	// contains filtered or unexported fields
}

func NewAzureOpenAI

func NewAzureOpenAI(apiKey, baseURL string, optFns ...func(o *AzureOpenAIOptions)) (*OpenAI, error)

func NewOpenAI

func NewOpenAI(apiKey string, optFns ...func(o *OpenAIOptions)) (*OpenAI, error)

func (*OpenAI) EmbedDocuments

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

func (*OpenAI) EmbedQuery

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

type OpenAIOptions

type OpenAIOptions struct {
	// Model name to use.
	ModelName              string
	EmbeddingContextLength int
	// Maximum number of texts to embed in each batch
	ChunkSize int
}