---
title: "Отсортировать документы по запросу"
method: POST
path: "/v1/rerank"
tags: ["Rerank"]
---

# Отсортировать документы по запросу

`POST /v1/rerank`

## Request

- Base URL: `https://api.hubris.pw`
- URL: `https://api.hubris.pw/v1/rerank`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://api.hubris.pw/oauth/authorize`, token URL `https://api.hubris.pw/oauth/token`, scopes: `chat:write`)

Реранкер (например, `cohere/rerank-v3.5`) сортирует документы по тому, насколько они отвечают на запрос: `results` — номера документов во входном списке и оценка `relevance_score`, лучшие первыми.

Оплата у Cohere — за поиск (`usage.search_units`), у остальных — за токены входа. `usage.cost` — списано в копейках. Стрима нет.

Список моделей: `GET /v1/models?output_modalities=rerank`.

## Request body

- RerankRequest
  - `model` string, required: ID реранкера, например `cohere/rerank-v3.5`. Полный список: GET /v1/models?output_modalities=rerank.
  - `query` string, required: Поисковый запрос, по которому сортируются документы.
  - `documents` RerankDocument[], required: Документы для сортировки: строки или объекты `{ text, image }`.
    - union
      - string
      - object
        - `text` string
        - `image` string: URL или data URI картинки.
  - `top_n` integer: Сколько самых подходящих документов вернуть. По умолчанию все.
  - `user` string: Опциональный идентификатор конечного пользователя.

## Response `200`

Документы, отсортированные по близости к запросу.

- RerankResponse
  - `id` string
  - `model` string, required
  - `results` RerankResult[], required
    - `index` integer, required: Номер документа во входном списке.
    - `relevance_score` number, required: Насколько документ подходит к запросу: чем больше, тем лучше.
    - `document` object
      - `text` string
      - `image` string
  - `usage` RerankUsage, required
    - `total_tokens` integer
    - `search_units` integer: Поисковые единицы — у моделей с оплатой за поиск (Cohere).
    - `cost` number: Списано за запрос, в копейках.

## Other responses

- `400`: Невалидное тело запроса
- `401`: Невалидный API-ключ
- `402`: Недостаточно средств на балансе
- `404`: Модель не найдена или это не реранкер
- `429`: Превышен лимит запросов
- `502`: Ошибка апстрима
- `503`: Курс валют временно недоступен
- `504`: Таймаут апстрима

---

[API](https://skmtc.dev/hubris/apis/hubris-api.md) · [All operations](https://skmtc.dev/hubris/apis/hubris-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hubris/apis/hubris-api/revisions/79ea91ed8f10?raw)