Uncategorized

For more information, see Consume an Asset via Create Transaction.  

Annotating a table refers to the process of adding labels to the elements within a table. This process is crucial for training an extractor asset to extract data from tables in a document, enhancing the model’s ability to accurately identify and extract relevant information. By providing clear labels, we improve the model’s understanding of the data, ensuring more effective and reliable extraction.

Step 1: Know your document’s table format

Table on a single page

A table in a single page refers to a document structure where a page contains only one table, and doesn’t exceed to another page.

Example: In the images below, the table is confined to a single page, and does not extend to subsequent pages. 

Table spanning on multiple pages

A spanning table in a page refers to a document structure where a page contains a table that is too large to fit on a single page, and continues to the subsequent pages.

With this feature, users can consolidate and process multi-page tables more efficiently. When enabled, this feature will merge tables that span multiple pages, as long as they have the same number of columns. 

Example: In the images below, the table appears on the first page, and continues onto the subsequent pages. 

Step 2: Annotation a Table

Single table annotation

1. In the Annotation screen, you can access the existing tables that were created in the document type against the extractor asset. 
2. On the right side pane, select the table label that corresponds to the table you wish to annotate on the document.
3. On the document, spot the target table information and draw a bounding box around the entire table.
   
   Drawing a Bounding box: Click and hold the mouse cursor at one corner of the table you wish to annotate. Then, drag the cursor to the opposite corner of the table while keeping the mouse button pressed. This action creates a rectangular box around the table. This is called a bounding box.
   
   
4. Click on the intersections of the rows and columns to create grid lines that define the table’s structure. You can resize or move the lines to accurately capture the table’s layout and content.
5. Select the appropriate column headers from the drop down menu.
6. Click the Done & Read Table button displayed at the bottom of the page to capture and view the extracted table data.
7. If the column headers and corresponding values are not extracted as intended, click button to remove the annotation.
8. On the right side pane, click against the table field to start annotating another table instance in the document.
9. Repeat the same steps to annotate the tables in the other documents. 
10. Complete the annotation and click Train.

Table spanning annotation

1. In the Annotation screen, you can access the existing tables that are created in the document type against the extractor asset. 
2. On the right side pane, select the table label that corresponds to the table you wish to annotate on the document.
3. On the document page, spot the target table information and draw a bounding box around the entire table information.
   
   Drawing a Bounding box: Click and hold the mouse cursor at one corner of the table you want to annotate. Then, drag the cursor to the opposite corner of the table while keeping the mouse button pressed. This action creates a rectangular box around the table. This is called a bounding box.
   

4. Click on the intersections of the rows and columns to create grid lines that define the table’s structure. You can resize or move the lines to accurately capture the table’s layout. 
5. Select the appropriate column headers from the drop down menu.
6. Click the Done & Read Table button displayed at the bottom of the page to capture and view the extracted table data.
7. Go to the next page where the table continues.
   
   
   
   
8. On the document, spot the target table information and draw a bounding box around the entire table.
9. Repeat the same steps to annotate  the table that continues on to the next page. 
10. Once the entire table spanning across multiple pages is annotated, click   link table from the right side pane. This is used to connect or link tables that span multiple pages, ensuring coherent and accurate extraction of data across the entire table span.
11. If the column headers and corresponding values are not extracted as intended, click button to remove the annotation.
12. On the right side pane, click against the table field to start annotating another table instance in the document.
13. Complete the annotation and click Train.

• The storage has been increased in the annotation process. Platform allows the users to perform more than 5000 annotations using the bounding boxes during the Annotation process.

Managing an Asset involves a range of actions aimed at modifying its name, Asset image, removing an unwanted Asset and downloading its API.

Rename an asset

Renaming an Asset refers to the action of assigning a new name to it. This process allows the users to modify the existing name and update it with a new one, facilitating better organisation and making it easier to locate the Asset within the platform. 

