All Products
Search
Document Center

Energy Expert:GetDocParsingResult

Last Updated:Aug 19, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

For Querying Document Parsing Results. The input parameter taskId is obtained from the taskId returned by the interfaces SubmitDocParsingTaskAdvance or SubmitDocParsingTask. The query results can be one of three statuses: processing, successful, or failed.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
energy:GetDocParsingResultnone
*All Resources
*
    none
none

Request syntax

POST /api/v2/aidoc/document/getDocParsingResult HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

Request parameters.

taskIdstringYes
  • Task ID.
  • The taskId is obtained from the SubmitDocParsingTaskAdvance or SubmitDocParsingTask interfaces.
2c22388d-e2ed-44fe-99e6-99922f15e7bb
returnFormatstringNo
  • The document parsing result supports two formats: markdown and json.
  • By default, the result is returned in markdown format.
md

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

ID of the request

83A5A7DD-8974-5769-952E-590A97BEA34E
dataobject

Returned result.

contentstring
  • The parsed content of the document.
  • The format (markdown or json) is determined by the returnFormat parameter. For specific format details, refer to: json return structure
{\"doc_info\":{\"languages\":[\"zh\",\"en\"],\"doc_type\":\"pdf\",\"pdf_toc\":[{\"title\":\"封面\",\"level\":0,\"page\":0}],\"pages\":366,\"page_list\":[{\"imageWidth\":596,\"imageHeight\":842,\"pageIdAllDocs\":0,\"fileIndex\":0,\"pageIdCurDoc\":0,\"angle\":0}],\"doc_data\":[{\"uniqueId\":\"about_us_para\",\"page_num\":\"01\",\"index\":\"xxx\",\"name\":\"xxx\",\"type\":\"xxxx\",\"subType\":\"xxx\",\"text\":\"xxx\",\"before_text\":\"xxx\",\"after_text\":\"xxx\",\"extInfo\":[{\"uniqueId\":\"b0x1x0\",\"pos\":[{\"x\":229,\"y\":208},{\"x\":421,\"y\":208},{\"x\":421,\"y\":242},{\"x\":229,\"y\":242}],\"text\":\"Kurt Götze\",\"type\":\"Text\",\"subType\":\"Text\",\"pageNum\":[0],\"index\":0}]}]}}

Examples

Sample success responses

JSONformat

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": {
    "content": "{\\\"doc_info\\\":{\\\"languages\\\":[\\\"zh\\\",\\\"en\\\"],\\\"doc_type\\\":\\\"pdf\\\",\\\"pdf_toc\\\":[{\\\"title\\\":\\\"封面\\\",\\\"level\\\":0,\\\"page\\\":0}],\\\"pages\\\":366,\\\"page_list\\\":[{\\\"imageWidth\\\":596,\\\"imageHeight\\\":842,\\\"pageIdAllDocs\\\":0,\\\"fileIndex\\\":0,\\\"pageIdCurDoc\\\":0,\\\"angle\\\":0}],\\\"doc_data\\\":[{\\\"uniqueId\\\":\\\"about_us_para\\\",\\\"page_num\\\":\\\"01\\\",\\\"index\\\":\\\"xxx\\\",\\\"name\\\":\\\"xxx\\\",\\\"type\\\":\\\"xxxx\\\",\\\"subType\\\":\\\"xxx\\\",\\\"text\\\":\\\"xxx\\\",\\\"before_text\\\":\\\"xxx\\\",\\\"after_text\\\":\\\"xxx\\\",\\\"extInfo\\\":[{\\\"uniqueId\\\":\\\"b0x1x0\\\",\\\"pos\\\":[{\\\"x\\\":229,\\\"y\\\":208},{\\\"x\\\":421,\\\"y\\\":208},{\\\"x\\\":421,\\\"y\\\":242},{\\\"x\\\":229,\\\"y\\\":242}],\\\"text\\\":\\\"Kurt Götze\\\",\\\"type\\\":\\\"Text\\\",\\\"subType\\\":\\\"Text\\\",\\\"pageNum\\\":[0],\\\"index\\\":0}]}]}}"
  }
}

Error codes

For a list of error codes, visit the Service error codes.