Справочник API
Реранжирование
Переранжирование документов-кандидатов по релевантности запросу.
API Rerank принимает запрос и документы-кандидаты, а затем возвращает результаты, ранжированные по релевантности. Обычно используется после этапа retrieval в RAG-конвейерах.
Эндпоинт
| Метод | Путь | Описание |
|---|---|---|
POST | /v1/rerank | Переранжирование документов-кандидатов |
Поля запроса
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
model | string | Да | Идентификатор модели реранжирования |
query | string | Да | Текст запроса |
documents | array | Да | Документы-кандидаты в виде строк или объектов |
top_n | integer | Нет | Вернуть первые N результатов |
return_documents | boolean | Нет | Включать исходный документ в каждый результат, по умолчанию false |
max_chunk_per_doc | integer | Нет | Максимальное число чанков на документ, в зависимости от поддержки канала |
overlap_tokens | integer | Нет | Количество токенов перекрытия чанков, в зависимости от поддержки канала |
curl
curl https://api.tensoraxis.ai/v1/rerank \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $TENSORAXIS_API_KEY" \
-d '{
"model": "jina-reranker-v2-base-multilingual",
"query": "What is an API gateway?",
"documents": [
"An API gateway handles authentication, routing and rate limiting.",
"A vector database is used for similarity search.",
"Object storage stores files."
],
"top_n": 2,
"return_documents": true
}'Структура ответа
{
"results": [
{
"index": 0,
"relevance_score": 0.98,
"document": "An API gateway handles authentication, routing and rate limiting."
}
],
"usage": {
"total_tokens": 42
}
}Когда return_documents имеет значение false, результаты обычно содержат только index и relevance_score.