メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

Get Results は、Use Skill activity によって開始されたトランザクションの結果を取得します。Use Skill から Transaction Id を渡すと、このアクティビティは TransactionStatus とドキュメントごとの結果を返します。トランザクションがまだ処理中の場合は、少し待ってからこのアクティビティを再度呼び出してください。Review アクティビティによってトランザクションが一時停止されている場合は、最終結果ではなく手動確認リンクを返します。

アクティビティのプロパティ

GroupPropertyTypeDescription
InputTransaction IdGuidトランザクションの識別子です。このプロパティには、Use Skill activity の出力 Transaction Id プロパティから取得した値を渡します。
InputDelete TransactionBoolean完了したトランザクションを、成功したかどうかにかかわらず削除するかどうかを指定します。既定値は FALSE で、この場合トランザクションは削除されません。
OutputDocument ResultsIEnumerable<DocumentResult>処理後の結果ドキュメントのコレクションです。
OutputReview LinkStringABBYY Vantage 手動確認クライアントへのリンクです。ここでトランザクションの結果を確認できます (このリンクを取得できるのは、使用した Process Skill に Review アクティビティが含まれている場合のみです) 。
OutputTransaction StatusTransactionStatusトランザクションのステータスです。指定可能なステータスは次のとおりです: "New""Processing""Review""Processed"。受信したステータスに応じて、UiPath プロセスで異なるロジックを実行するように設定できます。たとえば、トランザクションのステータスが "Processing" の場合は、数秒待ってからアクティビティを再度呼び出します。
分類スキル、Document Skill、または OCR Skill を使用する場合、トランザクションのすべての入力ファイルは 1 つのドキュメントにまとめられます。Process Skill を使用する場合は、複数の結果ドキュメントを取得できます。 既定では、Process Skill では、各入力ファイルが Vantage 内で個別のドキュメントになります。ドキュメントは異なる class に属していてもかまいませんが、同じトランザクション内で処理されます。このアセンブリを変更するには、Process Skill で Assemble アクティビティを設定します。 各ドキュメントは独自の結果を生成します。Document Results 出力プロパティは、トランザクション内のドキュメントごとに 1 つずつ、DocumentResult インスタンスのコレクションを返します。

DocumentResult

NameTypeDescription
DocumentIdStringドキュメントの識別子です。
ClassificationConfidencesIEnumerable<ClassificationConfidence>分類信頼度値のコレクションです。ドキュメントに適用された 分類スキル で使用可能なすべての class の一覧と、それぞれの分類信頼度値が含まれます。
ClassNameString分類結果に基づくドキュメントの class です。
ExtractedDataString抽出データを含む JSON 文字列です。Note: Process Skill の場合、このプロパティは、Output アクティビティ で 各ドキュメントの値、メタデータ、および field 構造 オプションが有効になっている場合に取得できます。
IsClassificationConfidentBooleanこの値が TRUE の場合、結果の class は十分な信頼度で判定されたものと見なされます。
ResultFilesIReadOnlyDictionary<String,Stream>処理後の結果ファイルのコレクションです。
DocumentFullTextStringABBYY Vantage が取得したドキュメントの全文テキストレイヤーです。Note: Skill の構成に全文テキストのエクスポート設定が含まれていない場合、このプロパティには次の既定値が入ります: TXT export was not configured in the ABBYY Vantage skill settings. Please enable TXT export in the skill that you have selected. TXT export は OCR Skill または Processing Skill でのみ利用できます。
一覧にあるすべてのパラメーターは、Document Results コレクション内の個別の DocumentResult に格納されます。出力ドキュメントが 1 つしかない場合でも、その出力パラメーターは Document Results コレクション内の最初の DocumentResult から利用できます。

ClassificationConfidence

NameTypeDescription
ClassNameStringVantage ドキュメントの class です。
ConfidenceIntドキュメントがこの class に属すると判断される信頼度です。指定可能な値は 0 から 100 の範囲です。
Get Results アクティビティは、設定済みの Vantage Scope activity 内でのみ使用できます。
トランザクションの処理が正常に完了した場合 (つまり、Transaction Status = "Processed") 、結果は出力プロパティに保存されます。 トランザクションがまだ処理中の場合 (つまり、Transaction Status = "New" / "Processing") 、数秒待ってから Get Results アクティビティを再度呼び出してください。 Transaction Status = "Review" となる特別なケースについては、以下で説明します。

Skill type ごとの結果

Get Results アクティビティで取得できる結果は、ドキュメントに適用された Skill によって異なります。

分類スキル

分類スキル (例: Vantage Classifier) は次を返します:
  • Transaction Status
  • Document Results (各 DocumentResult): DocumentId, ClassificationConfidences, ClassName, IsClassificationConfident, ResultFiles (分類結果データを含む JSON ファイル)

Document skill

Document skill (例: Invoice US) は次を返します:
  • Transaction Status
  • Document Results (各 DocumentResult): DocumentId, ExtractedData, ResultFiles (結果は 2 つの JSON ファイルに含まれます。1 つ目には文書データ全体が含まれ、2 つ目には抽出されたフィールドの値とルールエラーが含まれます。ファイル名は _fields.json で終わります)

OCR Skill

OCR Skill は次を返します。
  • Transaction Status
  • Document Results (各 DocumentResult): DocumentId, ResultFiles (これらのファイルは、OCR Skill で設定されたエクスポートに対応します), DocumentFullText (Skill で TXT へのエクスポートが有効な場合)

Process Skill

取得される結果は、Process Skill を構成するアクティビティとその設定、特に Output アクティビティの設定によって異なります。Process Skill の詳細については、Process Skill の設定を参照してください。 Process Skill に Classify アクティビティと Extract アクティビティが含まれている場合、上記の結果は分類スキルと Document Skill の両方に対して取得されます。 Process Skill に複数の Classify アクティビティまたは Extract アクティビティが含まれている場合、結果は該当する型の最後のアクティビティに対して取得されます。
Process Skill に複数の Classify アクティビティまたは Extract アクティビティが含まれている場合、結果は該当する型の最後のアクティビティに対して取得されます。
Process Skill の Output アクティビティの Exported Data Settings ダイアログで PDF オプションが有効になっている場合、結果には抽出結果を含む JSON ファイルと、テキストレイヤー付きで PDF ファイルにエクスポートされた文書画像が含まれます。トランザクション内の各文書について、Skill で TXT へのエクスポートが有効になっていれば、DocumentFullText パラメーターが取得されます。 Process Skill には Review アクティビティを含めることもできます。このような Skill を文書処理に使用すると、文書で手動確認が必要な場合に処理が一時停止されることがあります。この場合、Get Results アクティビティでは次の情報が取得されます。
  • Transaction Status = "Review"
  • Review Link
手動確認とトランザクション処理が完了したら、Get Results アクティビティを再度呼び出すことで、上記の結果を取得できます。

エラー

トランザクション処理は、さまざまな理由で失敗することがあります (たとえば、入力ファイルが破損している場合や、その形式が ABBYY Vantage でサポートされていない場合など) 。この場合、Get Results アクティビティは例外をスローします。

Vantage Scope activity

ネストされた Vantage アクティビティに、ABBYY Vantage の接続設定を渡します。

Use Skill activity

Skill を使用してドキュメントを処理するための Vantage トランザクションを作成します。

Map Fields activity

抽出されたフィールド値を UiPath 変数に保存します。