Document Understanding 活动

表单提取程序

描述​

项目兼容性​

配置​

属性面板​

• “显示名称”- 活动的显示名称。

• ApiKey - Specifies the API key of the account. The API Key field is automatically pre-populated if defined in local project settings or in the Document Understanding framework.
• Endpoint - The URL to UiPath® server. By default, the endpoint is https://du.uipath.com/svc/formextractor. For more information, visit Document Understanding Public Endpoints.
• MinOverlapPercentage - Specifies the minimum overlap area (in percentage) between a box in the document and a box in the template required to make an extraction. The percentage value can be set between 0 and 100. The default value is 65.
• Timeout - Specifies the amount of time (in milliseconds) to wait for a response from the server before an error is thrown. The default value is 100000 milliseconds (100 seconds).

• “私有”- 选中后将不再以“Verbose”级别记录变量和参数的值。
  备注：

  Multiple templates can be defined for one Document Type. When the activity is run, the extractor selects the best matching template based on the information found on the first page.

模板管理器向导​

创建模板​

1. 在“数据提取作用域”内，向工作流添加“表单提取程序”活动。

2. Configure the extractor by selecting Manage Templates.

   系统将打开“模板管理器”窗口。

   Figure 1. Overview of the Template Manager wizard

   

3. Select Create Template for creating a new template. Figure 2. Overview of the Create a new template configuration fields

   

   备注：

   If the UiPath.IntelligentOCR.Activities package has been updated to v5.1.0, then the ForceApplyOCR parameter has been replaced with the ApplyOcrOnPDF. Here is the compatibility between the old and new parameters:

   • ForceApplyOCR = True is replaced by ApplyOcrOnPDF = Yes;
   • ForceApplyOCR = False is replaced by ApplyOcrOnPDF = Auto;
   • ForceApplyOCR = Empty is replaced by ApplyOcrOnPDF = Auto;
   • ForceApplyOCR = <user-defined variable> is replaced by ApplyOcrOnPDF = Auto.

   The Apply OCR on PDF option establishes if the OCR process should be applied or not to PDF documents. Three options are available in the dropdown list: True, False, and Auto. If set to True, the OCR is applied to all PDF pages of the document. If set to False, only digitally typed text is extracted. The default value is Auto, determining if the document requires to apply the OCR algorithm depending on the input document. Each OCR engine comes with its own set of custom options. Visit OCR Engine for more details about all options available for each OCR engine. The default OCR engine is UiPath Document OCR.

4. 从“文档类型”下拉列表中选择模板的文档类型。

   备注：

   所有文档类型均基于分类。确保在项目文件夹中添加或创建分类。

5. 在“模板名称”字段中添加模板的名称。选择反映文档版本或版式的相关名称。

6. Add the document's path in the Template document field. Navigate to the file's path by using the Browse option.

7. Select an OCR from the OCR Engine dropdown list, and configure it according to its needs.

8. Select Configure to trigger the template editing.

配置布尔值字段处理​

导出和导入模板​

导出程序​

1. 按照本页开头说明的步骤创建一个或多个模板。

2. 选择要导出的模板。

3. Select an Export option:

   1. Export with original filesExporting with original files attaches them to the export.

   2. 不带原始文件导出

      Figure 5. The action of selecting the Export with original files options

      

4. 使用所需名称保存模板的存档。

5. A message is displayed once the template is saved. Select OK.

   Figure 6. The "X" template(s) successfully exported message

   

   备注：

   If you cannot share the content of the documents you have built your templates on, then use the Export without original files option. You are still able to share and import the template archive in other projects, but you cannot edit or view them anymore.

   If you want to edit the templates once imported in a different project, make sure to use the Export with original files option when exporting and then importing them.

导入程序​

1. 选择“导入”。

   Figure 7. The action of selecting Import in the Template Manager wizard

   

2. Select an archive. The import wizard appears and presents all document types and all templates available in the selected export archive. Select the templates you wish to import and choose the desired Import option:

   1. 带原始文件导入

   2. Import without original filesFigure 8. The Import options in the Template Manager wizard

      

      备注：

      • 导入模板时，将在项目的分类中自动创建文档类型。如果已经存在名称相同的文档类型，则通过将计数附加到文档类型名称来创建另一个文档类型。
      • 如果要导入已导出但不包含原始文件的模板，或者您选择导入不包含原始文件的模板，则这些模板没有查看或编辑选项。

