Skip to content

Commit 7858822

Browse files
committed
fix: some documentation fixes
1 parent 42b24f5 commit 7858822

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

samples/contract-compliance-analysis/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ To deploy this project, follow the instructions available in the README files lo
3232

3333
## Key Features
3434

35-
- **Automated Contract Analysis**: Validates, processes, classifies, and evaluates contract clauses against your guidelines with risk assessment
35+
- **AI-Assisted Contract Analysis**: Validates, processes, classifies, and evaluates contract clauses against your guidelines with risk assessment
3636
- **Multi-Language AI Analysis**: Generate analysis reports in English, Spanish, or Portuguese based on user selection
3737
- **Multi-Contract Type Support**: Define and manage multiple contract types (service agreements, employment contracts, etc.) with type-specific guidelines
3838
- **Web Application**: User interface for managing contract types, guidelines, and viewing analysis results
39-
- **AI-Generated Evaluation Questions**: Automatically create compliance questions from guideline definitions
39+
- **AI-Generated Evaluation Questions**: Generate compliance questions from guideline definitions
4040
- **Contract Import**: Bootstrap new contract types by extracting guidelines from reference contracts
4141
- **Configurable Risk Thresholds**: Customize risk classification criteria per contract type
4242
- **Flexible Model Selection**: Configure different foundation models for specific tasks via parameter store
@@ -45,7 +45,7 @@ To deploy this project, follow the instructions available in the README files lo
4545

4646
## Architecture
4747

48-
This prototype leverages AWS managed services and Large Language Models to automate contract compliance analysis. The architecture consists of multiple workflows that work together to validate contracts against your guidelines and optionally verify compliance with legislation.
48+
This prototype leverages AWS managed services and Large Language Models to assist with contract compliance analysis. The architecture consists of multiple workflows that work together to validate contracts against your guidelines and optionally verify compliance with legislation.
4949

5050
### High-Level Architecture
5151

@@ -67,7 +67,7 @@ When enabled, this workflow uses an AI agent with access to a knowledge base of
6767

6868
### Contract Import Workflow
6969

70-
This workflow uses LLMs to automatically extract contract type information and guidelines from reference contracts, enabling rapid onboarding of new contract types without manual guideline creation:
70+
This workflow uses LLMs to extract contract type information and guidelines from reference contracts, enabling rapid onboarding of new contract types with reduced manual effort:
7171

7272
![Contract Import Architecture](./images/contract-import-architecture.png)
7373

samples/contract-compliance-analysis/backend/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ Access these features through the frontend application after deployment.
218218
4. **Create a new contract type** or use the default "Service Agreement" type
219219
5. **Add guidelines** for your contract type using one of these approaches:
220220
- **Manual Entry**: Use the guidelines form to add clause types and evaluation questions
221-
- **AI-Assisted Generation**: Automatically generate evaluation questions and review/edit as needed
221+
- **AI-Assisted Generation**: Generate evaluation questions and review/edit as needed
222222
- **Import from Reference Contract**: Upload an existing contract to extract contract type, clause types, and initial guidelines (see below)
223223

224224
### Reference Contract Import

samples/contract-compliance-analysis/documentation/technical-documentation.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
:revdate: {currentdate}
1616
:author: Technical Documentation
1717

18-
= Automated Contract Compliance Analysis
18+
= Contract Compliance Analysis
1919

2020
<<<
2121
// Table of Contents is automatically generated here
@@ -48,7 +48,7 @@ During the prototyping engagement/proof of concept, AWS may use third-party mode
4848
<<<
4949
== Overview
5050

51-
This document details a solution prototype developed to automate the compliance analysis of contracts. The prototype leverages Generative Artificial Intelligence (GenAI) to evaluate contract clauses against predefined guidelines and provide feedback on their adherence to the required standards.
51+
This document details a solution prototype developed to assist legal teams in analyzing contract compliance. The prototype leverages Generative Artificial Intelligence (GenAI) to evaluate contract clauses against predefined guidelines and provide feedback on their adherence to the required standards.
5252

5353
The prototype is powered by AWS Machine Learning services and a Large Language Model (LLM) capable of understanding legal terminology and concepts. Such a LLM is used to perform advanced natural language tasks, such as clause classification and compliance evaluation, based on the provided guidelines.
5454

