Retrieve Doc Parsing Status via GetDocParsingResult API - Energy Expert

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

energy:GetDocParsingResult

none

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	Request parameters.
taskId	string	Yes	Task ID. The taskId is obtained from the SubmitDocParsingTaskAdvance or SubmitDocParsingTask interfaces.	2c22388d-e2ed-44fe-99e6-99922f15e7bb
returnFormat	string	No	The document parsing result supports two formats: markdown and json. By default, the result is returned in markdown format.	md

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	ID of the request	83A5A7DD-8974-5769-952E-590A97BEA34E
data	object	Returned result.
content	string	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\":\"Cover\",\"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

Success response

JSON format

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": {
    "content": "{\\\"doc_info\\\":{\\\"languages\\\":[\\\"zh\\\",\\\"en\\\"],\\\"doc_type\\\":\\\"pdf\\\",\\\"pdf_toc\\\":[{\\\"title\\\":\\\"Cover\\\",\\\"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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.