基本信息

Action：/reranker

Method： POST

Content-Type：application/json

Authorization：需提前在 API 密钥管理中创建和获取。

计费方式：输入文本的 token 数量。

请求参数

参数 类型 作用 是否必须 示例 备注

model

string

模型

是

bce-reranker-base_v1

-

query

string

查询文本

是

上海天气

长度不超过 1600 个字符

documents

list[string]

需要重排序的文本

是

["上海气候", "北京美食"]

  • 不能为空 List，List 的每个成员不能为空字符串

  • 文本数量不超过 64

  • 每条 document 文本长度不超过 4096 个字符

top_n

int

返回的最相关文本的数量，默认为 document 的数量

否

5

-

响应参数

object string 值为 rerank_list

results 对象数组

document

string

重排序文本内容

relevance_score

float

相似性得分

index

int

序号

usage 对象

prompt_tokens

int

提示词 token 数

total_tokens

int

总 token 数

请求示例

curl -i -X POST \
   -H "Authorization:Bearer sk-xxxxxxxxxxxxxxxxxxx" \
   -H "Content-Type:application/json" \
   -d \
'{
  "model": "bce-reranker-base_v1",
  "query": "上海天气",
  "documents": ["上海气候", "北京美食"],
  "top_n": 2
}' \
 'https://openapi.coreshub.cn/v1/reranker'

响应示例

{
    "object": "rerank_list",
    "results": [
        {
            "document": "上海气候",
            "relevance_score": 0.7059729099273682,
            "index": 0
        },
        {
            "document": "北京美食",
            "relevance_score": 0.36240753531455996,
            "index": 1
        }
    ],
    "usage": {
        "prompt_tokens": 11,
        "total_tokens": 11
    }
}