CreateRerankRequestBody - Python SDK

CreateRerankRequestBody method reference

The Python SDK and docs are currently in beta. Report issues on GitHub.

Rerank request input

Fields

FieldTypeRequiredDescriptionExample
documentsList[operations.Document]✔️The list of documents to rerank. Documents may be plain strings, or structured objects with text and/or image for multimodal models.[
“Paris is the capital of France.”,
“Berlin is the capital of Germany.”
]
modelstr✔️The rerank model to usecohere/rerank-v3.5
providerOptionalNullable[components.ProviderPreferences]N/A{"allow_fallbacks": true}
querystr✔️The search query to rerank documents againstWhat is the capital of France?
top_nOptional[int]Number of most relevant documents to return3