Files
openrouter-python-sdk-retry…/docs/operations/creatererankresponsebody.mdx
T

16 lines
3.7 KiB
Plaintext

---
title: "CreateRerankResponseBody"
---
Rerank response containing ranked results
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rerank response (ORID format) | gen-rerank-1234567890-abc |
| `model` | *str* | :heavy_check_mark: | The model used for reranking | cohere/rerank-v3.5 |
| `provider` | *Optional[str]* | :heavy_minus_sign: | The provider that served the rerank request | Cohere |
| `results` | List[[operations.Result](../operations/result.mdx)] | :heavy_check_mark: | List of rerank results sorted by relevance | [<br/>\{<br/>"document": \{<br/>"text": "Paris is the capital of France."<br/>},<br/>"index": 0,<br/>"relevance_score": 0.98<br/>}<br/>] |
| `usage` | [Optional[operations.CreateRerankUsage]](../operations/creatererankusage.mdx) | :heavy_minus_sign: | Usage statistics | \{<br/>"search_units": 1,<br/>"total_tokens": 150<br/>} |