本文档介绍文档结构化还原识别TrimDocument的语法及示例。

功能描述

TrimDocument可以对输入文档内容进行解析,输出结构化样式(html或者json)。

前提条件

请确保您已开通文字识别服务,详情请参见服务开通

输入限制

  • 文档类型:当前支持pdf类型。
  • 文档大小:大小不超过10M。
  • URL地址中不能包含中文字符。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String TrimDocument

要执行的操作。取值:TrimDocument。

FileType String pdf

输入文档类型,目前仅支持pdf。

FileURL String https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/ant_ai/ant_doc_scanner/01.pdf

输入文档URL地址。当前仅支持上海地域的OSS链接,如何生成URL请参见生成URL

OutputType String html

识别结果输出类型,体现在结果中content字段的值。可选json或html。

返回数据

名称 类型 示例值 描述
Data Struct

返回的结果数据内容。

Content String 参见返回示例。

解析文档得到的具体结构化内容。

RequestId String E700C1C1-57E4-413A-9987-56A5A0443CE4

请求ID。

示例

请求示例

http(s)://ocr.cn-shanghai.aliyuncs.com/?Action=TrimDocument
&FileType=pdf
&FileURL=https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/ant_ai/ant_doc_scanner/01.pdf
&OutputType=html
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>E700C1C1-57E4-413A-9987-56A5A0443CE4</RequestId>

JSON 格式

{
  "RequestId": "E700C1C1-57E4-413A-9987-56A5A0443CE4"
}

查询任务结果

该接口为异步接口,当前并未返回真实的请求结果,您需要通过返回的RequestId调用GetAsyncJobResult接口来获取该接口的真实请求结果。详情请参见GetAsyncJobResult

错误码

关于文档结构化还原识别的错误码,详情请参见常见错误码