embeddings

Documentation

Index

• type CachedProvider
  • func NewCachedProvider(provider Provider, maxSize int) *CachedProvider
  • func (c *CachedProvider) ClearCache()
  • func (c *CachedProvider) GenerateEmbedding(ctx context.Context, text string) ([]float32, error)
  • func (c *CachedProvider) GetModel() EmbeddingModel
  • func (c *CachedProvider) MaxSize() int
  • func (c *CachedProvider) Size() int
• type DiskCacheEntry
• type DiskCacheProvider
  • func NewDiskCacheProvider(provider Provider, opts ...Option) (*DiskCacheProvider, error)
  • func (p *DiskCacheProvider) ClearCache() error
  • func (p *DiskCacheProvider) GenerateEmbedding(ctx context.Context, text string) ([]float32, error)
  • func (p *DiskCacheProvider) GetCachedEntry(text string) (*DiskCacheEntry, error)
  • func (p *DiskCacheProvider) GetModel() EmbeddingModel
• type EmbeddingModel
• type OllamaProvider
  • func NewOllamaProvider(baseURL string, model string, dimensions int) *OllamaProvider
  • func (p *OllamaProvider) GenerateEmbedding(ctx context.Context, text string) ([]float32, error)
  • func (p *OllamaProvider) GetModel() EmbeddingModel
• type OpenAIProvider
  • func NewOpenAIProvider(apiKey string, model openai.EmbeddingModel, dimensions int) *OpenAIProvider
  • func (p *OpenAIProvider) GenerateEmbedding(ctx context.Context, text string) ([]float32, error)
  • func (p *OpenAIProvider) GetModel() EmbeddingModel
• type Option
  • func WithDirectory(dir string) Option
  • func WithMaxEntries(count int) Option
  • func WithMaxSize(size int64) Option
• type Provider
• type SettingsFactory
  • func NewSettingsFactory(stepSettings *settings.StepSettings) *SettingsFactory
  • func (f *SettingsFactory) NewCachedProvider(maxSize int) (Provider, error)
  • func (f *SettingsFactory) NewProvider() (Provider, error)

Types

type CachedProvider

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

CachedProvider wraps an embedding provider with LRU caching capabilities

func NewCachedProvider

func NewCachedProvider(provider Provider, maxSize int) *CachedProvider

NewCachedProvider creates a new cached wrapper around an embedding provider maxSize determines how many embeddings to keep in cache (default 1000)

func (*CachedProvider) ClearCache

func (c *CachedProvider) ClearCache()

ClearCache removes all cached embeddings

func (*CachedProvider) GenerateEmbedding

func (c *CachedProvider) GenerateEmbedding(ctx context.Context, text string) ([]float32, error)

GenerateEmbedding returns cached embeddings if available, otherwise generates new ones

func (*CachedProvider) GetModel

func (c *CachedProvider) GetModel() EmbeddingModel

GetModel delegates to the underlying provider

func (*CachedProvider) MaxSize

func (c *CachedProvider) MaxSize() int

MaxSize returns the maximum number of embeddings that can be cached

func (*CachedProvider) Size

func (c *CachedProvider) Size() int

Size returns the current number of cached embeddings

type DiskCacheEntry

type DiskCacheEntry struct {
	Embedding  []float32 `json:"embedding"`
	TextPrefix string    `json:"text_prefix"` // First 100 chars
}

DiskCacheEntry represents a single cached embedding with metadata

type DiskCacheProvider

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

DiskCacheProvider implements the Provider interface with disk persistence

func NewDiskCacheProvider

func NewDiskCacheProvider(provider Provider, opts ...Option) (*DiskCacheProvider, error)

NewDiskCacheProvider creates a new disk-based cache provider

func (*DiskCacheProvider) ClearCache

func (p *DiskCacheProvider) ClearCache() error

func (*DiskCacheProvider) GenerateEmbedding

func (p *DiskCacheProvider) GenerateEmbedding(ctx context.Context, text string) ([]float32, error)

func (*DiskCacheProvider) GetCachedEntry

func (p *DiskCacheProvider) GetCachedEntry(text string) (*DiskCacheEntry, error)

func (*DiskCacheProvider) GetModel

func (p *DiskCacheProvider) GetModel() EmbeddingModel

type EmbeddingModel

type EmbeddingModel struct {
	Name       string
	Dimensions int
}

EmbeddingModel contains metadata about the embedding model

type OllamaProvider

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

func NewOllamaProvider

func NewOllamaProvider(baseURL string, model string, dimensions int) *OllamaProvider

func (*OllamaProvider) GenerateEmbedding

func (p *OllamaProvider) GenerateEmbedding(ctx context.Context, text string) ([]float32, error)

func (*OllamaProvider) GetModel

func (p *OllamaProvider) GetModel() EmbeddingModel

type OpenAIProvider

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

func NewOpenAIProvider

func NewOpenAIProvider(apiKey string, model openai.EmbeddingModel, dimensions int) *OpenAIProvider

func (*OpenAIProvider) GenerateEmbedding

func (p *OpenAIProvider) GenerateEmbedding(ctx context.Context, text string) ([]float32, error)

func (*OpenAIProvider) GetModel

func (p *OpenAIProvider) GetModel() EmbeddingModel

type Option

type Option func(*DiskCacheProvider)

func WithDirectory

func WithDirectory(dir string) Option

func WithMaxEntries

func WithMaxEntries(count int) Option

func WithMaxSize

func WithMaxSize(size int64) Option

type Provider

type Provider interface {
	// GenerateEmbedding creates an embedding vector for the given text
	GenerateEmbedding(ctx context.Context, text string) ([]float32, error)

	// GetModel returns information about the embedding model being used
	GetModel() EmbeddingModel
}

Provider defines the interface for generating embeddings

type SettingsFactory

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

SettingsFactory creates embedding providers based on chat settings

func NewSettingsFactory

func NewSettingsFactory(stepSettings *settings.StepSettings) *SettingsFactory

NewSettingsFactory creates a new factory that uses step settings

func (*SettingsFactory) NewCachedProvider

func (f *SettingsFactory) NewCachedProvider(maxSize int) (Provider, error)

NewCachedProvider creates a new cached embedding provider based on the step settings maxSize determines how many embeddings to keep in cache (default 1000)

func (*SettingsFactory) NewProvider

func (f *SettingsFactory) NewProvider() (Provider, error)

NewProvider creates a new embedding provider based on the step settings