Domain name for API request: es.ai.intl.tencentcloudapi.com.
This service can accurately convert various types of documents into a standard format to meet the requirements for building an enterprise knowledge base, migrating technical documentation, and structured storage for content platforms.
This API has a model dimensional call limit. Each model has a qps limit of 5. If you need to increase the concurrent limit, please contact us (https://www.tencentcloud.com/act/event/Online_service?from_cn_redirect=1).
A maximum of 20 requests can be initiated per second for this API.
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: ParseDocument. |
| Version | Yes | String | Common Params. The value used for this API: 2025-01-01. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Document | Yes | ParseDocument | File Information |
| ModelName | Yes | String | Model name, doc-llm. |
| Parameter Name | Type | Description |
|---|---|---|
| Progress | String | Progress: 0-100. |
| DocumentParseResultUrl | String | File parsing result. |
| FailedPages | Array of Integer | Page number of the failure. |
| Usage | PageUsage | Page number consumption |
| 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. As a streaming response API, when the request is successfully completed, the RequestId will be placed in the Header "X-TC-RequestId" of the HTTP response. |
POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ParseDocument
<Common request parameters>
{
"Document": {
"FileType": "TXT",
"FileUrl": "",
"FileContent": "data:text/plain;base64,SGVsbG8sIFdvcmxkIQ==",
"DocumentParseConfig": {
"ImageResponseType": 1
},
"FileStartPageNumber": 1,
"FileEndPageNumber": 1
},
"ModelName": "doc-llm"
}
{
"Response": {
"RequestId": "7ab3fd45-61e7-4e5e-8194-b1997f67fc18",
"Progress": "0",
"DocumentParseResultUrl": "",
"FailedPages": [],
"Usage": {
"TotalPages": 1
}
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| MissingParameter | Parameters are missing. |
| UnknownParameter | Unknown parameter error. |
フィードバック