Call SubmitDocumentAnalyzeJob to parse a document from a URL - Energy Expert

The document parsing operation is used to extract the key content of a document and extract the key-value information from the document based on the preset key-value template. The document parsing operation is an asynchronous operation. You need to call the asynchronous submission service for document parsing and then call the GetDocumentAnalyzeResult operation to perform result polling. The asynchronous submission service supports two methods: local files and URL files. Call the SubmitDocumentAnalyzeJob operation to upload URL files. Call the SubmitDocumentAnalyzeJobAdvance operation to upload local files.

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

none

*All Resource

*

None

Request syntax

POST /api/v1/aidoc/document/submitDocumentAnalyzeJob HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
fileUrl	string	No	Choose one between fileUrl and fileUrlObject: fileUrl: Use the document URL method for a single document (supports documents with up to 1000 pages and within 100MB). fileUrlObject: Use when calling the API via local file upload, for a single document (supports documents with up to 1000 pages and within 100MB). Note Relationship between file parsing methods and supported document types. Long Text RAG: Supports pdf, doc/docx, and up to 1000 pages Image Processing: Supports pdf, jpg, jpeg, png, bmp Long Text Understanding: Supports pdf, doc/docx, xls/xlsx	fileUrl:https://example.com/example.pdf fileUrlObject:FileInputStream generated from a local file
fileName	string	Yes	The filename must include the file type extension.	example.pdf
templateId	string	Yes	The unique extraction template ID is used to specify the key-value pairs to be extracted from the document. You need to log in to the template management page to configure the template and obtain the corresponding template ID.	572d24k0c95a
folderId	string	No	Unique knowledge base folder ID, used for categorizing documents and controlling the scope of online Q&A queries. If empty, the document will be uploaded to the tenant's root directory.	Empty by default
analysisType	string	No	The default extraction method is "doc", with the following optional values: vl: Image processing doc: Long text RAG (Retrieval-Augmented Generation) docUnderstanding: Long text comprehension recommender: Recommendation type	doc

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	Id of the request	4A0AEC56-5C9A-5D47-93DF-7227836FFF82
data	object	The data returned.
jobId	string	The job ID.	bfce2248-1546-4298-8bcf-70ac26e69646

Examples

Success response

JSON format

{
  "requestId": "4A0AEC56-5C9A-5D47-93DF-7227836FFF82",
  "data": {
    "jobId": "bfce2248-1546-4298-8bcf-70ac26e69646"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.