AGTCloud API Docs
РуководстваСправочник APIИнтеграции и ресурсыОбновления и помощь

Rerank

Точно ранжируйте документы-кандидаты по релевантности запросу.

Обзор

Rerank получает запрос и набор документов-кандидатов и возвращает результаты в порядке релевантности. Обычно он применяется после векторного, ключевого или гибридного поиска, чтобы выбрать более релевантное содержимое из ограниченного набора кандидатов.

Подключение к API

Base URL

https://api.agtcloud.cn/v1

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

Следующие примеры используют запрос POST /v1/rerank в формате Jina.

curl 'https://api.agtcloud.cn/v1/rerank' \
  -H 'Authorization: Bearer your-api-key' \
  -H 'Content-Type: application/json' \
  --data '{
    "model": "MODEL_ID",
    "query": "Как следует хранить API Key?",
    "documents": [
      "Храните API Key в переменных среды сервера или службе управления секретами.",
      "Каталог моделей показывает доступные модели.",
      "Не размещайте настоящий API Key в браузерном клиенте или публичном репозитории."
    ],
    "top_n": 2
  }'
ПараметрОбязательныйОписание
modelНетID модели Rerank; возможность опустить его зависит от выбранного формата
queryДаТекст запроса для оценки релевантности
documentsДаМассив документов-кандидатов для переранжирования
top_nНетЧисло возвращаемых результатов

Чтение результатов

Результаты упорядочены по релевантности. Используйте results[].index для сопоставления с исходным documents, а results[].relevance_score — для чтения оценки релевантности.

Выбор формата запроса

ФорматПуть запросаAPI Reference
JinaPOST /v1/rerankJina Rerank
CoherePOST /v1/rerankCohere Rerank
XinferencePOST /v1/rerankXinference Rerank

Интерпретация оценок релевантности

  • Оценка релевантности не является вероятностью.
  • Оценки предназначены прежде всего для сравнения кандидатов в рамках одного запроса.
  • Порог и top_n следует оценивать на данных вашего приложения.

Дополнительные материалы

На этой странице