SubmitDocParsingTask - Energy Expert - Alibaba Cloud Documentation Center

Parses content, such as text, tables, and images, from a document. A successful call returns a task ID. You can then call `GetDocParsingResult` to retrieve the parsing results. The `SubmitDocParsingTask` operation asynchronously submits a task for a file URL. The `SubmitDocParsingTaskAdvance` operation asynchronously submits a task for a local file.

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:SubmitDocParsingTask

none

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
fileUrl	string	No	Specify either `fileUrl` or `fileUrlObject`. `fileUrl`: The URL of the document. The document can be up to 3000 pages and 500 MB in size. `fileUrlObject`: Use this parameter when you call the operation to upload a local file. The document can be up to 3000 pages and 500 MB in size. Note Parsing methods and supported document types Long-text retrieval-augmented generation (RAG): Supports PDF, DOC, and DOCX files up to 3000 pages. Image processing: Supports PDF, JPG, JPEG, PNG, and BMP files. Long-text understanding: Supports PDF, DOC, DOCX, XLS, and XLSX files.	fileUrl：https://example.com/example.pdf fileUrlObject：本地文件生成的FileInputStream
fileName	string	Yes	The file name must include the file extension.	example.pdf
folderId	string	Yes	The unique ID of the knowledge base folder. Use this ID to manage document classification and control the scope of documents for online Q&A queries. To get the folder ID, log on to the Document Mind console.	xxxxx
needAnalyzeImg	boolean	No	Specifies whether to parse the image content in the document.	false

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	The request ID.	83A5A7DD-8974-5769-952E-590A97BEA34E
data	object	The returned result.
taskId	string	The task ID.	ae9d07be-1a11-4d30-be75-cc962b98279c

Examples

Success response

JSON format

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E\n",
  "data": {
    "taskId": "ae9d07be-1a11-4d30-be75-cc962b98279c"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.