Document Understanding Project Classifier

UiPath.IntelligentOCR.Activities.DocumentClassification.DuAppClassifier

Description

Classifies documents from a specific Document Understanding modern project, and version, through the classifier trained within that version. Visit Document Understanding for Modern Experience key concepts to learn more about modern projects.

You can use this activity only within a Classify Document Scope.

Compatibilidade do projeto

Windows - Legacy | Windows

Configuração

Painel do Designer

• Project - Select the desired modern project from the dropdown menu. The available options are the following:
  • Predefined: A default option that exposes the public UiPath® classification model. You can select this, if you want to use the out-of-the-box classification capabilities of UiPath®.
  • Generative Predefined – Modern project type that uses pre-trained generative models.
  • Projetos modernos disponíveis na organização e no tenant aos quais o Studio está conectado.
    Observação:

    If you have created more than 500 projects on your tenant and use the Document Understanding Project Classifier 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 classification process. If you select a tag, you cannot select a version. This field is disabled if you select the Predefined project type.

Painel de Propriedades

Comum

• DisplayName - O nome de exibição da atividade.

Autenticação

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 then 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.

  • Insira manualmente o caminho para o Ativo de credenciais do Orchestrator, onde você armazena as credenciais de aplicativos externos para acessar o projeto.

    O formato do caminho deve ser: <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 classification. The URL should be in the following format: https://<baseURL>/<OrganizationName>/<TenantName>.

Entrada

• Project - Select the desired modern project from the dropdown menu. The available options are the following:
  • Predefined: A default option that exposes the public UiPath® classification model. You can select this, if you want to use the out-of-the-box classification capabilities of UiPath®.
  • Projetos modernos disponíveis na organização e no tenant aos quais seu Studio está conectado.
• 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 classification process. If you select a tag, you cannot select a version. This field is disabled if you select the Predefined project type.
• Tempo limite (milissegundos) — especifica a quantidade de tempo (em milissegundos) para aguardar que a atividade seja executada antes de gerar um erro. O valor padrão é de 30.000 milissegundos (30 segundos).
• Version - Select the deployed version of the desired project. This field is disabled if you select the Predefined project type.
  Observação:

  You can use variables in the Project and Version fields.

Diversos

• Privado - Se selecionado, os valores de variáveis e argumentos não são mais registrados no nível Verbose.

Saída

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

Configuração do classificador de projeto do Document Understanding

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

Observação:

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 classifier 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.
   1. App Id: Enter the App ID you generated from the external application in the organization you're trying to access.
   2. App Secret: Enter the App Secret generated from the same external application.
   3. 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 Version, select a version for your chosen project. After you select a version, you cannot select a project tag.
5. 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.
6. Select Get Capabilities.
   Observação:

   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