Automate Document KV Extraction via SubmitVLExtractionTask API - Energy Expert

Extracts key information from documents using KV templates or prompts with the Qwen-VL model, ideal for image extraction. Supports: URL Upload: SubmitVLExtractionTask. Local File Upload: SubmitVLExtractionTaskAdvance

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

none

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
fileUrl	string	No	Choose one of fileUrl or fileUrlObject: fileUrl: Use by providing the document URL, for a single document (supports up to 1000 pages and 100MB in size) fileUrlObject: Use when calling the interface with local file upload, for a single document (supports up to 1000 pages and 100 MB in size) Note The relationship between file parsing methods and supported document types Long Text RAG: Supports pdf, doc/docx, 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 suffix.	example.pdf
folderId	string	Yes	Unique knowledge base folder ID, used when you need to categorize documents and control the scope of online Q&A queries. The folder ID needs to be obtained from the intelligent document console after logging in.	xxxxx
templateId	string	Yes	Unique parsing template ID, used to specify the key-value pairs to be extracted from the document. You need to configure the template on the template management page and then obtain the corresponding template ID.	572d24k0c95a

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	Request ID.	83A5A7DD-8974-5769-952E-590A97BEA34E
data	object	Returned data structure.
taskId	string	Task ID.	411ce93a-7eb5-40cf-836a-53c32f097663

Examples

Success response

JSON format

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": {
    "taskId": "411ce93a-7eb5-40cf-836a-53c32f097663"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.