semantic_router.encoders.nvidia_nim

This file contains the NimEncoder class which is used to encode text using Nim

nim_to_list

def nim_to_list(embeds: CreateEmbeddingResponse) -> list[list[float]]

Convert a NVIDIA NIM embedding response to a list of embeddings. Arguments:

embeds (CreateEmbeddingResponse): The embedding response returned by the NIM API.

Returns: list[list[float]]: One embedding per input document.

NimEncoder Objects

class NimEncoder(DenseEncoder, AsymmetricDenseMixin)

Class to encode text using Nvidia NIM. Requires a Nim API key from https://build.nvidia.com/ NVIDIA NIM exposes an OpenAI-compatible embeddings endpoint, so this encoder drives it with the OpenAI SDK pointed at https://integrate.api.nvidia.com/v1 rather than depending on LiteLLM. Point base_url at your own host to use a self-hosted NIM. NVIDIA’s nv-embedqa models are asymmetric: queries must be embedded with input_type="query" and stored documents with input_type="passage", so :meth:0 and :meth:1 differ accordingly.

init

def __init__(name: str | None = None,
             api_key: str | None = None,
             score_threshold: float = 0.4,
             base_url: str | None = None)

Initialize the NimEncoder. Arguments:

name (str): The name of the embedding model to use such as “nvidia/nv-embedqa-e5-v5”.
api_key (str): The Nim API key, can also be set via the NVIDIA_NIM_API_KEY environment variable.
score_threshold (float): The score threshold for the embeddings.
base_url (str): Override the NIM API base URL, can also be set via the NVIDIA_NIM_API_BASE environment variable. Use this to target a self-hosted NIM container.

Raises:

ValueError: If no API key is provided or found in the environment.

call

def __call__(docs: list[Any], **kwargs) -> list[list[float]]

Encode a list of text documents into embeddings using NVIDIA NIM. Arguments:

docs (list[Any]): List of text documents to encode.

Returns: list[list[float]]: List of embeddings for each document.

acall

async def acall(docs: list[Any], **kwargs) -> list[list[float]]

Encode a list of text documents into embeddings using NVIDIA NIM asynchronously. Arguments:

docs (list[Any]): List of text documents to encode.

Returns: list[list[float]]: List of embeddings for each document.

Get Started

Client Reference

User Guide

semantic_router.encoders.nvidia_nim

nim_to_list

NimEncoder Objects

init

call

acall

​nim_to_list

​NimEncoder Objects

​__init__

​__call__

​acall

nim_to_list

NimEncoder Objects

init

call

acall