知识引擎原子能力重排序

1. 接口描述

接口请求域名： lkeap.tencentcloudapi.com 。

基于知识引擎精调模型技术的rerank模型，支持对多路召回的结果进行重排序，根据query与切片内容的相关性，按分数由高到低对切片进行排序，并输出对应的打分结果。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：RunRerank。
Version	是	String	公共参数，本接口取值：2024-05-22。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou 。
Query	是	String	查询内容示例值：腾讯知识引擎大模型
Docs.N	是	Array of String	文档列表，最多20个示例值：["腾讯知识引擎","知识引擎大模型"]
Model	否	String	模型名称, 默认: lke-reranker-base 示例值：lke-reranker-base

3. 输出参数

参数名称	类型	描述
ScoreList	Array of Float	相关性, 数值越大越相关示例值：[-19.681953, -19.414124]
Usage	Usage	消耗量，仅返回TotalToken 示例值：{"TotalTokens":3}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 重排序

重排序

输入示例

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

{
    "Query": "知识引擎大模型",
    "Docs": [
        "混元大模型",
        "腾讯知识引擎"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "766383fd-5219-4d13-aa1a-7ae00766640c",
        "ScoreList": [
            -9.006162,
            2.8577538
        ],
        "Usage": {
            "TotalTokens": 27
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。

重排序

本页目录：