Переранжировать документы

Переранжирует список документов по релевантности запросу

POST /v1/rerank

Корневой адрес сервиса: https://getrouter.ai

Протокол: Rerank API

Аутентификация: Authorization: Bearer YOUR_API_KEY

Тело запроса

Тело запроса обязательно. Тип содержимого: application/json

Поля запроса

ПолеТипОбязательноОписание
modelstringДа
querystringДаТекст запроса
documentsarray<string or object>ДаСписок документов для переранжирования
top_nintegerНетВернуть не более N результатов
return_documentsbooleanНетПо умолчанию: false

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

curl --request POST \
  --url https://getrouter.ai/v1/rerank \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "model": "MODEL_ID",
  "query": "string",
  "documents": [
    "string"
  ]
}'

Ответы

СтатусОписание
200Документы успешно ранжированы

Поля успешного ответа

ПолеТипОбязательноОписание
idstringНет
resultsarray<object>Нет
metaobjectНет

Пример ответа

{
  "id": "string",
  "results": [
    {
      "index": 1,
      "relevance_score": 1,
      "document": {}
    }
  ],
  "meta": {}
}

Связанное руководство

Подробные сценарии и примеры приведены в руководстве по API Переранжирование.


Эта страница создана из публичной спецификации Relay OpenAPI. Полная спецификация доступна в API Explorer.