AnalyzeVlRealtime - Energy Expert - Alibaba Cloud Documentation Center

Extracts information from a VL in real time.

Operation description

You can upload a document URL to retrieve real-time results from a VL.

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

none

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
fileUrl	string	No	Choose either fileUrl or fileUrlObject. fileUrl: The URL of a single document. The document can have up to 1,000 pages and be up to 100 MB in size. fileUrlObject: The local file to upload when you call the API. The document can have up to 1,000 pages and be up to 100 MB in size. Note Relationship between the file extraction method and supported document types: Long-text retrieval-augmented generation (RAG): Supports PDF, DOC/DOCX, XLSX, CSV, and TXT files with up to 1,000 pages. Image processing: Supports PDF, JPG, JPEG, PNG, BMP, JPE, TIF, TIFF, WEBP, and HEIC files. Long-text understanding: Supports DOC/DOCX, XLSX, PDF, CSV, and TXT files.	fileUrl: https://example.com/example.pdf fileUrlObject: FileInputStream generated from a local file
templateId	string	No	The unique ID of the extraction template. This specifies the content to extract from the document. To get the template ID, log on to the template management page and configure a template.	572d24k0c95a
language	string	No	The language. You can set this parameter to one of the following values: zh-CN: Chinese (default) en-US: English	zh-CN

Response elements

Element	Type	Description	Example
	object	The response.
requestId	string	The request ID.	83A5A7DD-8974-5769-952E-590A97BEA34E
data	object	The response data.
kvListInfo	array<object>	The details of the document extraction result.
	object	The details of the document extraction result.
keyName	string	The name of the key field.	租户
keyValue	string	The value of the key field.	阿里云xxx有限公司
context	object	The retrieved content.
key	array	The details of the retrieved information for the key.
	ContentItem	The details of the retrieved information for the key.	bhv_trace_info_invalid
value	array	The details of the retrieved information for the value.
	ContentItem	The details of the retrieved information for the value.	[{'Id': 'st-265b3d6a-91765', 'Name': 'Sheet3'}, {'Id': 'kgqie6hm', 'Name': 'Sheet1'}, {'Id': 'st-26383f2c-38267', 'Name': 'Sheet2'}]
confidence	object	The confidence level.
keyConfidence	number	The confidence level of the key.	0.9994202852249146
valueConfidence	number	The confidence level of the value.	0.9794202852249146

Examples

Success response

JSON format

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": {
    "kvListInfo": [
      {
        "keyName": "租户",
        "keyValue": "阿里云xxx有限公司",
        "context": {
          "key": [
            {
              "score": 0.45,
              "type": "img",
              "extInfo": [
                {
                  "alignment": "center",
                  "index": 8,
                  "level": 2,
                  "pageNum": [
                    1
                  ],
                  "pos": [
                    {
                      "x": 1,
                      "y": 2
                    }
                  ],
                  "subType": "picture",
                  "text": "content",
                  "type": "table",
                  "uniqueId": "88c712db271443dd4e3697cb9b5dab3a"
                }
              ],
              "text": "content"
            }
          ],
          "value": [
            {
              "score": 0.45,
              "type": "img",
              "extInfo": [
                {
                  "alignment": "center",
                  "index": 8,
                  "level": 2,
                  "pageNum": [
                    1
                  ],
                  "pos": [
                    {
                      "x": 1,
                      "y": 2
                    }
                  ],
                  "subType": "picture",
                  "text": "content",
                  "type": "table",
                  "uniqueId": "88c712db271443dd4e3697cb9b5dab3a"
                }
              ],
              "text": "content"
            }
          ],
          "confidence": {
            "keyConfidence": 0.9994202852249146,
            "valueConfidence": 0.9794202852249146
          }
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.