跳转到主要内容
POST
/
v1
/
rerank
文档重排序(Rerank)
curl --request POST \
  --url https://api.gravitex.ai/v1/rerank \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "query": "<string>",
  "documents": [
    {}
  ],
  "top_n": 123,
  "return_documents": true
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.gravitex.ai/llms.txt

Use this file to discover all available pages before exploring further.

简介

根据用户查询对候选文档列表进行相关性重排序,常用于 RAG 检索增强、知识库问答等场景。

认证

Authorization
string
必填
Bearer Token,如 Bearer sk-xxxxxxxxxx

请求参数

model
string
必填
重排序模型,如 rerank-english-v2.0
query
string
必填
查询文本
documents
array
必填
待重排序的文档列表(字符串或对象数组)
top_n
integer
返回前 N 条结果
return_documents
boolean
默认值:"false"
是否在结果中返回文档原文

请求示例

curl -X POST "https://api.gravitex.ai/v1/rerank" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "rerank-english-v2.0",
    "query": "什么是向量数据库?",
    "documents": [
      "向量数据库用于存储和检索嵌入向量",
      "今天天气晴朗",
      "RAG 系统常结合重排序提升召回质量"
    ],
    "top_n": 2,
    "return_documents": true
  }'

常用参数

  • query:用户问题或检索 query
  • documents:候选段落列表
  • top_n:只返回得分最高的 N 条
  • return_documents:为 true 时响应包含原文
响应中的 results 数组包含 indexrelevance_score,按相关性降序排列。