@@ -102,7 +102,7 @@ The prototype includes a web-based interface and REST APIs for managing contract
102102
* Create, update, and delete contract types through the UI
103103
* Define and manage guidelines for each contract type
104104
* Import guidelines from structured text using AI-powered extraction
105-
* Generate evaluation questions automatically using the LLM
105+
* Generate evaluation questions using the LLM
106106

107107
This approach is recommended for production use as it provides a user-friendly interface and maintains data consistency through the application layer.
108108

@@ -185,7 +185,7 @@ The script validates the JSON structure, checks for required fields, and imports
185185

186186
Evaluation questions are binary questions used to assess whether a contract clause is compliant with the standard wording for a clause type. The prototype provides two methods for generating these questions:
187187

188-
*API-Based Generation (Recommended)*: When creating or updating guidelines through the web interface, the system can automatically generate evaluation questions using the LLM, allowing immediate review and editing.
188+
*API-Based Generation (Recommended)*: When creating or updating guidelines through the web interface, the system can generate evaluation questions using the LLM, allowing immediate review and editing.
189189

190190
*JSON File Definition*: For bulk imports, evaluation questions can be predefined in the JSON file, allowing version control and consistent evaluation criteria across environments.
191191

@@ -199,7 +199,7 @@ The architecture consists of:
199199

200200
* *Contract Analysis Workflow*: Orchestrated multi-step pipeline that processes contracts through validation, preprocessing, classification, evaluation, and risk assessment
201201
* *Guideline Management*: Storage and management of contract types, clause types, and evaluation criteria
202-
* *AI-Powered Import*: Automated extraction of guidelines from reference contracts using LLMs
202+
* *AI-Powered Import*: AI-assisted extraction of guidelines from reference contracts using LLMs
203203

204204
==== Optional Features
205205

@@ -250,7 +250,7 @@ ifndef::env-github[]
250250
image::guidelines-compliance-architecture.png[width=90%,align=center]
251251
endif::[]
252252

253-
The AI-powered import workflow automatically extracts contract types and guidelines from reference contracts:
253+
The AI-powered import workflow extracts contract types and guidelines from reference contracts:
254254

255255
ifdef::env-github[]
256256
++++
@@ -636,7 +636,7 @@ The agent has access to:
636636

637637
=== Contract Type and Guidelines Import Workflow
638638

639-
The prototype provides an AI-powered workflow to automatically extract contract type definitions and guidelines from reference contract text. This eliminates the need for manual guideline creation and accelerates the setup of new contract types.
639+
The prototype provides an AI-powered workflow to extract contract type definitions and guidelines from reference contract text. This reduces manual effort in guideline creation and accelerates the setup of new contract types.
640640

641641
==== Import Workflow Steps
642642

@@ -677,7 +677,7 @@ Through the web application:
677677
1. Navigate to Contract Types management
678678
2. Click "Import Contract Type"
679679
3. Paste the reference contract text (can be an existing contract that follows the desired structure)
680-
4. Submit - the AI workflow automatically extracts:
680+
4. Submit - the AI workflow extracts:
681681
- Contract type definition
682682
- All clause types with standard wording
683683
- Evaluation questions for each clause type
@@ -946,7 +946,7 @@ endif::[]
946946

947947
1. Click "Import Contract Type"
948948
2. Paste a reference contract text (e.g., an existing contract that follows the desired structure)
949-
3. Submit - the AI automatically extracts:
949+
3. Submit - the AI extracts:
950950
- Contract type name and description
951951
- All clause types with standard wording
952952
- Impact levels for each clause type
@@ -1024,7 +1024,7 @@ ifndef::env-github[]
10241024
image::frontend-edit-guideline.png[width=90%,align=center]
10251025
endif::[]
10261026

1027-
The guideline editor allows users to modify clause types, standard wording, impact levels, examples, and evaluation questions. The AI-powered "Generate Questions" feature automatically creates evaluation questions from the standard wording.
1027+
The guideline editor allows users to modify clause types, standard wording, impact levels, examples, and evaluation questions. The AI-powered "Generate Questions" feature creates evaluation questions from the standard wording.
10281028

10291029
*Editing Guidelines:*
10301030

@@ -1047,7 +1047,7 @@ Example: If standard wording mentions "30 days notice period", a generated quest
10471047

10481048
Users can:
10491049

1050-
- Generate questions automatically using AI
1050+
- Generate questions using AI
10511051
- Manually add/edit/remove questions
10521052
- Ensure questions are specific and verifiable
10531053

0 commit comments

Comments
 (0)