インテリジェント キーワード分類器

UiPath.IntelligentOCR.Activities.DocumentClassification.IntelligentKeywordClassifier

説明

This activity enables any user to classify and split document packages into individual document types. You can only use it together with the Classify Document Scope activity.

プロジェクトの対応 OS

Windows - レガシ | Windows

構成

デザイナー パネル

• ラーニング ファイルのパス - 分類器データを含むファイルへのフル パスです。このフィールドは、文字列と String 型の変数のみをサポートします。

  注:

  一度に設定できるのは、上記のパラメーターのうち 1 つだけです。[ラーニング データ] 文字列または [ラーニング ファイルのパス] 文字列のいずれかを使用できます。

  [ラーニング ファイルのパス] は分類器データを取得する場所から場所を指定します。

  [ラーニング データ] は、その分類器の実際の情報が含まれています。

• Endpoint - The URL to UiPath® server. By default, the endpoint is https://du.uipath.com/svc/intelligentkeywords. For more information about endpoints, visit Document Understanding Public Endpoints.

• API キー - アカウントの API キーを指定します。ローカルのプロジェクト設定または Document Understanding フレームワークで定義されている場合、[API キー] フィールドは自動的に事前入力されます。

プロパティ パネル

共通

• 表示名 - アクティビティの表示名です。

入力

• API キー - アカウントの API キーを指定します。ローカルのプロジェクト設定または Document Understanding フレームワークで定義されている場合、[API キー] フィールドは自動的に事前入力されます。

• Endpoint - The URL to UiPath® server. By default, the endpoint is https://du.uipath.com/svc/intelligentkeywords. For more information about endpoints, visit Document Understanding Public Endpoints.

• ラーニング データ - シリアル化された分類器のデータを含む文字列です。このフィールドは、文字列と String 型の変数のみをサポートします。

• ラーニング ファイルのパス - 分類器データを含むファイルへのフル パスです。このフィールドは、文字列と String 型の変数のみをサポートします。

  注:

  一度に設定できるのは、上記のパラメーターのうち 1 つだけです。[ラーニング データ] 文字列または [ラーニング ファイルのパス] 文字列のいずれかを使用できます。

  [ラーニング ファイルのパス] は分類器データを取得する場所から場所を指定します。

  [ラーニング データ] は、その分類器の実際の情報が含まれています。

• Send documents - When enabled, it allows UiPath® to save the referenced document to improve the algorithm performance. Disabling this feature prevents UiPath® from storing the documents. Regardless of this setting, the algorithm's operation remains unaffected.

その他

• プライベート - オンにした場合、変数および引数の値が Verbose レベルでログに出力されなくなります。
  注:

  ベスト プラクティスは、その場所に空の .json ファイルを作成し、その名前を [ラーニング ファイルのパス] フィールドに使用することです。

分割

• PerformDocumentSplitting - If left unchecked, the model will not perform document splitting, only classification.
• UsePageNumbers - If checked, the mode will use the page numbers feature to decide where to split documents. Use it in case page numbers might improve splitting results.

注:

For optimized splitting performance, use version 6.9.0 or higher.

[学習を管理] ウィザードの使用

[学習を管理] ウィザードにアクセスして、[インテリジェント キーワード分類器] アクティビティを設定します。このウィザードは、ドキュメント分類トレーニング フェーズで収集されたデータをレビューする際にも使用できます。それには、更新されたラーニング ファイルのパスでウィザードを開きます。

このウィザードを使用すると、[インテリジェント キーワード分類器] アクティビティでドキュメントの種類を識別しドキュメントを分類するために使用されるトレーニング データを設定および管理できます。ファイル パスを編集する必要性に合わせて作成されました。代わりに変数付きのラーニング データ オプションが使用される場合、特定のファイル パスを編集するか、この操作を中止するかを確認されます。

注:

[学習を管理] ウィザードは、アクティビティをラーニング ファイルのパス文字列で設定した場合にのみ機能します。変数入力として設定されたラーニング ファイルのパスや、ラーニング データ文字列入力では動作しません。

1. Add an Intelligent Keyword Classifier or Intelligent Keyword Classifier Trainer activity to your workflow.

2. Configure your Intelligent Keyword Classifier activity by adding the path of a .json file. Take the following information into consideration, when configuring the classifier:

   • If no path is provided and the Manage Learning option is selected, then a pop-up is displayed, asking for a Learning File Path input. Once the path is provided, the wizard opens.
   • .json ファイルではなく変数を追加できますが、ウィザードが LearningData 変数に学習パターンを適用することはできないため、編集できる特定のファイルのパスを要求します。

