GetSplitDocumentResult

最后更新时间：2025-10-30 21:49:14

GetSplitDocumentResult

最后更新时间： 2025-10-30 21:49:14

1. API Description

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

This API is used to query the results of document splitting tasks.

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: GetSplitDocumentResult.
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.
TaskId	Yes	String	Splitting task ID.

3. Output Parameters

Parameter Name	Type	Description
Status	String	Task status: -Success: execution completed. -Processing: executing. -Pause: paused. -Failed: execution failed. -WaitExecute: pending execution.
DocumentRecognizeResultUrl	String	Temporary download URL for the splitting result. The file is a zip compressed package, and the URL is valid for 30 minutes. The compressed package contains the following folders: .md, .jsonl, mllm.json, images. >jsonl* structure description:. - page_content: Used to generate an embedding library for retrieval purposes. The images in this field will be replaced with placeholders. - org_data: The minimum semantic integrity block corresponding to page_content, used for Q&A model processing. - big_data: The maximum semantic integrity block corresponding to page_content, also used for Q&A model processing.
Usage	DocumentUsage	Amount of the document split task.
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 Query Document Segmentation Results

Query document segmentation results

Input Example

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

{
    "TaskId": "236e51fd-827b-41cb-b303-56003a817ce5"
}

Output Example

{
    "Response": {
        "DocumentRecognizeResultUrl": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/example/example.zip",
        "RequestId": "ffe23ed8-2b64-4835-aedc-ca9a5b5a7384",
        "Status": "Success",
        "Usage": {
            "PageNumber": 10,
            "TotalTokens": 2048
        }
    }
}

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

Tencent Cloud CLI 3.0

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.FileParseError
FailedOperation.FileParseTimeout
FailedOperation.InternalError
InvalidParameter.FileURLInvalid
InvalidParameter.InvalidFileFormat
InvalidParameter.InvalidFileType
RequestLimitExceeded	Too many and frequent requests.
ResourceUnavailable.ResourcePackageRunOut	The account resource package is exhausted.
ResourcesSoldOut.ChargeStatusException	The billing status is abnormal.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud