InquireAI Response Data

InquireAI returns the requested data in a consistent format. As with any workflow, system data such as the workflow name and overall page count can also be retrieved. For workflows that utilize InquireAI, an additional data point—the InquireAI page count—is available. This value allows you to track the number of pages processed, providing insight into utilization and helping to ensure that you can take action to ensure your processes continue to run uninterrupted.

Page Count

InquireAI operates on a monthly page-count model. Because the node can be configured to inspect only specific pages of a document, tracking the total number of pages per document may not accurately reflect actual InquireAI usage.

If the InquireAI node is set to process only the first page, each document will count as a single page toward your utilization, regardless of the document’s total length.

InquireAI tracks the number of pages processed, and this data can be exposed within a workflow. Workflows can then be configured to send notifications when defined thresholds are reached. This can be accomplished by leveraging a Process Field in combination with the Condition node and the Email node.

Accessing Page Count

To access the InquireAI page count in your workflow:

Create a new Process Field called S9LICENSE.
1. Field Name: S9LICENSE
2. Data Type: Numeric
3. System Field: Read Only
Add the field to the Process Field Pane of your workflow.

Response Data

The expected response will always be in the form of:

CODE

{“header”:{},”value”:[]}

The header object contains the Key:Value pairs for any extracted header data. These are values that are only represented by a single value.

The value array contains repeating Key:Value pairs. This is repetitive data represented in a data table or as a multi value field and will be added to the table field/multi value field indicated in the Table setting.

CODE

{ "header": { "Order Number": "1004", "Order Date": "2018/11/16", "Ship To": "Robert Johnson, SoundCoast Musical Supply, 97 Orange Street, New Haven, CT 06510", "Bill To": "SoundCoast Musical Supply, 97 Orange Street, New Haven, CT 06510", "Amount": "$107,778.55", "Description": "Purchase Order" }, "value": [ { "Item Description": "Martin 00-28VS Acoustic Guitar", "Quantity": "10", "Unit Price": "$3,859.00", "Extended Amount": "$38,590.00" }, { "Item Description": "Martin 00-28 Standard Grand Auditorium Acoustic Guitar Aged Toner", "Quantity": "10", "Unit Price": "$3,029.00", "Extended Amount": "$30,290.00" }, { "Item Description": "Martin Road Series Custom GPRS1 Grand Performance Acoustic-Electric Guitar Natural", "Quantity": "25", "Unit Price": "$649.99", "Extended Amount": "$16,249.75" }, { "Item Description": "Martin Custom D Classic Mahogany Dreadnought Acoustic Guitar", "Quantity": "20", "Unit Price": "$999.99", "Extended Amount": "$19,999.80" }, { "Item Description": "Martin Guitar T-Shirt with White Logo", "Quantity": "100", "Unit Price": "$24.99", "Extended Amount": "$2,499.00" } ] }

CODE

{
  "header": {
    "Order Number": "1004",
    "Order Date": "2018/11/16",
    "Ship To": "Robert Johnson, SoundCoast Musical Supply, 97 Orange Street, New Haven, CT 06510",
    "Bill To": "SoundCoast Musical Supply, 97 Orange Street, New Haven, CT 06510",
    "Amount": "$107,778.55",
    "Description": "Purchase Order"
  },
  "value": [
    {
      "Item Description": "Martin 00-28VS Acoustic Guitar",
      "Quantity": "10",
      "Unit Price": "$3,859.00",
      "Extended Amount": "$38,590.00"
    },
    {
      "Item Description": "Martin 00-28 Standard Grand Auditorium Acoustic Guitar Aged Toner",
      "Quantity": "10",
      "Unit Price": "$3,029.00",
      "Extended Amount": "$30,290.00"
    },
    {
      "Item Description": "Martin Road Series Custom GPRS1 Grand Performance Acoustic-Electric Guitar Natural",
      "Quantity": "25",
      "Unit Price": "$649.99",
      "Extended Amount": "$16,249.75"
    },
    {
      "Item Description": "Martin Custom D Classic Mahogany Dreadnought Acoustic Guitar",
      "Quantity": "20",
      "Unit Price": "$999.99",
      "Extended Amount": "$19,999.80"
    },
    {
      "Item Description": "Martin Guitar T-Shirt with White Logo",
      "Quantity": "100",
      "Unit Price": "$24.99",
      "Extended Amount": "$2,499.00"
    }
  ]
}

Response Field Names

Response field names need to match process field names for data to be available to GlobalCapture.

Ex. If your process field is Invoice Number but the response is returning Invoice #, the data will NOT be added to the Invoice Number process field.

This can be corrected by adding an process field that matches the returned key value and using a Set Process Field not to associate the Invoice # to the Invoice Number.

Return Data

All data is returned as type character. If the data returned does not match the type of GlobalCapture field, the process will error. Possible ways to counter this are:
- Turning off Data Validation will allow the data to populate the field without an error, but the data will need to be corrected before release.
- Adding details in you prompt about formatting of the data.