Упорядочьте результаты по релевантности
Оцените документы-кандидаты относительно запроса кросс-энкодером и получите их упорядоченными.
Как это работает
- 01
Найдите документы-кандидаты вашим поиском или векторным запросом.
- 02
Отправьте
queryиdocumentsвPOST /api/v1/rerank. - 03
Укажите
top_n, чтобы оставить только лучшие совпадения.
Аутентификация
Передавайте ключ как Authorization: Bearer. Для реранжирования нужно право rerank:write. Клиенты Cohere могут вызывать тот же эндпоинт по адресу /api/v2/rerank.
Пример
Кросс-энкодер читает запрос вместе с каждым документом, поэтому ранжирует точнее, чем одно векторное сходство. Цена растёт с числом кандидатов, поэтому ищите широко, а реранжируйте короткий список.
Справочник API
Поля запросов, ответы, цены и примеры кода для каждого эндпоинта, а также форма, которая отправляет настоящий запрос.
Хранится только в вашем браузере.
Rerank
Cross-encoder reranking for retrieval pipelines. Cohere-compatible — available at both /v1/rerank and /v2/rerank.
POST /v1/rerank
Rerank documents
Scores each document against the query with a cross-encoder and returns them ordered by relevance. Cohere-compatible; the same handler serves `/api/v1/rerank` and `/api/v2/rerank`. Billed per token across the query and all documents.
Pricing
per 1K tokens- Input
- 0.1 credits
Тело запроса
| Поле | Описание |
|---|---|
modelОбязательноstring | maxLen: 128 |
queryОбязательноstring | |
top_ninteger | null | min: 1 |
return_documentsboolean | null | |
documentsОбязательноstring[] |
Ответы
| Заголовок | Описание |
|---|---|
X-Costnumber | The price billed, in credits. |
X-Request-Idstring | Identifies this request. A JSON body carries it as `request_id` too; quote it to support. |
X-RateLimit-Limitinteger | The requests a minute the rate limit on this endpoint allows. Sent once the limit has counted the request, so not when the key itself is refused. |
X-RateLimit-Remaininginteger | How many of them are left this minute. |
| Поле | Описание |
|---|---|
idОбязательноstring | |
modelОбязательноstring | |
resultsОбязательноobject[] | |
metaОбязательноobject | |
usageОбязательноobject |
X-Request-Id: string| Поле | Описание |
|---|---|
errorОбязательноobject | |
request_idОбязательноstring | The same ID as the `X-Request-Id` header. format: uuid |
| Заголовок | Описание |
|---|---|
X-Request-Idstring | Identifies this request. A JSON body carries it as `request_id` too; quote it to support. |
X-RateLimit-Limitinteger | The requests a minute the rate limit on this endpoint allows. Sent once the limit has counted the request, so not when the key itself is refused. |
X-RateLimit-Remaininginteger | How many of them are left this minute. |
| Поле | Описание |
|---|---|
errorОбязательноobject | |
request_idОбязательноstring | The same ID as the `X-Request-Id` header. format: uuid |
| Заголовок | Описание |
|---|---|
X-Request-Idstring | Identifies this request. A JSON body carries it as `request_id` too; quote it to support. |
X-RateLimit-Limitinteger | The requests a minute the rate limit on this endpoint allows. Sent once the limit has counted the request, so not when the key itself is refused. |
X-RateLimit-Remaininginteger | How many of them are left this minute. |
| Поле | Описание |
|---|---|
errorОбязательноobject | |
request_idОбязательноstring | The same ID as the `X-Request-Id` header. format: uuid |
| Заголовок | Описание |
|---|---|
X-Request-Idstring | Identifies this request. A JSON body carries it as `request_id` too; quote it to support. |
X-RateLimit-Limitinteger | The requests a minute the rate limit on this endpoint allows. Sent once the limit has counted the request, so not when the key itself is refused. |
X-RateLimit-Remaininginteger | How many of them are left this minute. |
| Поле | Описание |
|---|---|
errorОбязательноobject | |
request_idОбязательноstring | The same ID as the `X-Request-Id` header. format: uuid |
| Заголовок | Описание |
|---|---|
X-Request-Idstring | Identifies this request. A JSON body carries it as `request_id` too; quote it to support. |
X-RateLimit-Limitinteger | The requests a minute the rate limit on this endpoint allows. Sent once the limit has counted the request, so not when the key itself is refused. |
X-RateLimit-Remaininginteger | How many of them are left this minute. |
| Поле | Описание |
|---|---|
errorОбязательноobject | |
request_idОбязательноstring | The same ID as the `X-Request-Id` header. format: uuid |
| Заголовок | Описание |
|---|---|
X-Request-Idstring | Identifies this request. A JSON body carries it as `request_id` too; quote it to support. |
Retry-Afterinteger | Seconds to wait before retrying. |
X-RateLimit-Limitinteger | The requests a minute the rate limit on this endpoint allows. Sent once the limit has counted the request, so not when the key itself is refused. |
X-RateLimit-Remaininginteger | How many of them are left this minute. |
X-RateLimit-Resetinteger | When the rate limit lets requests through again, as a Unix time in seconds. Sent with a 429 for `rate_limit_exceeded`. |
| Поле | Описание |
|---|---|
errorОбязательноobject | |
request_idОбязательноstring | The same ID as the `X-Request-Id` header. format: uuid |
| Заголовок | Описание |
|---|---|
X-Request-Idstring | Identifies this request. A JSON body carries it as `request_id` too; quote it to support. |
X-RateLimit-Limitinteger | The requests a minute the rate limit on this endpoint allows. Sent once the limit has counted the request, so not when the key itself is refused. |
X-RateLimit-Remaininginteger | How many of them are left this minute. |
| Поле | Описание |
|---|---|
errorОбязательноobject | |
request_idОбязательноstring | The same ID as the `X-Request-Id` header. format: uuid |
| Заголовок | Описание |
|---|---|
X-Request-Idstring | Identifies this request. A JSON body carries it as `request_id` too; quote it to support. |
Retry-Afterinteger | Seconds to wait before retrying. Sent with a 503 during maintenance, when a retry time was set. |
X-RateLimit-Limitinteger | The requests a minute the rate limit on this endpoint allows. Sent once the limit has counted the request, so not when the key itself is refused. |
X-RateLimit-Remaininginteger | How many of them are left this minute. |
| Поле | Описание |
|---|---|
errorОбязательноobject | |
request_idОбязательноstring | The same ID as the `X-Request-Id` header. format: uuid |
Примеры
Попробовать
Укажите API-ключ в панели выше, чтобы отправлять запросы с ключом.