AnalyzeVlRealtime - 获取VL实时解析结果_能耗宝(Energy Expert)-阿里云帮助中心

实时VL信息抽取

接口说明

用户通过上传文档 url，获取 VL 实时返回结果。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

energy:AnalyzeVlRealtime

none

*全部资源

*

无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
fileUrl	string	否	fileUrl/fileUrlObject 二选一： fileUrl：以文档 URL 方式使用，单个文档（支持 1000 页以内、100MB 以内的文档） fileUrlObject：以本地文件上传方式调用接口时使用，单个文档（支持 1000 页以内、100 MB 以内的文档）说明文件抽取方式与支持上传的文档类型的关系长文本 RAG：支持 pdf, doc/docx, xlsx, csv, txt，支持 1000 页图片处理：支持 pdf, jpg, jpeg, png, bmp, jpe, tif, tiff, webp, heic 长文本理解：支持 doc/docx, xlsx, pdf, csv, txt	fileUrl: https://example.com/example.pdf fileUrlObject: FileInputStream generated from a local file
templateId	string	否	唯一的抽取模板 ID，用于指定文档要抽取的内容，需登录模板管理页面配置模板后获取对应的模板 ID。	572d24k0c95a
language	string	否	语言，可传参数 zh-CN：中文（默认） en-US：英语	zh-CN

返回参数

名称	类型	描述	示例值
	object	返回结果
requestId	string	请求 ID。	83A5A7DD-8974-5769-952E-590A97BEA34E
data	object	返回结果。
kvListInfo	array<object>	文档抽取结果详情
	object	文档抽取结果详情
keyName	string	字段 Key 名称	租户
keyValue	string	字段 key 值	阿里云xxx有限公司
context	object	召回内容
key	array	key 的召回信息详情
	ContentItem	key 的召回信息详情	bhv_trace_info_invalid
value	array	value 的召回信息详情
	ContentItem	value 的召回信息详情	[{'Id': 'st-265b3d6a-91765', 'Name': 'Sheet3'}, {'Id': 'kgqie6hm', 'Name': 'Sheet1'}, {'Id': 'st-26383f2c-38267', 'Name': 'Sheet2'}]
confidence	object	置信度
keyConfidence	number	key 的置信度	0.9994202852249146
valueConfidence	number	value 的置信度	0.9794202852249146

示例

正常返回示例

JSON格式

{
  "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": "版面内容",
                  "type": "table",
                  "uniqueId": "88c712db271443dd4e3697cb9b5dab3a"
                }
              ],
              "text": "租户是xxx"
            }
          ],
          "value": [
            {
              "score": 0.45,
              "type": "img",
              "extInfo": [
                {
                  "alignment": "center",
                  "index": 8,
                  "level": 2,
                  "pageNum": [
                    1
                  ],
                  "pos": [
                    {
                      "x": 1,
                      "y": 2
                    }
                  ],
                  "subType": "picture",
                  "text": "版面内容",
                  "type": "table",
                  "uniqueId": "88c712db271443dd4e3697cb9b5dab3a"
                }
              ],
              "text": "租户是xxx"
            }
          ],
          "confidence": {
            "keyConfidence": 0.9994202852249146,
            "valueConfidence": 0.9794202852249146
          }
        }
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。