AGTCloud API Docs
文档指南API Reference集成与资源更新与帮助

Rerank

使用查询和候选文档进行相关性精排。

概述

Rerank 接收一个查询和一组候选文档,返回按相关性排列的结果。它通常位于向量召回、关键词召回或混合召回之后,用于从有限候选中选出更相关的内容。

API 接入

Base URL

https://api.agtcloud.cn/v1

执行精排

以下示例使用 Jina 风格的 POST /v1/rerank 请求。

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否Rerank 模型 ID;是否可省略取决于所选格式
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 应使用业务数据评估。

进一步了解

本页目录