# NVIDIARerank

> **Class** in `langchain_nvidia_ai_endpoints`

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

LangChain Document Compressor that uses the NVIDIA NeMo Retriever Reranking API.

## Signature

```python
NVIDIARerank(
    self,
    *,
    nvidia_api_key: Optional[str] = None,
    api_key: Optional[str] = None,
    **kwargs: Any = {},
)
```

## Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `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`) |
| `**kwargs` | `Any` | No | Additional parameters passed to the underlying client. (default: `{}`) |

## Extends

- `BaseDocumentCompressor`

## Constructors

```python
__init__(
    self,
    *,
    nvidia_api_key: Optional[str] = None,
    api_key: Optional[str] = None,
    **kwargs: Any = {},
)
```

| Name | Type |
|------|------|
| `nvidia_api_key` | `Optional[str]` |
| `api_key` | `Optional[str]` |


## Properties

- `model_config`
- `base_url`
- `top_n`
- `model`
- `truncate`
- `max_batch_size`
- `default_headers`
- `extra_headers`
- `available_models`

## Methods

- [`get_available_models()`](https://reference.langchain.com/python/langchain-nvidia-ai-endpoints/reranking/NVIDIARerank/get_available_models)
- [`compress_documents()`](https://reference.langchain.com/python/langchain-nvidia-ai-endpoints/reranking/NVIDIARerank/compress_documents)
- [`acompress_documents()`](https://reference.langchain.com/python/langchain-nvidia-ai-endpoints/reranking/NVIDIARerank/acompress_documents)

---

[View source on GitHub](https://github.com/langchain-ai/langchain-nvidia/blob/0ca4191cf2239c4990e4706ac1005463f27ff325/libs/ai-endpoints/langchain_nvidia_ai_endpoints/reranking.py#L30)