> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nemo/guardrails/v0.24.1/guardrails-python-sdk/nemoguardrails/embeddings/index/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/nemo/guardrails/_mcp/server.

# nemoguardrails.embeddings.index

## Module Contents

### Classes

| Name                                                                  | Description                                                                          |
| --------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| [`EmbeddingsIndex`](#nemoguardrails-embeddings-index-EmbeddingsIndex) | The embeddings index is responsible for computing and searching a set of embeddings. |
| [`IndexItem`](#nemoguardrails-embeddings-index-IndexItem)             | -                                                                                    |

### API

```python
class nemoguardrails.embeddings.index.EmbeddingsIndex()
```

The embeddings index is responsible for computing and searching a set of embeddings.

```python
nemoguardrails.embeddings.index.EmbeddingsIndex._get_embeddings(
    texts: typing.List[str]
)
```

async

```python
nemoguardrails.embeddings.index.EmbeddingsIndex.add_item(
    item: nemoguardrails.embeddings.index.IndexItem
)
```

async

Adds a new item to the index.

```python
nemoguardrails.embeddings.index.EmbeddingsIndex.add_items(
    items: typing.List[nemoguardrails.embeddings.index.IndexItem]
)
```

async

Adds multiple items to the index.

```python
nemoguardrails.embeddings.index.EmbeddingsIndex.build()
```

async

Build the index, after the items are added.

This is optional, might not be needed for all implementations.

```python
nemoguardrails.embeddings.index.EmbeddingsIndex.search(
    text: str,
    max_results: int,
    threshold: typing.Optional[float]
) -> typing.List[nemoguardrails.embeddings.index.IndexItem]
```

async

Searches the index for the closest matches to the provided text.

```python
class nemoguardrails.embeddings.index.IndexItem(
    text: str,
    meta: typing.Dict = dict()
)
```

Dataclass

**`meta`** `Dict = field(default_factory=dict)`

---

**`text`** `str`

---

## Docs

- [nemoguardrails.embeddings.basic](https://docs.nvidia.com/nemo/guardrails/v0.24.1/guardrails-python-sdk/nemoguardrails/embeddings/basic.md)
- [nemoguardrails.embeddings.cache](https://docs.nvidia.com/nemo/guardrails/v0.24.1/guardrails-python-sdk/nemoguardrails/embeddings/cache.md)
- [nemoguardrails.embeddings.providers](https://docs.nvidia.com/nemo/guardrails/v0.24.1/guardrails-python-sdk/nemoguardrails/embeddings/providers.md)
- [nemoguardrails.embeddings.providers.azureopenai](https://docs.nvidia.com/nemo/guardrails/v0.24.1/guardrails-python-sdk/nemoguardrails/embeddings/providers/azureopenai.md)
- [nemoguardrails.embeddings.providers.base](https://docs.nvidia.com/nemo/guardrails/v0.24.1/guardrails-python-sdk/nemoguardrails/embeddings/providers/base.md)
- [nemoguardrails.embeddings.providers.cohere](https://docs.nvidia.com/nemo/guardrails/v0.24.1/guardrails-python-sdk/nemoguardrails/embeddings/providers/cohere.md)
- [nemoguardrails.embeddings.providers.fastembed](https://docs.nvidia.com/nemo/guardrails/v0.24.1/guardrails-python-sdk/nemoguardrails/embeddings/providers/fastembed.md)
- [nemoguardrails.embeddings.providers.google](https://docs.nvidia.com/nemo/guardrails/v0.24.1/guardrails-python-sdk/nemoguardrails/embeddings/providers/google.md)
- [nemoguardrails.embeddings.providers.nim](https://docs.nvidia.com/nemo/guardrails/v0.24.1/guardrails-python-sdk/nemoguardrails/embeddings/providers/nim.md)
- [nemoguardrails.embeddings.providers.openai](https://docs.nvidia.com/nemo/guardrails/v0.24.1/guardrails-python-sdk/nemoguardrails/embeddings/providers/openai.md)
- [nemoguardrails.embeddings.providers.registry](https://docs.nvidia.com/nemo/guardrails/v0.24.1/guardrails-python-sdk/nemoguardrails/embeddings/providers/registry.md)
- [nemoguardrails.embeddings.providers.sentence_transformers](https://docs.nvidia.com/nemo/guardrails/v0.24.1/guardrails-python-sdk/nemoguardrails/embeddings/providers/sentence_transformers.md)