重排序

最近更新时间:2025-06-13 01:33:26

我的收藏

1. 接口描述

接口请求域名: es.tencentcloudapi.com 。

重排是指在 RAG 过程中,通过评估文档与查询之间的相关性,将最相关的文档放在前面,确保语言模型在生成回答时优先考虑排名靠前的上下文,提高生成结果的准确性和可信度,也可以通过这种方式进行过滤,减少大模型成本。
本接口有单账号调用上限控制,如您有提高并发限制的需求请联系我们

默认接口请求频率限制:1000次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RunRerank。
Version String 公共参数,本接口取值:2025-01-01。
Region String 公共参数,详见产品支持的 地域列表
ModelName String 模型名称,可选模型列表:bge-reranker-large,bge-reranker-v2-m3。
示例值:bge-reranker-large
Query String 查询文本。
示例值:今天天气怎样
Documents.N Array of String 待排序的候选doc列表。
示例值:["今天是晴天"]
TopN Integer 排序返回的top文档数量, 如果没有指定则返回全部候选doc,如果指定的top_n值大于输入的候选doc数量,返回全部doc。
示例值:5
ReturnDocuments Boolean 返回的排序结果列表里面是否返回每一条document原文,默认值False。
示例值:true

3. 输出参数

参数名称 类型 描述
Data Array of RerankResult 输出结果集。
Usage Usage 消耗token数量。
示例值:224
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 重排序

输入示例

POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RunRerank
<公共请求参数>

{
    "ModelName": "bge-rerank-large",
    "Query": "你好",
    "Documents": [
        "你好?",
        "你好。"
    ]
}

输出示例

{
    "Response": {
        "Data": [
            {
                "Document": "",
                "Index": 1,
                "RelevanceScore": 0.9998511075973511
            },
            {
                "Document": "",
                "Index": 0,
                "RelevanceScore": 0.9996849298477173
            }
        ],
        "RequestId": "cf9c5598-9625-436d-bc81-8dd3900e63c0",
        "Usage": {
            "TotalTokens": 10
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
RequestLimitExceeded 请求的次数超过了频率限制。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。