InquireAI Node

Before You Get Started

You will need to create and add process fields to the Process Field pane with names that match the keys returned by the prompt.

Node Properties

Title

Add a title for this node. Your title should be brief but descriptive about what the prompt is doing. Titles are useful when reviewing the history of a workflow for easier understanding of the overall process.

Description

Provide a synopsis of what this node is doing, or make note of any important details. This is useful for providing additional information such as types of documents being ingested, the data being extracted by the prompt, destination archive, etc. A good description is helpful when returning to modify the workflow in the future.

License Key

Enter the Inquire AI license key provided by Square 9.

Log Output

Page

Specify the page to extract data from.  If left blank, all pages will be checked. Use this to minimize the allotment of pages consumed when not all pages need to be checked for data.

Table

Multi Value Fields - If extracting data to a multi value field, add the name of the multi value field in the Process Field pane that will accept the data.

Table Fields - If extracting line item data, add the name of the data table in the Process Field pane that will accept the data.

Prompt

Enter the prompt you would like to use to extract data. Writing a prompt can be intimidating at first but just like any other skill, can be learned and improved over time. Here are some tips for writing an effective prompt.

1. Provide Clear Instructions - Be explicit about what the AI should do when inspecting the document. This includes specifying the type of data to be extracted, the desired output format, and conducting a thorough review of the entire document.

   1. Ex. Thinking as an knowledge worker tasked with processing new and used car sales deal jackets, read the entire document and extract the following information: Customer Name, VIN Number, Date of Sale, Make, Model, Vehicle Type, and Purchase Type. Collect all occurrences of the VIN number and compare them to ensure they are identical.

2. Provide Additional Details - Add additional details about specific fields that need to be extracted that may not be returning the desired results.

   1. Ex. Purchase Type refers to how the vehicle was purchased. This is often listed at Cash, In House Financing, External Financing, or Leased.

3. Vary the Sequence of Your Phrasing - If the data being returned is not what is expected, it may be necessary to change the ordering of the prompt.

   1. Ex. Thinking as an knowledge worker tasked with processing new and used car sales deal jackets, read the entire document and extract all instances of the VIN Number. Compare the extracted VIN numbers and ensure they are the same. Next, extract the following information: Customer Name, Date of Sale, Make, Model, Vehicle Type, and Purchase Type.

4. Anticipate Variability - Specify how InquireAI should handle missing or inconsistent data.

   1. Ex. If the VIN Number is not present, return null.

5. Avoid Ambiguity - If similar terms or sections exist in the document, guide InquireAI on what to ignore or prioritize.

   1. Ex. Only extract the Customer Name from the ‘Primary Address’ section, not from the ‘Delivery Address’.

Full Screen Prompt TextArea ( )

Click the Full Screen ( ) icon to the right of the Prompt to expand the prompt textarea to full screen making it easier to see and write your prompt. Press ESC on your keyboard to exit prompt full screen.

Data Validation

Outputs

The Inquire AI node requires two outputs: Success and License Error.

Best Practices

• Complete all Inquire AI extraction before any validation, data entry, or template application.

• If the Key from the Key:Value pair does not match your index field, create a process field that matches the Key and use the Set Process Field node to match the returned Key to the desired process field.

• When collecting data or asking for a summary that might be long, include a limit to the returned value to ensure it does not exceed the length of the destination process field.

  • Summarize the document in 50 words or less.

  • Limit the Item Description to 150 characters or less.

Important Notes

• Case does not matter. If the prompt asks for Check Number but the index field is check Number, the data will correctly be added to the field.

• Any data entered into a process field will be overwritten with the data returned by the AI if the process field is included in the response. Fields NOT included in the response will not be impacted.

• The most common reasons the process will error on the InquireAI are shown below. Be sure to include proper error handling in your workflow.

  • If the AI returns data to a field that is a list and that list does not contain the returned data.

  • If the returned data exceeds the field length. This most common when asking for a summary or extracting an item description.

  • If there is a data type mismatch between the data returned and the field with the same name.

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