Workflows - Document AI component
Note
This option pertains to the Hyperproof TPRM product line.
The Document AI component is a sophisticated tool designed to analyze uploaded PDF documents, identifying compliance issues to ensure your documents meet necessary standards. See Configuring workflow components.
Document AI supports two primary types of analyses:
SOC 2 compliance analysis - Uses predefined clauses to evaluate the document.
Contract compliance analysis - Allows you to create custom compliance types and add specific clauses for evaluation.
Before using Document AI in your projects, it's essential to configure the analysis type as part of the workflow setup. This configuration determines how documents are analyzed and cannot be altered during project runtime.
Note
Document AI only supports analyzing PDF files.
Analysis type can't be changed during project runtime, only during workflow setup.
Managing contract compliance types
For contract compliance analysis, you can customize compliance types and associated clauses. To add or edit contract clauses:
From the menu, select Settings.
Select Contracts & Documents.
From the left menu, select Contract clauses.
A list of contract clauses displays.
Click + Add New.
The Add new compliance window displays.
In the Name field, enter a name for the custom clause.
Click the dropdown list in the Document type field and select one or more existing contract types. When you upload a contract on the Vendor Details window, you assign a contract type. That contract type assignment determines which compliance types are used to analyze the contract.
The new clause is added to the list of contract clauses.
Click in the Clause Content field to enter the clauses that the Document AI component will search for during the contract compliance analysis.
The list of clauses displays.
Click +Add Clause.
In the first field, add a clause title and click the checkmark icon to save the information in that field.
In the second field, add the specific clause text and click the checkmark icon to save the information in that field.
Click Save. Continue adding clauses as needed.
Click Save at the bottom of the list to save the entire collection of clauses.
To delete a clause, click the trash can icon.
To edit an existing clause, click the clause text.
To assign contract types, click the dropdown at the top of the list and select one or more contract types that need to be evaluated for compliance.
Uploading and managing a document for analysis by Document AI
When a user goes through the workflow in a project, if a Document AI component has been included, the user is asked to upload a document for analysis. To upload the document:
Note
Depending on the workflow configuration, the system can automatically retrieve the file from existing workflow components, such as form inputs, eliminating the need for manual uploads.
Click the Upload button.
Browse to the file to be analyzed, select it, and confirm that it is the file you want to upload.
If the document is uploaded successfully, the document name and path are displayed, indicating that the document is ready for analysis.
After uploading the document, click the Analyze Document button to initiate the AI-driven compliance analysis.
The analysis process begins in the background and may take some time to complete.
The system analyzes the document based on the pre-configured analysis type, either SOC 2 or Contract Compliance.
A loading spinner or progress bar indicates that the analysis is underway.
Click the Refresh button to check the status of the analysis in progress. If completed, the analysis results are populated automatically.
Click the Delete button to remove the uploaded document. After the document is deleted, you can upload a new document and initiate a new analysis.
Viewing document analysis results
When the uploaded document has been analyzed, the results are displayed in two panes:
Left pane:
Displays the uploaded PDF document.
Allows you to click highlighted sections to view details or navigate through the document.
Selecting a highlighted section in the PDF scrolls to the related issue in the right pane.
Right pane:
Lists the potential risks and compliance issues identified by the analysis.
Provides a brief explanation for each compliance concern.
Provides a severity level indicating the importance and urgency of the issue.
Indicates the section in the PDF where the problem occurs.
Clicking on a potential risk in the right pane highlights the corresponding text in the PDF.
Follow these best practices for document analysis:
Convert documents to PDF before uploading. Only PDF files are supported.
Carefully review analysis results to understand their implications.
Keep compliance types and clauses up to date to reflect the latest regulatory standards.
Troubleshooting Document AI issues
Analysis not starting
Ensure that the PDF document is uploaded correctly.
Check your internet connection and try reloading the page.
You can also access the Re-run contract compliance icon, located next to the Delete Document icon. Click it to start the analysis again.
Verify that the analysis type is correctly configured in the workflow.
Missing compliance issues
Confirm that the correct analysis type, SOC 2 or Contract Compliance, is selected.
Ensure that all necessary compliance types and clauses are configured.
File upload errors - Verify that the file is in PDF format.