Documentation

# Consume an Agent via Create Transaction

Consuming an Agent refers to the process of using the agent to perform a desired action or provide a particular functionality. In this context, it means utilising the agent to access a trained Document AI model to classify documents and extract information from them.

Once the agent is created and published, you can send requests to the Agent’s API for processing documents in real time.

Creating a transaction allows you to directly access the published agents and validate results. This guide will walk you through the steps on how to consume an agent via the Create Transaction feature.

# Step 1: Select an Agent

  • Head to the Governance module, select an Asset that you wish to consume

    Note: If the Agent is in Inactive status, you must activate it to consume via Create Transaction. Refer Activate an Asset to know more about how to activate an asset

# Step 2: Create a transaction

  • The Overview page appears as default. Move to the Transaction tab
  • Click Create Transaction and proceed to upload the documents

# Step 3: Upload documents

  • In the Create Transaction window that appears, drag and drop the documents (or) click Browse and select the documents from your local system

    Note: You can get this window only if the Agent is designed to update the documents at the time of consuming. Otherwise, you may get different windows based on the Agent

  • You can upload the documents based on the following requirements and recommendations:

    • Supported file formats: PDF, PNG, JPEG, TIFF, DOCX
    • Maximum document size: 20 MB
    • Maximum image size: 5 MB
    • Maximum files allowed: 5 per transaction
    • Ensure that the file is not password protected and not zipped
    • Make sure images and documents have a resolution of at least 200 DPI (300 DPI is recommended)
    • Upload documents without watermarks

# Step 4: Stages of the transaction

The transaction contains the following stages for consuming an Asset. You can identify its stages based on the status.

Initiated
This status indicates that your transaction is initiated.

In Progress
This status indicates that the transaction is currently being processed. You may wait for some time to allow the process to complete. If you wish to cancel the transaction, use Suspend Transaction

In Queue
This status indicates that the transaction is in the queue for review and will take some time to process.

In Review
This status indicates that the transaction is in the Human in Loop module for manual review.

Completed
This status indicates that the transaction is completed successfully.

Failed
This status indicates the transaction has failed due to some reasons. To know the reason, click the view reason option against the transaction status.

Suspend
This status indicates the transaction has been cancelled.

  • To suspend a transaction, click and then select Suspend Transaction.

# Step 5: View the result and download the JSON output

You can view the result and download the JSON output once the transaction is completed

  • On the transaction list page, select a transaction
  • On the result page that appears, you can view the transaction result in the JSON output
  • You can also download the JSON file to verify the output sent to the end consuming system
  • In the JSON output section, you can identify the following results:
    • class: Shows the Document type predicted by the model
    • conf_score: Shows the confidence score of the model’s prediction
    • label: Shows the label/field name of an entity
    • text: Shows the data extracted for an entity
    • text_confidence: This indicates the model’s confidence in its prediction
    • detection_confidence: This indicates the confidence score associated with the model’s detection
    • file_name: Shows the file name of a document
    • entities: Shows the output results for the entities
    • value: Shows the data extracted for an entity
  • You can download the JSON file to verify the output sent to the end consuming system. Use to download the JSON format file