Thomson Reuters Document Intelligence (formerly ThoughtTrace) is integrated with HighQ in the AI Hub. After it is enabled and configured, you can send files or assign folders to be processed by Document Intelligence. Files are sent to Document Intelligence, processed, and any resulting Thoughts (extracted provisions and sub-provisions) and Facts (user-asserted metadata) are returned to HighQ AI Hub and iSheets.
Document Intelligence integration needs to be enabled by a HighQ admin - please contact HighQ Support to request this. Once the integration is enabled for your instance, the option is visible in AI Hub at system level and can be set up.
Configuration notes
Configuration requires you (the HighQ customer) to also be a Thomson Reuters Document Intelligence customer and generate an API key in the Document Intelligence application which is then entered in the instance configuration for HighQ.
Thomson Reuters HighQ Support enables the Document Intelligence integration for your instance, this makes Document Intelligence visible as an AI Hub service.
Document Intelligence integration is configured for workspaces at the instance level by a system admin, it can then be disabled or enabled for use by site admins.
Multiple Document Intelligence workspaces can be connected to an instance of HighQ, however a Document Intelligence application can only be used as a workspace for a single HighQ instance.
Please note that the fields available within the AI Hub are limited to only those found in the Document Intelligence application.
Enabling Document Intelligence integration at system level
This requires appropriate system admin permissions.
To use the Document Intelligence integration, a system administrator must first enable it at the system level. Navigate to your Profile > System admin > System settings:
In the System settings screen, scroll down to AI Hub services configuration:
Click Add in the Thomson Reuters Document Intelligence section; the Authorise screen is displayed:
Enter the ClientID, Secret token and APP URL.
This information is obtained from Document Intelligence application, please contact your Document Intelligence administrator for help.
ClientID and Secret token can be generated by a Document Intelligence administrator; open Settings > API clients and using API Client.
API URL and APP URL relate to your Document Intelligence integration (for example, https://api.thoughttrace.com). The API URL is entered automatically, but you must define your APP URL (for example, https://app.thoughttrace.com/myworkspace).
Click Test.
If the test passes, you see a Test successful message; click Save to save the authorised configuration.
If you receive error messages when you first enable Document Intelligence, please contact the Document Intelligence support team to check that they have whitelisted the HighQ IP addresses, to ensure that the AI Hub can reach your Document Intelligence application. The HighQ support team can help with this if required.
If the test is unsuccessful, please double-check the information you have entered and click Test again. If problems persist, contact your Document Intelligence administrator.
If there is already a connection for this workspace, a Client ID must be unique message is shown; please check the Client ID.
The Document Intelligence section shows authorised workspaces, and the default applied to each site:
Document Intelligence is made available for site administration.
You may configure and revoke the Document Intelligence integration in the More actions menu.
Multiple Document Intelligence workspaces can be connected to an instance of HighQ, however each Document Intelligence application can only be used as a workspace for a single HighQ instance.
Enabling a Document Intelligence worksite at site level
To enable the engine at the site level, navigate to your site and click Admin > AI Hub > Configure:
The Configure screen displays the AI integrations available on the site:
In the Document Intelligence section, click More actions > Activate.
The Activate screen opens:
Automatic setup
This section shows the columns that setup adds to the File metadata iSheet.
If the site does not have a File metadata iSheet a File metadata iSheet is created.
If necessary, the iSheet module is also enabled.
Setup adds three fields to the iSheet (even if the iSheet already exists) to capture key data points from Document Intelligence:
- Preview URL - use to view the file in Document Intelligence
- Document type - the classification of the document applied by Document Intelligence
- Thought model - the trained AI which identifies key details, clauses and legal language in your documents
Workspace selection
If a Workspace is not already selected, select the workspace for the site.
If you cannot see the correct workspace, contact your system admin.
iSheet setup
Shortened text hides longer text so that more rows are displayed on a page.
Files setup
Select Yes or No to define if files are removed from the Document Intelligence workspace when they are deleted or moved in HighQ.
This is applied to protect data integrity, where required, when:
- files are deleted in HighQ,
- files are moved to a folder with no AI assignment, or
- the workspace connection is removed from the site or the HighQ instance ('revoked').
Click Activate to confirm your selections.
If a site no longer requires a Document Intelligence workspace, you can turn it off at the site level, or revoke the workspace to remove it entirely from the site.
If a Document Intelligence assignment is revoked, unassigned or the workspace is changed, the existing job IDs are removed. If Document Intelligence is later reassigned, documents are uploaded with a new job ID and are analysed as new files.
Assign Document Intelligence to files and folders
After Document Intelligence integration is enabled at site level, a site admin can assign the AI to files and folders in Admin or in the Files module.
Assign Document Intelligence in the Admin module
A site admin can assign the AI to files and folders in the Admin module. Navigate to the Admin module and click Manage in the AI Hub section.
Select the files and folders to analyse with Document Intelligence, then click Assign AI and Document Intelligence.
This opens the Manage screen, where you can choose which Document Intelligence document type is assigned to the folder or documents. Document Intelligence document types can be related to AI models to extract Thoughts. Alternatively, you can choose to Use Document Intelligence AI to automatically classify the document type and extract data accordingly.
Assign Document Intelligence in the Files module
You may now assign the AI to a folder on your site. Navigate to the Files module and then the folder that will contain documents for Document Intelligence.
Click Actions then select Document Intelligence from the Assign AI section:
The Add folder screen is displayed. Navigate to the Settings tab:
In the AI Hub configuration section, click Select. The Manage AI Hub screen is displayed:
Select the checkbox in the Thomson Reuters Document Intelligence section and then click Save. Document Intelligence is listed in the Settings tab.
Click More actions and then Manage:
This opens the Manage screen, where you can choose which Document Intelligence document type is assigned to the folder or documents. Document Intelligence document types can be related to AI models to extract Thoughts. Alternatively, you can choose to Use AI classifier (or Use ThoughtTrace AI on some systems) to automatically classify the document type and extract data accordingly.
Manage document type
In the Manage screen, choose the Document Intelligence document type used to analyse files or documents in the folder.
Document Intelligence document types can be related to AI models to extract Thoughts. Alternatively, you can choose to Use Document Intelligence AI to automatically classify the document type and extract data accordingly.
Select a document type from the list then click Save to apply the selection.
Document Intelligence is now assigned to the file or folder.
Revoke the Document Intelligence integration
As of October 2022, a Site Administrator can remove/change a workspace for Document Intelligence at the site level, with appropriate actions invoked to clear data from a workspace and for a System Administrator to revoke connections or turn off Document Intelligence across an instance of HighQ.
Site Administration
Within your site, navigate to Admin:
Within the Admin settings, navigate to AI Hub > Configure:
The AI Hub configuration screen is displayed. Here, you will see a list of all available AI engines. To Revoke the workspace for Document Intelligence, click More actions > Revoke:
You will be prompted to confirm you want to revoke:
Click Revoke.
System Administration
In your site, click System admin from your profile drop-down menu:
The System admin screen will be displayed. Within System admin navigate to System settings:
In System settings, search for AI Hub services configuration - Document Intelligence:
Click More actions > Revoke to revoke the workspace at system level:
A confirmation window opens:
Click Revoke to revoke the workspace.
Reconfigure at System admin level
If the API credentials have changed, you can reconfigure them by clicking More actions > Configure:
The Authorise - Document Intelligence AI engine screen is displayed:
Add your new ClientID and Secret token, then click Test to verify them; if successful, click Save.
Set up an iSheet view for Document Intelligence results
As of our March 2023 release, users can now link to Thoughts within Document Intelligence from iSheet cells, by double clicking the corresponding piece of information. Although if Inline Editing is enabled or the cells have multiple concatenated values, the link will not be enabled
In the Admin module, open the iSheets section in Module settings.
Select the More actions then Manage columns for the File metadata iSheet that will store Document Intelligence results.
See File and folder metadata iSheets for more information.
Importing data into an iSheet
You must import the Document Intelligence Thoughts and Facts relevant to your needs as columns in the file metadata iSheet. Each imported field can have an associated Yes/No field.
In the Admin module, open the iSheets section:
The automatically generated columns are visible in the iSheet; click Add, then select Import columns:
Select the Document Intelligence fields to import as iSheet columns (see Importing generated data).
View both the Thought and Fact field types; Thoughts being sub-divided by the Document Type(s) linked to each Model (ML model):
Importing generated data (Thoughts)
Thoughts represent generated data, extracted using Document Intelligence thought models (sometimes called 'ontologies').
Open the Import columns screen, set the Analysis Engine to Document Intelligence, then select Thoughts from the Field type drop-down.
Select a Document Type which defines the Thought model used to analyse documents.
Make sure the Thoughts metadata checkbox is selected and, if required, select Yes/No to add a Yes/No column, then click Select....
The Select fields screen opens:
Select the fields you want to extract, then click Save to import the generated data.
Different Thought models (the 'Ontology') can extract provisions with the same name e.g. ‘Change of Control’. Currently these are treated as different data points.
To disambiguate, a column is created for each thought model, prefixed with the Thought model, e.g. MSA; Change of Control and TSA; Change of Control.
Importing user-asserted data (Facts)
Facts represent user-selected data, assigned in Document Intelligence models.
Open the Import columns screen, set the Analysis Engine to Document Intelligence, then select Facts from the Field type drop-down.
Make sure the Facts metadata checkbox is selected and, if required, select Yes/No to add a Yes/No column, then click Select....
The Select fields screen opens:
Select the fields you want to extract, then click Save to import the generated data.
Preview Document Intelligence data from the iSheet
Open the Contract information iSheet from the iSheet module.
Click on Preview URL in the Preview URL column to open the document in a Document Intelligence window:
The window can be resized or maximised, and you can navigate the Document Intelligence interface as normal: view the extracted data, search, browse the document and assert fact values.
Open Document Intelligence to confirm facts or review thoughts
If inline editing is not enabled for the column, you can open the Document Intelligence interface directly at the linked Fact or Thought.
Double-click on a linked Fact or Thought in the iSheet to open Document Intelligence.
The mouse pointer changes to show that the data is linked.
Maximise the window to see the whole document.
To confirm facts:
Or review thoughts:
After you assert new fact values and save progress in Document Intelligence, Document Intelligence tells AI Hub that the document data has changed, which in turn updates the iSheet data.
You do have to refresh the page or load the iSheet again to see the updated values in your iSheet.
View progress when processing files
You can see how many documents are processed by navigating to Admin > AI Hub > Insight:
The AI Hub insight page is a reporting page containing charts about analysis and data that has been extracted by Document Intelligence.
This data can be used to enrich iSheets and Data Visualisation.
