mirror of
https://github.com/wassname/openrouter-python-sdk-retry-errors.git
synced 2026-07-29 11:23:49 +08:00
16 lines
4.8 KiB
Plaintext
16 lines
4.8 KiB
Plaintext
---
|
|
title: "CreateRerankRequestBody"
|
|
---
|
|
|
|
Rerank request input
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `documents` | List[[operations.Document](../operations/document.mdx)] | :heavy_check_mark: | The list of documents to rerank. Documents may be plain strings, or structured objects with `text` and/or `image` for multimodal models. | [<br/>"Paris is the capital of France.",<br/>"Berlin is the capital of Germany."<br/>] |
|
|
| `model` | *str* | :heavy_check_mark: | The rerank model to use | cohere/rerank-v3.5 |
|
|
| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{<br/>"allow_fallbacks": true<br/>} |
|
|
| `query` | *str* | :heavy_check_mark: | The search query to rerank documents against | What is the capital of France? |
|
|
| `top_n` | *Optional[int]* | :heavy_minus_sign: | Number of most relevant documents to return | 3 | |