Справочник API
Rerank
Переранжирование документов
POST
/v1/rerankПереупорядочивает документы по близости к запросу.
Где использовать
- поиск по базе знаний;
- выбор лучших фрагментов для ответа;
- сортировка результатов поиска;
- улучшение RAG-сценариев.
Обычно приложение сначала получает кандидаты из своего поиска, затем отправляет их в rerank-модель и берёт верхние результаты.
Пример запроса
curl {{PUBLIC_API_BASE_URL}}/rerank \
-H "Authorization: Bearer gw_live_..." \
-H "Content-Type: application/json" \
-d '{
"model": "provider/rerank-model",
"query": "как создать ключ API",
"documents": [
"Откройте раздел Ключи API и нажмите создание.",
"Оплата находится в разделе Биллинг."
]
}'Параметры тела запроса
| Поле | Обязательность | Описание |
|---|---|---|
model | Да | Публичное имя rerank-модели. |
query | Да | Поисковый запрос. |
documents | Да | Массив документов или фрагментов. |
top_n | Нет | Сколько лучших документов вернуть. |
return_documents | Нет | Возвращать ли текст документов в ответе. |
Поля ответа
| Поле | Обязательность | Описание |
|---|---|---|
results | Да | Отсортированные результаты. |
results[].index | Да | Индекс документа во входном массиве. |
results[].relevance_score | Да | Оценка релевантности. |
results[].document | Нет | Документ, если включён возврат документов. |
usage | Нет | Использование токенов, если доступно. |
Пример ответа
{
"results": [
{
"index": 0,
"relevance_score": 0.94
},
{
"index": 1,
"relevance_score": 0.21
}
]
}