> ## Documentation Index
> Fetch the complete documentation index at: https://praison.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# embedding • Rust AI Agent SDK

> Embedding Module for PraisonAI Rust SDK

# embedding

<Badge color="orange">Rust AI Agent SDK</Badge>

Embedding Module for PraisonAI Rust SDK

Provides text embedding capabilities with support for multiple providers.

# Example

```rust,ignore theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
use praisonai::{EmbeddingAgent, EmbeddingConfig};

let agent = EmbeddingAgent::new()
.model("text-embedding-3-small")
.build()?;

let embedding = agent.embed("Hello world").await?;
println!("Dimension: {}", embedding.len());
```

## Import

```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
use praisonai::embedding::*;
```

## Classes

<CardGroup cols={2}>
  <Card title="EmbeddingConfig" icon="brackets-curly" href="../classes/EmbeddingConfig">
    Configuration for embedding generation.
  </Card>

  <Card title="EmbeddingResult" icon="brackets-curly" href="../classes/EmbeddingResult">
    Result of an embedding operation.
  </Card>

  <Card title="EmbeddingUsage" icon="brackets-curly" href="../classes/EmbeddingUsage">
    Token usage for embedding operations.
  </Card>

  <Card title="SimilarityResult" icon="brackets-curly" href="../classes/SimilarityResult">
    Similarity search result.
  </Card>

  <Card title="EmbeddingAgentBuilder" icon="brackets-curly" href="../classes/EmbeddingAgentBuilder">
    Builder for EmbeddingAgent.
  </Card>

  <Card title="EmbeddingAgent" icon="brackets-curly" href="../classes/EmbeddingAgent">
    Agent for generating text embeddings. Provides embedding capabilities for text using AI embedding models, with support for batch processing and...
  </Card>
</CardGroup>

## Functions

<CardGroup cols={2}>
  <Card title="cosine_similarity()" icon="function" href="../functions/cosine_similarity">
    Calculate cosine similarity between two vectors.
  </Card>

  <Card title="get_dimensions()" icon="function" href="../functions/get_dimensions">
    Get embedding dimensions for a model.
  </Card>
</CardGroup>

***

## Related Documentation

<CardGroup cols={2}>
  <Card title="Rust Embeddings" icon="code" href="/docs/rust/embeddings" />

  <Card title="Rust Embedding" icon="code" href="/docs/rust/embedding" />

  <Card title="Rust Vector Store" icon="database" href="/docs/rust/vector-store" />
</CardGroup>
