Справочник API

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

POST/v1/rerank

Оценивает список документов-кандидатов относительно одного запроса. Результаты возвращаются по убыванию релевантности и сохраняют исходный индекс каждого документа.

#Параметры запроса

  • modelstringобязательно

    Точный идентификатор модели реранжирования из актуального каталога моделей.

  • querystringобязательно

    Поисковый запрос или вопрос, по которому оцениваются кандидаты.

  • documentsstring[]обязательно

    Фрагменты-кандидаты для ранжирования. Сохраняйте их исходный порядок в своём приложении.

  • top_nintegerнеобязательно

    Максимальное число возвращаемых результатов.

  • return_documentsbooleanнеобязательно

    Если поддерживается, включать текст документа в каждый результат.

#Связанные ошибки

  • 400 invalid_request_errorquery или documents отсутствует, пуст или не поддерживается этой моделью.
  • 401Bearer-токен недействителен или отсутствует. На этом пути error.code нет — ориентируйтесь на статус.
  • 402 insufficient_user_quotaБаланса кошелька не хватает на предварительно резервируемую сумму.
  • 429Ограничение частоты для ключа. Тело пустое; дождитесь Retry-After. Если же в ответе 429 есть insufficient_user_quota, это дневной лимит расходов.
  • 503 model_not_foundНеизвестная модель, или сейчас её не обслуживает ни один исправный канал.

Полная таблица кодов ошибок →

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

curl https://www.aisplice.store/v1/rerank \
  -H "Authorization: Bearer sk-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "YOUR_RERANK_MODEL",
    "query": "What is the capital of France?",
    "documents": [
      "Paris is the capital of France.",
      "Berlin is in Germany."
    ],
    "top_n": 2
  }'

#Ответ

response.json
{
  "results": [
    { "index": 0, "relevance_score": 0.9821 },
    { "index": 1, "relevance_score": 0.1034 }
  ]
}

Проблема не решена?

Пришлите нам ID запроса или текст ошибки, и мы разберёмся.