3. Select Manage Learning.

   The Intelligent Keyword Classifier wizard window opens.

   Figure 1. Overview of the Manage Learning section of the Intelligent Keyword Classifier wizard

   

4. If no path is provided and the Manage Learning option is selected, then a pop-up is displayed, asking for a LearningFilePath. Once the path is provided, the wizard opens.

   Figure 2. The Warning pop-up displayed if no path is provided and the Manage Learning option is selected

   

   注:

   .json ファイルが使用できない場合でも、新しい .json ファイルの名前をアクティビティに直接追加することができ、.json ファイルが、指定されたフォルダー内に自動的に作成されます。

In the Manage Learning wizard you can see if a document type has been trained or not by the following labels displayed next to them: Trained on X files, or Start Training. The following screenshot shows a document type that has been trained, one that hasn't, and one that has been trained, and selected, so it can be viewed or deleted.

Figure 3. Document types and their training status within the Manage Learning section of the Intelligent Keyword Classifier

トレーニング データ

For document types that have not been trained yet, design-time training can be performed using the Start Training option. For document types that already have some training, you can either delete it to start over, by using the remove option, or perform extra training (cumulative to the already existing one) using the edit option.

注:

Training files to be used must contain a single document type instance per file. Do not run design-time training on files that contain two or more document types, as your training data will be erroneous.

Once a new training has been initiated, a new screen is displayed asking for the training files and the OCR engine that should be used. The default OCR engine is UiPath® Document OCR. Each OCR engine comes with its own set of custom options.

Figure 4. The wizard that appears after selecting Start Training option

注:

以下の OCR エンジンは、回転されたドキュメントをサポートしていないため、そうしたドキュメントの処理には使用しないでください。

• Microsoft OCR
• Tesseract OCR

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: If set to True, the OCR is applied to all PDF pages of the document.
• False: If set to False, only digitally typed text is extracted.
• Auto: The default value is Auto, determining if the document requires to apply the OCR algorithm depending on the input document.

注:

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 = Your defined variable is replaced by ApplyOcrOnPDF = Auto

トレーニング データをエクスポートする

トレーニング済みのドキュメントの種類から得られたトレーニング データだけをエクスポートすることができます。未トレーニングのドキュメントの種類は選択できません。

Figure 5. Document types in the Intelligent Keyword Classifier which have not been trained, hence the Export option is not available

次の手順に従って、トレーニング データをエクスポートできます。

1. トレーニング済みのドキュメントの種類を選択します。

2. [エクスポート] を選択します。

   If you have unsaved changes, the following message is displayed: "You cannot export while having unsaved changes. Do you want to automatically save before expoerting?". Select Yes to continue the exporting process.

   Figure 6. The Save changes message that shows if you have any unsaved changes before exporting training data

   

3. トレーニング データのアーカイブを希望の名前で保存します。

   エクスポートされたドキュメントの種類のトレーニング データ セットの数を示すメッセージが表示されます。たとえば、「4 個の単語ベクトルをエクスポートしました。」と表示されます。

   Figure 7. Example of the message that displays how many document type training data sets were exported

   

4. Select OK to return to the main screen of the wizard.

トレーニング データをインポートする

次の手順に従って、トレーニング データをインポートできます。

1. [インポート] を選択します。

2. Select the training data archive and then select Open.

3. 必要なドキュメントの種類を選択します。

   Figure 8. Selected document types in the Import Word Vectors section

   

4. [インポート] を選択します。

   トレーニング データがインポートされます。

   Figure 9. The previously selected document types for importing are displayed in the Manage Learning section

   

以下の表は、トレーニング データのインポート時にインポートの種類に基づいて表示されるメッセージについて説明しています。

Table 1. The messages that are displayed for various import types

	表示されるメッセージ
新しいドキュメントの種類と単語ベクトル	このドキュメントの種類は、タクソノミーに追加されます。
新しい単語ベクトル (いずれも定義されたことがないもの)	メッセージは表示されません。
同一のドキュメントの種類と単語ベクトル	このドキュメントの種類の単語ベクトルは上書きされます。

Document Understanding との連携

The Intelligent Keyword Classifier activity is part of the Document Understanding solutions. Visit the Document Understanding Guide for more information.