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": [
    {
      "document": "华盛顿特区是美国的首都",
      "index": 0,
      "relevance_score": 0.89
    }
  ],
  "usage": {
    "total_tokens": 256,
    "query_tokens": 32,
    "documents_tokens": 224
  },
  "metadata": {}
}

注：嵌入模型名称设置参考系统支持重排模型列表，切换模型时只需修改对应的模型名称即可。 响应数据格式和OpenAI完全兼容。

​
cURL 请求示例

curl --location 'https://geekai.co/api/v1/rerank' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR_GEEKAI_API_KEY}' \
--data '{
    "model": "rerank-multilingual-v3.0",
    "query": "美国的首都是哪里？",
    "top_n": 3,
    "documents": [
        "卡森市是美国内华达州的首府。",
        "北马里亚纳群岛联邦是一组位于太平洋的岛屿，它的首府是赛班岛。",
        "华盛顿特区（也简称为华盛顿或D.C.，官方称为哥伦比亚特区）是美国的首都，它是一个联邦区。",
        "在英语语法中，大小写是单词开头使用大写字母的规则，英语的使用与其他语言的大小写规则有所不同。",
        "死刑在美国的存在可以追溯到美国成为一个国家之前，截止2017年，死刑在50个州中的30个州是合法的。"
    ]
}

​
Postman 请求响应示例

Authorizations

​
Authorization
string
header
required

JWT认证token

Body

application/json
​
model
string
required

重排模型

Example:

"rerank-multilingual-v3.0"

​
query
string
required

重排提示

Example:

"美国首都是哪里?"

​
documents
string[]
required

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

Example:
["待重排文本1", "待重排文本2", "待重排文本3"]
​
top_n
integer
default:10

返回前N个最匹配结果

Example:

10

​
retries
integer
default:0

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

Example:

0

Response

200
application/json
成功响应
​
model
string
required

使用的重排模型

Example:

"rerank-multilingual-v3.0"

​
results
object[]
required

重排序结果列表

​
usage
object
required
​
metadata
object

额外的元数据信息