Skip to main content

Get Prediction File By File ID

AutomatR.Nanonets.Activities.GetPredictionFileByFileID

The "Get Prediction File By File ID" activity in AutomatR is part of the Nanonets OCR PREDICT activities package, allowing users to retrieve prediction results for a specific file using the Nanonets OCR model. This activity facilitates seamless integration with Nanonets services for efficient handling of OCR predictions.

Properties​

NameDescription
Input
Model IDThe ID of the Nanonets OCR model used for prediction. String variables containing the Model ID.
Request File IDThe request file ID of the file received from the asynchronous prediction endpoint. String variables containing the request file ID.
Misc
Display NameProvides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name.
Optional
DelaySpecifies the amount of time (in seconds) to wait before executing the "Get Prediction File By File ID" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1.
Output
ResponseOutputs the detailed response generated by the Nanonets OCR model based on the provided file. The data type is GetPredictionFileByFileIDProperties. Variables of type GetPredictionFileByFileIDProperties to store the prediction details.

How to use:

  1. Drag and drop the "Get Prediction File By File ID" activity onto the workflow.
  2. Configure the properties by specifying the Model ID and Request File ID for the Nanonets OCR model.
  3. Optionally, configure the delay.
  4. Execute the workflow to retrieve detailed prediction results for the specified file using the Nanonets OCR model.

Example: Consider an example where the "Get Prediction File By File ID" activity is used to retrieve prediction results for a file with the Model ID "789" and Request File ID "ABCDE123":

Get Prediction File By File ID:
  Model ID: "789"
  Request File ID: "ABCDE123"
  Delay: 3
  Response: predictionDetails

In this example, the activity retrieves detailed prediction results for the file associated with the Model ID "789" and Request File ID "ABCDE123" with a delay of 3 seconds. The detailed results are stored in the variable "predictionDetails" of type GetPredictionFileByFileIDProperties for further handling in the workflow.