---
title: "NVIDIA Reranker Models with Weaviate"
description: "NVIDIA Reranker Model Provider"
url: https://docs.weaviate.io/weaviate/model-providers/nvidia/reranker
---

# NVIDIA Reranker Models with Weaviate

Weaviate's integration with NVIDIA's APIs allows you to access their models' capabilities directly from Weaviate.

[Configure a Weaviate collection](https://docs.weaviate.io/weaviate/model-providers/nvidia/reranker#configure-the-reranker) to use an NVIDIA reranker model, and Weaviate will use the specified model and your NVIDIA NIM API key to rerank search results.

This two-step process involves Weaviate first performing a search and then reranking the results using the specified model.

![Reranker integration illustration](https://docs.weaviate.io/assets/images/integration_nvidia_reranker-39b96297b3328b26bd490ab92c4e2fcd.png)

## Requirements

### Weaviate configuration

Your Weaviate instance must be configured with the NVIDIA reranker integration (`reranker-nvidia`) module.

**For Weaviate Cloud (WCD) users**

This integration is enabled by default on Weaviate Cloud (WCD) instances.

**For self-hosted users**

- Check the [cluster metadata](https://docs.weaviate.io/deploy/configuration/status#cluster-metadata) to verify if the module is enabled.
- Follow the [how-to configure modules](https://docs.weaviate.io/weaviate/configuration/modules) guide to enable the module in Weaviate.

### API credentials

You must provide a valid NVIDIA NIM API key to Weaviate for this integration. Go to [NVIDIA](https://build.nvidia.com/) to sign up and obtain an API key.

Provide the API key to Weaviate using one of the following methods:

- Set the `NVIDIA_APIKEY` environment variable that is available to Weaviate.
- Provide the API key at runtime, as shown in the examples below.

**Python**

```py
import weaviate
from weaviate.classes.init import Auth
import os

# Recommended: save sensitive data as environment variables
nvidia_key = os.getenv("NVIDIA_API_KEY")
headers = {
    "X-NVIDIA-Api-Key": nvidia_key,
}

client = weaviate.connect_to_weaviate_cloud(
    cluster_url=weaviate_url,                       # `weaviate_url`: your Weaviate URL
    auth_credentials=Auth.api_key(weaviate_key),      # `weaviate_key`: your Weaviate API key
    headers=headers
)

# Work with Weaviate

client.close()
```

**JavaScript/TypeScript**

```ts
import weaviate from '@weaviate/node'

const nvidiaApiKey = process.env.NVIDIA_API_KEY || '';  // Replace with your inference API key

const client = await weaviate.connectToWeaviateCloud(
  'WEAVIATE_INSTANCE_URL',  // Replace with your instance URL
  {
    authCredentials: new weaviate.ApiKey('WEAVIATE_INSTANCE_API_KEY'),
    headers: {
      'X-NVIDIA-Api-Key': nvidiaApiKey,
    }
  }
)

// Work with Weaviate

client.close()
```

## Configure the reranker

> [!NOTE]
>
> **Reranker model integration mutable from `v1.25.23`, `v1.26.8` and `v1.27.1`**
>
> A collection's `reranker` model integration configuration is mutable from `v1.25.23`, `v1.26.8` and `v1.27.1`. See [this section](https://docs.weaviate.io/weaviate/manage-collections/generative-reranker-models#update-the-reranker-model-integration) for details on how to update the collection configuration.

Configure a Weaviate collection to use an NVIDIA reranker model as follows:

**Python**

```py
from weaviate.classes.config import Configure

client.collections.create(
    "DemoCollection",
    reranker_config=Configure.Reranker.nvidia()
    # Additional parameters not shown
)
```

**JavaScript/TypeScript**

```ts
await client.collections.create({
  name: 'DemoCollection',
  reranker: weaviate.configure.reranker.nvidia(),
});
```

### Select a model

You can specify one of the [available models](https://docs.weaviate.io/weaviate/model-providers/nvidia/reranker#available-models) for Weaviate to use, as shown in the following configuration example:

**Python**

```py
from weaviate.classes.config import Configure

client.collections.create(
    "DemoCollection",
    reranker_config=Configure.Reranker.nvidia(
        model="nvidia/llama-3.2-nv-rerankqa-1b-v2",
        base_url="https://ai.api.nvidia.com",
    )
    # Additional parameters not shown
)
```

**JavaScript/TypeScript**

```ts
await client.collections.create({
  name: 'DemoCollection',
  reranker: weaviate.configure.reranker.nvidia({
    model: "nvidia/llama-3.2-nv-rerankqa-1b-v2",
    baseURL: "https://ai.api.nvidia.com"
  }),
});
```

The [default model](https://docs.weaviate.io/weaviate/model-providers/nvidia/reranker#available-models) is used if no model is specified.

## Reranking query

Once the reranker is configured, Weaviate performs [reranking operations](https://docs.weaviate.io/weaviate/search/rerank) using the specified NVIDIA model.

More specifically, Weaviate performs an initial search, then reranks the results using the specified model.

Any search in Weaviate can be combined with a reranker to perform reranking operations.

![Reranker integration illustration](https://docs.weaviate.io/assets/images/integration_nvidia_reranker-39b96297b3328b26bd490ab92c4e2fcd.png)

**Python**

```py
from weaviate.classes.query import Rerank

collection = client.collections.use("DemoCollection")

response = collection.query.near_text(
    query="A holiday film",  # The model provider integration will automatically vectorize the query
    limit=2,
    rerank=Rerank(
        prop="title",                   # The property to rerank on
        query="A melodic holiday film"  # If not provided, the original query will be used
    )
)

for obj in response.objects:
    print(obj.properties["title"])
```

**JavaScript/TypeScript**

```ts
let myCollection = client.collections.use('DemoCollection');

const results = await myCollection.query.nearText(
  ['A holiday film'],
  {
    limit: 2,
    rerank: {
      property: 'title',                // The property to rerank on
      query: 'A melodic holiday film'   // If not provided, the original query will be used
    }
  }
);

for (const obj of results.objects) {
  console.log(obj.properties['title']);
}
```

## References

### Available models

You can use any reranker model [on NVIDIA NIM APIs](https://build.nvidia.com/models) with Weaviate.

The default model is `nvidia/rerank-qa-mistral-4b`.

## Further resources

### Other integrations

- [NVIDIA text embedding models + Weaviate](https://docs.weaviate.io/weaviate/model-providers/nvidia/embeddings).
- [NVIDIA multimodal embedding models + Weaviate](https://docs.weaviate.io/weaviate/model-providers/nvidia/embeddings-multimodal).
- [NVIDIA generative models + Weaviate](https://docs.weaviate.io/weaviate/model-providers/nvidia/generative).

### Code examples

Once the integrations are configured at the collection, the data management and search operations in Weaviate work identically to any other collection. See the following model-agnostic examples:

- The [How-to: Manage collections](https://docs.weaviate.io/weaviate/manage-collections) and [How-to: Manage objects](https://docs.weaviate.io/weaviate/manage-objects) guides show how to perform data operations (i.e. create, read, update, delete collections and objects within them).
- The [How-to: Query & Search](https://docs.weaviate.io/weaviate/search) guides show how to perform search operations (i.e. vector, keyword, hybrid) as well as retrieval augmented generation.

### References

- [NVIDIA NIM API documentation](https://docs.api.nvidia.com/nim/)
