embedding

Documentation

Overview

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

Index

• type AzureOpenAIOptions
• type Cohere
  • func NewCohere(apiKey string, optFns ...func(o *CohereOptions)) (*Cohere, error)
  • func NewCohereFromClient(client CohereClient, optFns ...func(o *CohereOptions)) (*Cohere, error)
  • func (e *Cohere) EmbedDocuments(ctx context.Context, texts []string) ([][]float64, error)
  • func (e *Cohere) EmbedQuery(ctx context.Context, text string) ([]float64, error)
• type CohereClient
• type CohereOptions
• 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 NewOpenAIFromClient(client *openai.Client, 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
• type Palm
  • func NewPalm(client PalmClient, optFns ...func(o *PalmOptions)) *Palm
  • func (e *Palm) EmbedDocuments(ctx context.Context, texts []string) ([][]float64, error)
  • func (e *Palm) EmbedQuery(ctx context.Context, text string) ([]float64, error)
• type PalmClient
• type PalmOptions

Types

type AzureOpenAIOptions

type AzureOpenAIOptions struct {
	OpenAIOptions
	APIVersion string
	Deployment string
}

type Cohere

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

Cohere is a client for the Cohere API.

func NewCohere

func NewCohere(apiKey string, optFns ...func(o *CohereOptions)) (*Cohere, error)

NewCohere creates a new Cohere instance with the provided API key and options. It returns the initialized Cohere instance or an error if initialization fails.

func NewCohereFromClient

func NewCohereFromClient(client CohereClient, optFns ...func(o *CohereOptions)) (*Cohere, error)

NewCohereFromClient creates a new Cohere instance from an existing Cohere client and options. It returns the initialized Cohere instance.

func (*Cohere) EmbedDocuments

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

EmbedDocuments embeds a list of documents and returns their embeddings.

func (*Cohere) EmbedQuery

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

EmbedQuery embeds a single query and returns its embedding.

type CohereClient

type CohereClient interface {
	Embed(opts cohere.EmbedOptions) (*cohere.EmbedResponse, error)
}

CohereClient is an interface for the Cohere client.

type CohereOptions

type CohereOptions struct {
	// Model name to use.
	Model string
	// Truncate embeddings that are too long from start or end ("NONE"|"START"|"END")
	Truncate string
}

CohereOptions contains options for configuring the Cohere instance.

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)

EmbedDocuments embeds a list of documents and returns their embeddings.

func (*Fake) EmbedQuery

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

EmbedQuery embeds a single query and returns its embedding.

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 NewOpenAIFromClient

func NewOpenAIFromClient(client *openai.Client, optFns ...func(o *OpenAIOptions)) (*OpenAI, error)

func (*OpenAI) EmbedDocuments

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

EmbedDocuments embeds a list of documents and returns their embeddings.

func (*OpenAI) EmbedQuery

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

EmbedQuery embeds a single query and returns its embedding.

type OpenAIOptions

type OpenAIOptions struct {
	// Model name to use.
	ModelName              string
	EmbeddingContextLength int
	// Maximum number of texts to embed in each batch
	ChunkSize int
	// BaseURL is the base URL of the OpenAI service.
	BaseURL string
	// OrgID is the organization ID for accessing the OpenAI service.
	OrgID string
}

type Palm

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

Palm is a client for the Palm embedding service.

func NewPalm

func NewPalm(client PalmClient, optFns ...func(o *PalmOptions)) *Palm

NewPalm creates a new instance of the Palm client.

func (*Palm) EmbedDocuments

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

EmbedDocuments embeds a list of documents and returns their embeddings.

func (*Palm) EmbedQuery

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

EmbedQuery embeds a single query and returns its embedding.

type PalmClient

type PalmClient interface {
	EmbedText(context.Context, *generativelanguagepb.EmbedTextRequest, ...gax.CallOption) (*generativelanguagepb.EmbedTextResponse, error)
}

PalmClient is an interface for the Palm client.

type PalmOptions

type PalmOptions struct {
	ModelName string
}

PalmOptions contains options for configuring the Palm client.