OrlimeGateway
МоделиДокументацияЗащита данныхКонтакты
Войти
Документация API

Начало работы

Быстрый стартАвторизация и заголовки

Работа с API

Потоковые ответыВызов инструментовРассуждения моделиПродолжение диалоговТокены и стоимостьОшибки и повтор запросов

Текст и данные

Список моделейGETChat CompletionsPOSTResponsesPOSTEmbeddingsPOSTРанжированиеPOSTКлассификацияPOST

Изображения, аудио и видео

Генерация изображенийPOSTСинтез речиPOSTТранскрибацияPOSTСоздание видеоPOSTСтатус видеоGETСкачивание видеоGET
Базовый адресgateway.orlime.ru/v1Открыть каталог моделей

ORLIME GATEWAY / API REFERENCE

Ранжирование

Отсортируйте набор документов по релевантности поисковому запросу. Удобно для второго этапа поиска в RAG.

POST/v1/rerank
ЗаголовкиПараметрыПример запросаОтветОшибки

Заголовки #

AuthorizationBearer <API_KEY>Обязательно
Ключ компании из раздела «API-ключи». Храните на сервере или в переменной окружения. Не вставляйте секретный ключ в браузерный код.
Content-Typeapplication/jsonДля JSON-тела
Кодировка UTF-8. Для файлов используйте multipart/form-data; curl и SDK сами добавят boundary. Для GET и DELETE без тела не нужен.
Acceptapplication/json | text/event-streamНеобязательно
Ожидаемый формат ответа. Для включения SSE нужно также передать stream: true в JSON. Синтез речи и скачивание видео возвращают бинарные данные.

Адрес метода: https://gateway.orlime.ru/v1/rerank

Входные параметры #

modelstringОбязательно
Публичный ID из GET /v1/models. Возможности и допустимые параметры смотрите в карточке модели.
querystringОбязательно
Непустой поисковый запрос.
documentsarrayОбязательно
Непустой массив строк либо объектов с text и/или image для мультимодальных моделей.
top_ninteger > 0Необязательно
Количество лучших результатов.
return_documentsbooleanНеобязательно
Возвращать исходный текст документа вместе с оценкой.

Пример запроса #

cURL
curl --fail-with-body https://gateway.orlime.ru/v1/rerank \
  -H "Authorization: Bearer $ORLIME_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "cohere/rerank-v3.5",
  "query": "Как оплатить счёт?",
  "documents": [
    "Оплатите счёт банковским переводом.",
    "Настройки профиля."
  ],
  "top_n": 1,
  "return_documents": true
}'

Ответ #

idstringВ ответе
Идентификатор ответа Gateway. Для текстовых запросов совпадает с заголовком x-request-id. Используйте для обращения в поддержку.
modelstringВсегда
Публичный ID модели.
resultsarrayВсегда
Результаты ранжирования.
results[].indexintegerЕсли доступно
Индекс в исходном массиве documents.
results[].relevance_scorenumberЕсли доступно
Оценка релевантности. Сравнивайте внутри результатов одной модели.
results[].document.textstringЕсли запрошено и доступно
Исходный текст документа.
usageobjectЕсли доступно
Токены и доступные единицы потребления.
usage.cost_rubstringЕсли расчёт завершён
Сумма фактического списания в рублях за весь запрос. Десятичная строка с 12 знаками после запятой. Отсутствие поля не означает бесплатный запрос.
JSON
{
  "id": "d2075c15-6fde-4ba8-bfd7-a246f58bce11",
  "model": "cohere/rerank-v3.5",
  "results": [
    {
      "index": 0,
      "relevance_score": 0.94,
      "document": {
        "text": "Оплатите счёт банковским переводом."
      }
    }
  ],
  "usage": {
    "total_tokens": 32,
    "cost_rub": "0.010000000000"
  }
}
Заголовки ответа
x-request-idstringОтвет Gateway
ID операции для поиска в журнале и обращения в поддержку. В Chat Completions и Responses совпадает с верхнеуровневым id ответа.
Content-TypestringОтвет Gateway
application/json, text/event-stream или MIME-тип аудио/видео. Ошибки файловых методов могут возвращаться как JSON.
Retry-AfterintegerЕсли возвращён
Число секунд до рекомендуемого повтора. Отсутствие заголовка не означает, что запрос следует немедленно повторять.

Особенности #

  • Streaming не поддерживается. Размер набора документов и поддержка изображений зависят от модели.

Ошибки #

Ошибки возвращаются в объекте error с полями message, type, code и param. Сохраните x-request-id для поиска запроса. Формат и справочник ошибок

Предыдущий разделEmbeddingsСледующий раздел Классификация
© 2026 Orlime Gateway
ДокументацияКонтактыTelegramЗащита данныхПолитика конфиденциальностиСогласие на обработку персональных данныхПубличная офертаФайлы cookie