Get the results of a completed run.
The run ID.
Specify whether to use your community account or organization account to complete the request. To use your community account, define as your user ID. To use your organization account, define as your organization ID. If unspecified, defaults to community account context. See Authorization and context identification for details.
Whether to include human review details in the results. When set to true
, details such as review status and edits at the run or document level and at the extracted field level are included.
The following values are returned at the run or document level:
review_completed
files/documents/review_completed
files/documents/class_edit_history
files/documents/class_edit_history/timestamp
files/documents/class_edit_history/user_id
files/documents/class_edit_history/modifications
files/documents/class_edit_history/modifications/message
The following values are returned at the extracted field level:
edit_history
files/edit_history/timestamp
files/edit_history/user_id
files/edit_history/modifications
files/edit_history/modifications/message
See the response schema for details and descriptions.
Whether to include confidence scores in the results. When set to true
, classification confidence scores at the run or document level and extraction confidence scores at the extracted field level are included.
The following values are returned at the run or document level:
files/documents/classification_confidence/ocr
The following values are returned at the extracted field level:
confidence/model
See the response schema for details and descriptions.
Whether to include validation status in the results. When set to true
, validation results at the run or document level and extracted field level are included.
The following values are returned at the run or document level:
files/validations/final_result_pass
The following values are returned at the extracted field level:
validations/valid
validations/alerts
See the response schema for details and descriptions.
Whether to include source information in the results. When set to true
, source details such as the image path of the generated image are included in the results.
The following values are returned at the run or document level:
files/documents/post_processed_paths
The following values are returned at the extracted field level:
source_coordinates/top_x
source_coordinates/top_y
source_coordinates/bottom_x
source_coordinates/bottom_y
source_coordinates/page_number
See the response schema for details and descriptions.
The initial file index to start returning results from. Defaults to 0
.
The batch ID used as input for this run, if run using a batch.
Indicates whether additional results are available beyond those included in the current response.
Indicates whether the run or document has completed review.