# NVIDIAEmbeddings

> **Class** in `langchain_nvidia_ai_endpoints`

📖 [View in docs](https://reference.langchain.com/python/langchain-nvidia-ai-endpoints/embeddings/NVIDIAEmbeddings)

Client to NVIDIA embeddings models.

## Signature

```python
NVIDIAEmbeddings(
    self,
    *,
    model: Optional[str] = None,
    nvidia_api_key: Optional[str] = None,
    api_key: Optional[str] = None,
    base_url: Optional[str] = None,
    trucate: Optional[Literal['NONE', 'START', 'END']] = None,
    dimensions: Optional[int] = None,
    **kwargs: Any = {},
)
```

## Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `model` | `Optional[str]` | No | The model to use for embedding. (default: `None`) |
| `nvidia_api_key` | `Optional[str]` | No | The API key to use for connecting to the hosted NIM. (default: `None`) |
| `api_key` | `Optional[str]` | No | Alternative to `nvidia_api_key`. (default: `None`) |
| `base_url` | `Optional[str]` | No | The base URL of the NIM to connect to. Format for base URL is http://host:port (default: `None`) |
| `trucate` | `Optional[Literal['NONE', 'START', 'END']]` | No | `'NONE'`, `'START'`, `'END'`, truncate input text if it exceeds the model's context length. Default is `'NONE'`, which raises an error if an input is too long. (default: `None`) |
| `dimensions` | `Optional[int]` | No | The number of dimensions for the embeddings. This parameter is not supported by all models. (default: `None`) |
| `**kwargs` | `Any` | No | Additional parameters passed to the underlying client. (default: `{}`) |

## Extends

- `BaseModel`
- `Embeddings`

## Constructors

```python
__init__(
    self,
    *,
    model: Optional[str] = None,
    nvidia_api_key: Optional[str] = None,
    api_key: Optional[str] = None,
    base_url: Optional[str] = None,
    trucate: Optional[Literal['NONE', 'START', 'END']] = None,
    dimensions: Optional[int] = None,
    **kwargs: Any = {},
)
```

| Name | Type |
|------|------|
| `model` | `Optional[str]` |
| `nvidia_api_key` | `Optional[str]` |
| `api_key` | `Optional[str]` |
| `base_url` | `Optional[str]` |
| `trucate` | `Optional[Literal['NONE', 'START', 'END']]` |
| `dimensions` | `Optional[int]` |


## Properties

- `model_config`
- `base_url`
- `model`
- `truncate`
- `dimensions`
- `max_batch_size`
- `default_headers`
- `available_models`

## Methods

- [`get_available_models()`](https://reference.langchain.com/python/langchain-nvidia-ai-endpoints/embeddings/NVIDIAEmbeddings/get_available_models)
- [`embed_query()`](https://reference.langchain.com/python/langchain-nvidia-ai-endpoints/embeddings/NVIDIAEmbeddings/embed_query)
- [`embed_documents()`](https://reference.langchain.com/python/langchain-nvidia-ai-endpoints/embeddings/NVIDIAEmbeddings/embed_documents)
- [`aembed_query()`](https://reference.langchain.com/python/langchain-nvidia-ai-endpoints/embeddings/NVIDIAEmbeddings/aembed_query)
- [`aembed_documents()`](https://reference.langchain.com/python/langchain-nvidia-ai-endpoints/embeddings/NVIDIAEmbeddings/aembed_documents)

---

[View source on GitHub](https://github.com/langchain-ai/langchain-nvidia/blob/b5236ff09adef5706ed94acb4af46a8e26908576/libs/ai-endpoints/langchain_nvidia_ai_endpoints/embeddings.py#L21)