Get Results activity - ABBYY Documentation

Get Results retrieves the outcome of a transaction started by the Use Skill activity. Pass the Transaction Id from Use Skill and the activity returns a TransactionStatus plus the per-document results. If the transaction is still being processed, call the activity again after a short delay. If a Review activity has paused the transaction, it returns a Manual Review link instead of final results.

Activity properties

Group	Property	Type	Description
Input	Transaction Id	`Guid`	The identifier of the transaction. Pass to this property the value obtained as the output Transaction Id property of the Use Skill activity.
Input	Delete Transaction	`Boolean`	Specifies whether the completed transaction should be deleted, whether successful or not. The default value is `FALSE`, which means that the transaction is not deleted.
Output	Document Results	`IEnumerable<DocumentResult>`	A collection of result documents after processing.
Output	Review Link	`String`	A link to the ABBYY Vantage Manual Review Client for reviewing the transaction results. Available only if the Process skill contains a Review activity.
Output	Transaction Status	`TransactionStatus`	The status of the transaction. The following statuses are possible: `"New"`, `"Processing"`, `"Review"`, `"Processed"`. Based on the status received, you can configure your UiPath process to run different logic. For example, if the transaction has the `"Processing"` status, wait a few seconds and call the activity again.

When using a Classification skill, Document skill, or OCR skill, all transaction input files will be assembled into one document. When using a Process skill, multiple result documents can be obtained. By default in a Process skill, each input file becomes a separate document in Vantage. Documents can belong to different classes but are processed within the same transaction. To override this assembly, configure the Assemble activity in the Process skill. Each document produces its own results. The Document Results output property returns a collection of DocumentResult instances, one per document in the transaction.

DocumentResult

Name	Type	Description
DocumentId	`String`	The identifier of the document.
ClassificationConfidences	`IEnumerable<ClassificationConfidence>`	A collection of classification confidence values. A list of all the classes available in the Classification skill applied to the document, together with their classification confidence values.
ClassName	`String`	The document class based on the classification results.
ExtractedData	`String`	A JSON string containing the extracted data. Note: For a Process skill, the property can be obtained if the Values, metadata, and field structure for each document option is enabled in the Output activity.
IsClassificationConfident	`Boolean`	The resulting class is deemed to have been determined with confidence if this value is `TRUE`.
ResultFiles	`IReadOnlyDictionary<String,Stream>`	A collection of result files after processing.
DocumentFullText	`String`	The full-text layer of a document that has been captured by ABBYY Vantage. Note: If the skill configuration does not contain a full text export setting, this property will contain the following default value: TXT export was not configured in the ABBYY Vantage skill settings. Please enable TXT export in the skill that you have selected. TXT export is only available for OCR or Processing skills.

All listed parameters are collected in a separate DocumentResult in the Document Results collection. Even if there is only one output document, its output parameters will be available from the first DocumentResult in Document Results collection.

ClassificationConfidence

Name	Type	Description
ClassName	`String`	Vantage document class.
Confidence	`Int`	The degree of confidence that the document belongs to this class. Possible values range from 0 to 100.

The Get Results activity can only be used inside a configured Vantage Scope activity.

The behavior of the Get Results activity depends on the returned Transaction Status.

Transaction Status	Behavior
`Processed`	Processing completed successfully. The results are saved in the output properties.
`New` / `Processing`	The transaction is still being processed. Wait a few seconds and call the Get Results activity again.
`Review`	The transaction has been paused for manual review. The Get Results activity returns a Review Link to the Manual Review Client. Call the activity again after the review is completed to retrieve the final results. For full details, see Process skill.

Results by skill type

The results that the Get Results activity may obtain vary depending on the skill applied to the document.

Classification skill

A Classification skill (such as Vantage Classifier) returns:

Transaction Status
Document Results (for each DocumentResult): DocumentId, ClassificationConfidences, ClassName, IsClassificationConfident, ResultFiles (JSON file containing classification results data)

Document skill

A Document skill (such as Invoice US) returns:

Transaction Status
Document Results (for each DocumentResult): DocumentId, ExtractedData, ResultFiles (the results are contained in two JSON files: the first contains all document data; the second, ending in _fields.json, contains the values of the extracted fields and rule errors)

OCR skill

An OCR skill returns:

Transaction Status
Document Results (for each DocumentResult): DocumentId, ResultFiles (the files match the export configured in the OCR skill), DocumentFullText (if export to TXT is enabled in the skill)

Process skill

The obtained results depend on the activities that make up the Process skill and their settings, in particular the Output activity settings. For more information about the Process skill, see Set up a Process skill. If a Process skill comprises a Classify activity and an Extract activity, you obtain the results described earlier for both a Classification skill and a Document skill. If a Process skill comprises multiple Classify or Extract activities, the results are obtained for the last activities of a particular type.

If the PDF option is enabled in the Exported Data Settings dialog of an Output activity of a Process skill, the results contain the JSON file with the extraction results. They also contain the document image exported to a PDF file with a text layer. For each transaction document, the DocumentFullText parameter is received if export to TXT is enabled in the skill. A Process skill can also contain a Review activity. When such a skill is used for document processing, processing can be suspended if the document requires manual review. In this case, the Get Results activity obtains:

Transaction Status = "Review"
Review Link

Once the manual review and transaction processing are completed, you can obtain the results described earlier by calling the Get Results activity again.

Errors

Transaction processing may fail for a number of reasons (for example, an input file may be corrupted or its format may not be supported by ABBYY Vantage). In that case, the Get Results activity throws an exception.

​Activity properties

​DocumentResult

​ClassificationConfidence

​Results by skill type

​Classification skill

​Document skill

​OCR skill

​Process skill

​Errors

​Related topics

Activity properties

DocumentResult

ClassificationConfidence

Results by skill type

Classification skill

Document skill

OCR skill

Process skill

Errors

Related topics