跳转到主要内容
POST
/
rerank
文本重排序接口
curl --request POST \
  --url https://geekai.co/api/v1/rerank \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "rerank-multilingual-v3.0",
  "query": "美国首都是哪里?",
  "documents": [
    "待重排文本1",
    "待重排文本2",
    "待重排文本3"
  ],
  "top_n": 10,
  "retries": 0
}
'
{
  "model": "rerank-multilingual-v3.0",
  "results": [
    {
      "index": 0,
      "relevance_score": 0.89,
      "document": "华盛顿特区是美国的首都"
    }
  ],
  "usage": {
    "total_tokens": 256,
    "query_tokens": 32,
    "documents_tokens": 224
  },
  "metadata": {}
}
注:嵌入模型名称设置参考系统支持重排模型列表,切换模型时只需修改对应的模型名称即可。 响应数据格式和OpenAI完全兼容。

授权

Authorization
string
header
必填

API认证token

请求体

application/json
model
string
必填

重排模型

示例:

"rerank-multilingual-v3.0"

query
string
必填

重排提示

示例:

"美国首都是哪里?"

documents
string[]
必填

用于重新排序的字符串数组

示例:
["待重排文本1", "待重排文本2", "待重排文本3"]
top_n
integer
默认值:10

返回前N个最匹配结果

示例:

10

retries
integer
默认值:0

自动重试次数,默认0,表示失败不重试

示例:

0

响应

成功响应

model
string
必填

使用的重排模型

示例:

"rerank-multilingual-v3.0"

results
object[]
必填

重排序结果列表

usage
object
必填
metadata
object

额外的元数据信息