Document Understanding 项目提取程序

UiPath.IntelligentOCR.Activities.DataExtraction.DuAppExtractor

描述

Extracts data from documents using a certain modern project and version. Visit Document Understanding for Modern Experience key concepts to learn more about modern projects and document types.

You can use this activity only with the Data Extraction Scope activity.

项目兼容性

Windows - Legacy | Windows

配置

设计器面板

• Project - Select the desired modern project from the dropdown menu. The available options are:
  • Generative Predefined – Modern project type that uses pre-trained generative models.
  • Predefined Non-Latin Languages – Modern project type that uses pre-trained models for non-Latin document processing scenarios.
  • 在 Studio 连接的组织和租户中可用的新式项目。
    备注：

    If you have created more than 500 projects on your tenant and use the Document Understanding Project Extractor activity, UiPath Studio or Studio Web will not display any projects beyond the initial 500. Therefore, those projects cannot be used.

• Version - Select the deployed version of the desired project. If you select a version, you cannot select a tag. This field is disabled if you select the Predefined project type.
• Tag - Select a tag that links directly to a specific version of your chosen project. For example, if you select the Staging tag, the activity uses the project version assigned to this tag during the document extraction process. If you select a tag, you cannot select a version. This field is disabled if you select the Predefined project type.

属性面板

常见

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

身份验证

The Authentication properties of this activity allow you to execute it via on-premises robots. Before configuring these properties, ensure you have fulfilled the prerequisites mentioned on the Configuring Authentication page. Once these steps are completed, you can proceed to fill in the Authentication properties of the activity.

• Runtime Credentials Asset - Use this field when you need to access Document Understanding modern project resources while the robot is connected to a local Orchestrator, or from a different tenant. You can choose to enter a Credential Asset, for authentication purposes, in one of the following ways:

  • From the dropdown list, select the desired Credential Asset from the Orchestrator to which the UiPath® Robot is connected.

  • 如果您在 Orchestrator 凭据资产中存储了用于访问项目的外部应用程序凭据，请手动输入 Orchestrator 凭据资产的路径。

    路径的格式应为： <OrchestratorFolderName>/<AssetName> 。

• Runtime Tenant Url - Use this field, alongside the Runtime Credentials Asset field. Enter the URL of the tenant that the robot will connect to in order to execute the extraction. The URL should be in the following format: https://<baseURL>/<OrganizationName>/<TenantName>.

输入

• Project - Select the desired modern project from the dropdown menu. The available options are:
  • Predefined: A default option that exposes the public UiPath® extraction model. You can select this, if you want to use the out-of-the-box extraction capabilities of UiPath®.
  • Predefined Non-Latin Languages – Modern project type that uses pre-trained models for non-Latin document processing scenarios.
• Tag - Select a tag that links directly to a specific version of your chosen project. For example, if you select the Staging tag, the activity uses the project version assigned to this tag during the document extraction process. If you select a tag, you cannot select a version. This field is disabled if you select the Predefined project type.
• “超时(毫秒)”- 指定最长等待时间（以毫秒为单位），如果超出该时间后活动并未运行，系统便会抛出错误。默认值为 30000 毫秒（30 秒）。
• Version - Select the deployed version of the desired project. This field is disabled if you select the Predefined project type.

其他

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

重要提示：

Ensure that the Project Name is supplied with the exact same letter casing as it was originally defined in the Document Understanding project.

备注：

You can use variables in the Project and Version fields.

输出

• ReferenceDocumentId - Document ID used within the UiPath Document Understanding system. This field only supports string values.

配置 Document Understanding 项目提取程序

To map your taxonomy fields to a specific extractor, perform the following steps in the Configure Extractors Wizard:

备注：

If you wish to use the same project resources at runtime, ensure the Authentication properties of the activity match those in the Get Capabilities wizard.

1. Select Get or refresh extractor capabilities.
2. Configure the Design time credentials that allow you to map the taxonomy fields of a modern project from a specific tenant or organization: Before configuring these properties, ensure you have fulfilled the prerequisites mentioned on the Configuring Authentication page. Once these steps are completed, input your external application credentials into the wizard.
   • App Id: Enter the App ID you generated from the external application in the organization you're trying to access.
   • App Secret: Enter the App Secret generated from the same external application.
   • Tenant Url: Provide the URL of the specific tenant whose resources you wish to use. The format of the URL should be: https://<baseURL>/<OrganizationName>/<TenantName>.
3. Select Get Projects to populate the Project dropdown list with projects from the organization and tenant where you created the external application.
4. For Project, select your desired modern project from the dropdown list.
5. For Version, select a version for your chosen project. After you select a version, you cannot select a project tag.
6. Optionally, for Tag, you can select a tag associated with a version of your chosen project. If you select a tag, its corresponding version is automatically used. Therefore, you cannot select a version, while you are using a tag.
7. Select Get Capabilities.
   备注：

   If you use variables for the Project, Version, and Tag fields, then the Get Capabilities wizard will also request you to select an existing project and version that the robot can access, for configuration purposes.

Figure 1. The Get Capabilities wizard overview