导入模板时的特殊情况​

• New document type: If a new document type is imported, then a new field is added in the wizard configurator, informing you that a new template is to be created.
• Duplicate document type: If an identical document type is imported, then the following warning message appears: "This template already exists and it will be overwritten."
• Extended template: If a document type template that includes extra fields than the already existing one, is imported, then the following warning message appears: "This document type will be updated as follows: The following field(s) do not exist and will be created".
• Extended document type: If the user imports a document type that includes extra fields than the already existing one, then the following warning message appears: "This document type will be updated as follows: The following field(s) don't have configurations to import".
• Document type with identical name but different content: If the user imports a document type that has the same name as the existing one but different fields, then the following warning message appears: "This document type will be updated as follows":
  • “以下字段不存在，系统将创建相应字段”
  • “以下字段没有要导入的配置”
• Document type with missing table: If the user imports a document type that doesn't include a table, then the following warning message appears: "This document type will be updated as follows: The following field(s) don't have configurations to import."
• Document type with extended table: If the user imports a document type that includes a table with extra columns, then the following warning message appears: "This document will be updated as follows: The following field(s) do not exist and will be created".
• Document type with reduced table: If the user imports a document type that includes a table with missing columns, then the following warning message appears: "This document will be updated as follows: The following field(s) don't have configurations to import"
• Table template with different document types: If you import a document type template that includes a table with different document types, then a new template is created. If your taxonomy includes a table that has a field with a different document type, then the following message appears: "The field with id xyz was found both in the imported taxonomy as well in the existing taxonomy but their types are incompatible (either both should be tables or neither of them)."

模板编辑器向导​

一般注意事项​

• ：设置锚点选择模式；
• ：清除整个锚点选择。

配置锚点​

配置简单字段​

配置表格​

• Define each cell one by one, once the Table Editor is expanded - by adding Custom Area selection to each cell individually;
• 使用表格标记功能 - 通过标记表格区域、绘制行和列分隔符，然后将如此标记的表格分配给字段。确保提取的区域具有与模板区域相同的列数和行数。

1. Select More Options for the table field
2. Select Extract new table.
3. 选择要提取的表格。
4. For every field above each table column, select the column name that you want it to represent. You can also choose to Extract header.
5. Lastly, select Save new table.

锚点配置​

• 确定页面级别模板是否匹配，并根据其确定为最匹配的页面级别模板提取信息；
• 确定任何基于锚点的设置是否匹配，并根据这些设置在待处理文档中的应用提取信息；
• 计算所有可能匹配项的相应置信度分数，以便报告所有可用选项的最佳结果（概率最高的匹配项）。

创建新的锚点设置​

1. Make sure you are in the Anchor Selection mode.

2. 在值区域周围绘制一个方框。

3. 使用以下方法之一为值区域选择标签（主锚点）：

   • 选择第一个单词，然后对所选内容的最后一个单词使用 Ctrl + Select。
   • 选择，拖动，然后释放以捕获词范围。
     备注：

     标签只能包含同一视觉行中的连续词。

4. 选择将用于唯一标识您的标签的任何其他锚点。相同的选择原则也适用。

5. 通过选择特定字段的“提取值”，将锚点结构分配给相应字段。

   Figure 12. Example of creating multiple anchors for a field

   

   备注：

   You can also use the previous examples from this page to learn how to create a template and define extraction areas and anchors.

编辑现有锚点设置​

1. 高亮显示您的锚点设置。

2. 对其进行更改（根据需要删除任何锚点或标签，甚至是删除值区域，以及添加新元素等）。

3. Select More Options for a field anchor, and then use the Change Extracted Value option to update your field association. Figure 13. Example of changing the extracted value for a field

   

   备注：

   • 如果删除目标区域，则会删除所有锚点，并且您需要重新开始。
   • 如果删除标签（主锚点），则第一个锚点（按照创建顺序）将变为新标签。

删除现有锚点设置​

• Select More Options for a field anchor and use the Mark as Missing option for a saved value.

  Figure 14. Example of using the Mark as Missing option to delete an anchor setting

  

• Select More Options for a field anchor and use the Remove Value option, case of a list of anchors defined for a given field.

  Figure 15. Example of using the Remove Value option to delete an anchor setting

  

混合和匹配配置​

Document Understanding 集成​