tencent cloud

RunRerank
Last updated: 2025-10-30 21:49:14
RunRerank
Last updated: 2025-10-30 21:49:14

1. API Description

Domain name for API request: lkeap.intl.tencentcloudapi.com.

This API is used to reorder the results of multi-channel recall based on the rerank model of knowledge engine fine-tuning model technology, sort the segments according to the relevance between the query and the segment content from high to low score, and output the corresponding scoring results.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: RunRerank.
Version Yes String Common Params. The value used for this API: 2024-05-22.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-jakarta.
Query Yes String Query content.
Docs.N Yes Array of String Document list, up to 20 documents.
Model No String Model name. Default: lke-reranker-base.

3. Output Parameters

Parameter Name Type Description
ScoreList Array of Float Relevance. A higher numeric value indicates greater relevance.
Usage Usage Consumption. Only returns TotalToken.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Reorder

Reorder.

Input Example

POST / HTTP/1.1
Host: lkeap.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RunRerank
<Common request parameters>

{
    "Query": "Knowledge Engine Large Model",
    "Docs": [
        "Hunyuan Large Model",
        "Tencent Knowledge Engine"
    ]
}

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback