AI Hub

Authorise and set up Document Intelligence integration

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.

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

Enabling Document Intelligence integration at system level

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 opens:
Enter the
ClientID
,
Secret
 token and
APP URL
.
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 the test is unsuccessful, please double-check the information you have entered and click
Test
 again. If problems persist, contact your Document Intelligence administrator.
The Document Intelligence section shows authorised workspaces, and the default applied to each site:
Document Intelligence is made available for site administration.

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 the setup adds to the File metadata iSheet.
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 that 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.
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.

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 opens. Navigate to the
Settings
 tab:
In the
AI Hub configuration
 section, click
Select
. The
Manage AI Hub
 screen opens:
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 opens. 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 opens. 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 opens:
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

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.

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

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 Document Intelligence has extracted.
This data can be used to enrich
iSheets
 and
Data Visualisation
.

This article applies to:

  • Product: HighQ, HighQ
  • Subject: AI, Documents