> ## 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.

# embeddings • TypeScript AI Agent SDK

> * Embeddings Module for PraisonAI TypeScript SDK

# embeddings

<Badge color="green">TypeScript AI Agent</Badge>

* Embeddings Module for PraisonAI TypeScript SDK
* Python parity with praisonaiagents embedding functions
* Provides:

- Embedding generation functions
- Async embedding variants
- Embedding result types

## Import

```typescript theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
import { embeddings } from 'praisonai';
```

## Classes

<CardGroup cols={2}>
  <Card title="EmbeddingResult" icon="brackets-curly" href="../classes/EmbeddingResult">
    TypeScript EmbeddingResult class
  </Card>

  <Card title="BatchEmbeddingResult" icon="brackets-curly" href="../classes/BatchEmbeddingResult">
    TypeScript BatchEmbeddingResult class
  </Card>

  <Card title="EmbeddingConfig" icon="brackets-curly" href="../classes/EmbeddingConfig">
    TypeScript EmbeddingConfig class
  </Card>
</CardGroup>

## Functions

<CardGroup cols={2}>
  <Card title="setEmbeddingConfig()" icon="function" href="../functions/setEmbeddingConfig">
    Function definition.
  </Card>

  <Card title="getDimensions()" icon="function" href="../functions/getDimensions">
    Function definition.
  </Card>

  <Card title="embed()" icon="function" href="../functions/embed">
    Function definition.
  </Card>

  <Card title="embedding()" icon="function" href="../functions/embedding">
    Function definition.
  </Card>

  <Card title="embeddings()" icon="function" href="../functions/embeddings">
    Function definition.
  </Card>

  <Card title="aembed()" icon="function" href="../functions/aembed">
    Function definition.
  </Card>

  <Card title="aembedding()" icon="function" href="../functions/aembedding">
    Function definition.
  </Card>

  <Card title="aembeddings()" icon="function" href="../functions/aembeddings">
    Function definition.
  </Card>

  <Card title="cosineSimilarity()" icon="function" href="../functions/cosineSimilarity">
    Function definition.
  </Card>

  <Card title="euclideanDistance()" icon="function" href="../functions/euclideanDistance">
    Function definition.
  </Card>

  <Card title="normalizeEmbedding()" icon="function" href="../functions/normalizeEmbedding">
    Function definition.
  </Card>
</CardGroup>

***

## Related Documentation

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

  <Card title="JS Embeddings CLI" icon="terminal" href="/docs/js/embeddings-cli" />
</CardGroup>