document-understanding
2024.10
true
- 入门指南
- 使用 Document Understanding™ API 的示例
- 许可
- 故障排除
Document Understanding API 指南
Last updated 2024年11月11日
概述
Document Understanding TM API 可以替代 RPA 方法。 通过发起 API 调用,您可以完成以下操作:
- 查找有关项目、提取程序或项目中使用的分类器的信息。
- 使用数字化 API。
- 使用专门的术语对文档进行分类(对文档进行分类示例)。
- 使用专用工具提取文档数据(以启动提取字段请求为示例)。
- 验证之前经过数字化、分类和/或提取的信息。
根据您的用例,您可以选择使用异步或同步 API。
在下列情况下使用异步 API:
- 您需要处理超过五页的大型文档。
- 您需要同时处理多个操作。异步 API 允许并发处理并避免空闲时间,从而提高系统吞吐量。这意味着您可以发送文档并继续执行另一个任务,而无需等待响应。
- 您有一个大型数据集需要处理,且需要花费大量时间。
在以下情况下使用同步 API:
- 您需要处理最多包含五页的较小文档。
- 您需要在请求-响应的基础上进行实时交互,并且不需要多任务处理。在等待响应时,同步 API 可以阻止其他操作。
- 您有一个较小的数据集需要处理。
以下状态适用于异步 API:
- 未启动:作业已创建,正在等待处理。
- 运行中:作业已创建,已选取且当前正在处理
- 失败:作业已完成但失败。
- 成功:作业已完成并成功。
分类和提取 API 既可用于同步消耗,也可用于异步消耗。同步消耗支持多页文档,最多 5 页,而异步消耗则通过开始方法发布请求,并通过轮询检索结果。
使用 Document Understanding API 以与通过 RPA 相同的方式使用功能。 要使用 API,您可以使用任何编程/脚本语言(因为调用是使用 HTTP 进行的),包括 RPA。
You can access the APIs via Swagger: In the toolbar of the Document UnderstandingTM service, look for the Rest API dropdown, and click Framework.
要试用这些功能,请将 Swagger 用作沙箱。
您可以选择使用预定义构建模型或自定义构建模型。自定义构建的模型是您在使用“Document Understanding”时创建的模型。预定义模型已经可供使用,其中包括预定义的开箱即用模型。
重要提示:通过调用数字化端点收到的数据将保留 7 天。在此时间范围内,可通过收到的文档 ID 获取结果。然后,您需要提交新的数字化请求。
重要提示:通过调用异步分类和提取端点收到的数据将保留一天(24 小时)。