Skip to main content

Module embedding

Module embedding 

Source
Expand description

Embedding generation for text vectorization.

Supports multiple embedding backends:

  • Hash-based (default, for testing and offline use)
  • OpenAI API (production, high-quality embeddings)

§Choosing a Backend

BackendQualitySpeedCostOffline
HashLowFastFreeYes
OpenAIHighMediumPaidNo

§Example

use converge_knowledge::embedding::EmbeddingEngine;

// Development/testing: use hash embeddings
let engine = EmbeddingEngine::new(256);

// Production: use OpenAI (reads OPENAI_API_KEY)
let engine = EmbeddingEngine::from_env()?;

// Production with explicit key
let engine = EmbeddingEngine::with_openai("sk-...", None);

Structs§

EmbeddingEngine
Embedding engine for converting text to vectors.
HashEmbedding
Hash-based embedding for testing and development.
OpenAIConfig
Configuration for the OpenAI embedding provider.
OpenAIEmbedding
OpenAI embedding provider with production features.
UsageSnapshot
Snapshot of usage statistics.
UsageStats
Token usage statistics.

Enums§

OpenAIModel
OpenAI embedding models.

Traits§

EmbeddingProvider
Embedding provider trait for different backends.