1. Head to the Asset Studio page and use the Search bar to find an Asset. 
   
   
   
   
2. Click   on the Asset that you wish to rename, and then select Rename.
   
   
   
   
3. In the Rename window that appears, update the Asset name, and then select OK.
   
   
   
   
4. You can now view the updated Asset name for that Asset.
   
   
   
   

Delete an asset

1. Head to the Asset Studio page and use the Search bar to find an Asset.
   
   
   
   
2. Click on the Asset that you wish to delete and then select Delete.
   
   
   
   

Upload an image

1. Head to the Asset Studio page and use the Search bar to find an Asset.
   
   
   
   
2. Click on the Asset for which  you wish to update the image, and then select Update display image.
   
   
   
   
3. In Update display image window that appears, click move the cursor on the image and click to upload an image from your local system.
   
   
4. Click Done.
5. You can now view the updated image against the Asset.
   
   
   
   

Download API 

After publishing an asset, you can download it as an API and integrate it with your business system.

Note: Download API feature is applicable only for the Published Assets.

1. Head to the Asset Studio page and use the Search bar to find an Asset.
   
   
   
   
2. Click on the Asset you wish to use and then select Download API.
   
   
   
   
3. The API file will be automatically downloaded to your system. 

Finding an Asset refers to the process of  locating and accessing a specific Asset. Once Asset creation is initiated in the Platform, you can easily search and access that Asset, saving valuable time.

Note: The private assets will be indicated with the symbol in the specified modules. Only the owner can view and manage the asset. Other users will not have access to these private assets unless the owner grants permission.

Access the search bar 

1. Head to the Asset Studio module, locate the Search bar.
   
   
   
   

2. In the Search bar, enter an Asset name that you wish to find.
3. Press Enter.
4. The platform will dynamically display relevant results as you enter.

Utilizing Filter

1. On the Asset Studio module, click Filter and use the following options to get your required Asset(s).
   
   
   
   
2. In Asset Types, choose the types of assets  you wish to filter.
   • Classifier – Classic AI: Choose this option to filter the classifier assets.
   • Extractor – Classific AI: Choose this option to filter the extractor assets.
   • Use case: Choose this option to filter the Use case assets.
     .
3. In Asset Status, choose the status of the asset you wish to filter.
   • Initiated: Choose this option to filter assets that have been initiated.
   • Creation in Progress: Choose this option to filter assets that are currently in the process of being created.
   • Publish in Progress: Choose this option to filter assets that are in the process of being published.
   • Published: Choose this option to filter assets that have been successfully published.
   • Publish Failed: Choose this option to filter assets that failed to publish.
   • Design in Progress: Choose this option to filter assets that are currently being designed.
   • Training in Progress: Choose this option to filter assets that are undergoing training.
   • Training Completed: Choose this option to filter assets that have completed training.
   • Training Failed: Choose this option to filter assets that failed during training.
   • Annotation in Progress: Choose this option to filter assets that are being annotated.
   • Annotation Failed: Choose this option to filter assets that failed during annotation.
   • Finetuning in Progress: Choose this option to filter assets that are being fine-tuned.
     
4. In Users, select the user whose assets you wish to filter. You can use the search bar to find specific users.
   
5. In Date modified, select the date time options to filter the assets within a specific period.
   
   • 24 Hrs: Choose this option to filter the assets created within 24 hours. 
   • Custom: Choose this option to filter the assets created within a custom date range. You can select both the Start and End dates to filter the assets.  
     
     

Save Filter

1. This option allows you to save a specific filter criteria for easy reuse. It helps to quickly apply the same filter settings without setting them up each time.
    
2. In the filter window, click and select Save as New Filter.
   
   
   
   
3. In the Save Filter window that appears, enter the Filter name and click Save.
   
   
   
   
4. The custom filter is saved and you can access the filter whenever you need. 
   

Reuse the saved Filter

1. Reuse the Saved Filter
2. In the filter option,  click and select the Saved filter and choose the saved filter to reuse.
   
   
   
   
   

Asset Monitor

You can find an Asset using the search bar.

Access the search bar 

1. Head to the Asset Monitor module, locate the Search bar.
   
   

2. In the Search bar, enter an Asset name that you wish to find and then press Enter.
3. The platform will dynamically display relevant results as you enter.

Utilizing Filter

1. On the Asset Monitor module, click Filter and use the following options to get your required Asset information to monitor.
   
   
   
   
2. In Asset Types, choose the asset types that you wish to filter.
   
   • Classifier – Classic AI: Choose this option to filter the classifier assets.
   • Extractor – Classic AI: Choose this option to filter the extractor assets.
   • Use case: Choose this option to filter Use case assets.
      
3. In Status, choose the status of the asset that you wish to filter.
   
   • Active: Choose this option to filter the assets that are in the Active state.
   • Inactive: Choose this option to filter the assets that are in the Inactive state.  
4. In Owner, select the user whose assets you want to filter. You can use the search bar to find specific users.
5. In Tags, select the tags to filter  assets that contain those tags.
6. In Date modified, select the date time options to filter the assets that are within a specific period.
   • 24 Hrs: Choose this option to filter the assets created within the last 24 hours. 
   • Custom: Choose this option to filter the assets created within a custom date range. You can select both the start and end dates to apply the filter.
     
     
     
     

Save Filter

This option allows you to save specific filter criteria for easy reuse. It helps to quickly apply the same filter settings without setting them up each time. 

1. In the Filter window, click and select Save as New filter.
   
   
   
   
2. In the Save Filter window that appears, enter the Filter name and click Save.
   
   
   
   
3. The custom filter is saved and you can access the filter whenever you need. 

Reuse the Saved Filter

• In the Filter option,  click and select the Saved filter and choose the saved filter to reuse.
  
  
  

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

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

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

Step 1: Select an asset

1. Head to the Asset Monitor module, use the Search bar to find an Asset.
   
   
   
   
2. Select an Asset that you wish to consume.
   
   
   
   

Note: If the Asset is in Inactive status, you must activate the Asset to consume via Create Transaction. For more information about how to activate an Asset, see Activate an Asset page. 

Step 2: Create a transaction

1. On the Overview page that appears, move to the Transaction tab.
   
   
   
   
2. On the Transaction page click Create Transaction and proceed to upload the documents.
   
   
   
   

Step 3: Upload documents

1. 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 Asset is designed to update the documents at the time of consuming. Otherwise,  you may get different windows based on the Asset. 

2. 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. 

• To suspend a transaction, click and then select 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 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

Classifier Asset

1. On the transaction list page, select a transaction.
   
   
   
    
2. On the result page that appears, you can view the transaction result in the JSON output.
   
   
   
   
3. You can also download the JSON file to verify the output sent to the end consuming system.  
4. 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.
     
5. In the JSON output section, use to download the JSON file.

Extractor Asset

1. On the transaction list page, select a transaction.
   
   
   
   
2. On the result page that appears, you can view the transaction result in the Extracted fields and JSON output sections.
   
   
   
   

• Extracted Fields section: It shows the fields and the extracted data against those fields. 
  
  
  
  
• JSON section: It shows the result in JSON output.
  
  
  
  

3. In the JSON output section, you can find the following results:
   • 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.  
4. You can download the JSON file to verify the output sent to the end consuming system. Use to download the JSON format file.

Use case Asset

1. On the transaction list page, select a transaction.
   
   
   
   
2. On the result page that appears, you can view the transaction result in the JSON Output section.
   
   
   
   

3. In the JSON Output section, you can find the following results:
   
   • 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.
   • conf_score: Indicates the confidence score of the model’s prediction against an entity. 
4. You can also download the JSON file to verify the output sent to the end-consuming system. Use to download the JSON file.