Add legalsimplifier example.

Author: techmaharaj

examples/legalsimplifier/README.md

@@ -0,0 +1,65 @@
+# Legal Simplifier
+
+Legal Simplifier is an application that allows you to simplify legal documents - from terms and conditions of an insrance policy or a business contract. This example also shows how we can summarize contents of a large documents in chunks.
+
+Based on the document you upload, the size can vary and hence mgight find the need to split larger documents into chunks of 10,000 tokens to fit within GTP-4's context window.
+
+## Design
+
+The script consists of three tools: a top-level tool that orchestrates everything, a summarizer that
+will summarize one chunk of text at a time, and a Python script that ingests the PDF and splits it into
+chunks and provides a specific chunk based on an index.
+
+The summarizer tool looks at the entire summary up to the current chunk and then summarizes the current
+chunk and adds it onto the end. In the case of models with very small context windows, or extremely large
+documents, this approach may still exceed the context window, in which case another tool could be added to
+only give the summarizer the previous few chunk summaries instead of all of them.
+
+## Installation
+
+### Prerequisites
+
+- Python 3.8 or later
+- Flask
+- Other Python dependencies listed in `requirements.txt`.
+
+### Steps
+
+1. Clone the repository:
+
+    ``` bash
+    git clone https://github.com/gptscript-ai/gptscript.git
+    ```
+
+2. Navigate to the `examples/legalsimplifier` directory and install the dependencies:
+
+    Python:
+
+    ```bash
+    pip install -r requirements.txt
+    ```
+
+    Node:
+
+    ```bash
+    npm install
+    ```
+
+3. Setup `OPENAI_API_KEY` (Eg: `export OPENAI_API_KEY="yourapikey123456"`). You can get your [API key here](https://platform.openai.com/api-keys).
+
+4. Run the Flask application using `flask run` or `python app.py`
+
+## Usage
+
+1. Open your web browser and navigate to `http://127.0.0.1:5000/`.
+2. Use the web interface to upload an a legal document in .pdf format.
+3. The application will analyze the document and show a summary.
+
+## Under the hood
+
+Below are the processes that take place when you execute the application:
+
+- The Python app places the uploaded image as `legal.pdf` in the current working directory.
+- It then executes `legalsimplifier.gpt` which internally calls `main.py` to split the large document in chunks so that they fit within the token limit of GPT-4's context.
+- The analysis will be stored in a `summary.md` document.
+- The app will then read this summary file and show the summary on the UI.

examples/legalsimplifier/app.py

@@ -0,0 +1,49 @@
+from flask import Flask, jsonify, render_template, request
+import subprocess
+import os
+
+app = Flask(__name__)
+
+# Setting the base directory
+base_dir = os.path.dirname(os.path.abspath(__file__))
+app.config['UPLOAD_FOLDER'] = base_dir
+
+SCRIPT_PATH = os.path.join(base_dir, 'legalsimplifier.gpt')
+LEGAL_FILE_NAME = 'legal.pdf' # Uploaded document name
+SUMMARY_FILE_NAME = 'summary.md'  # The output file name
+
+@app.route('/')
+def index():
+    return render_template('index.html')
+
+@app.route('/upload', methods=['POST'])
+def upload_file():
+    if 'file' not in request.files:
+        return jsonify({'error': 'No file part'}), 400
+    file = request.files['file']
+    if file.filename == '':
+        return jsonify({'error': 'No selected file'}), 400
+    if file:
+        # Process the file here to generate the summary
+        filename = os.path.join(app.config['UPLOAD_FOLDER'], LEGAL_FILE_NAME)
+        file.save(filename)
+        summary = process_file(file)
+        return jsonify({'summary': summary})
+
+def process_file(file):
+    try:
+        # Execute the script to generate the recipe
+        subprocess.run(f"gptscript {SCRIPT_PATH}", shell=True, check=True)  
+            
+        # Read summary.md file
+        summary_file_path = os.path.join(app.config['UPLOAD_FOLDER'], SUMMARY_FILE_NAME)
+        with open(summary_file_path, 'r') as summary_file:
+            summary = summary_file.read()
+        
+        # Return summary content
+        return summary
+    except Exception as e:
+        return jsonify({'error': str(e)}), 500
+    
+if __name__ == '__main__':
+    app.run(debug=False)

examples/legalsimplifier/legal.pdf

@@ -0,0 +1,37 @@
+tools: legal-simplifier, sys.read, sys.write
+
+You are a program that is tasked with analyizing a legal document and creating a summary of it.
+Create a new file "summary.md" if it doesn't already exist.
+Call the legal-simplifier tool to get each part of the document. Begin with index 0. 
+Do not proceed until the tool has responded to you.
+Once you get "No more content" from the legal-simplifier stop calling it.
+Then, print the contents of the summary.md file.
+
+---
+name: legal-simplifier
+tools: doc-retriever, sys.read, sys.append
+description: Summarizes a legal document
+
+As a legal expert and practicing lawyer, you are tasked with analyzing the provided legal document. 
+Your deep understanding of the law equips you to simplify and summarize the document effectively. 
+Your goal is to make the document more accessible for non-experts, leveraging your expertise to provide clear and concise insights.
+
+Get the part of legal document at index $index.
+Read the existing summary of the legal document up to this point in summary.md.
+Do not leave out any important points focusing on key points, implications, and any notable clauses or provisions. 
+Do not introduce the summary with "In this part of the document", "In this segment", or any similar language.
+Give a list of all the terms and explain them in one liner before writing the summary in the document.
+For each summary write in smaller chunks or add bullet points if required to make it easy to understand.
+Use headings and sections breaks as required.
+Use the heading as "Summary" as only once in the entire document.
+Explain terms in simple language and avoid legal terminologies until unless absolutely necessary.
+Add two newlines to the end of your summary and append it to summary.md.
+
+If you got "No more content" just say "No more content". Otherwise, say "Continue".
+
+---
+name: doc-retriever
+description: Returns a part of the text of legal document. Returns "No more content" if the index is greater than the number of parts.
+args: index: (unsigned int) the index of the part to return, beginning at 0
+
+#!python3 main.py "$index"

examples/legalsimplifier/legalsimplifier.gpt

@@ -0,0 +1,28 @@
+import tiktoken
+import sys
+from llama_index.readers.file import PyMuPDFReader
+from llama_index.core.node_parser import TokenTextSplitter
+
+# Loading the legal document using PyMuPDFReader
+index = int(sys.argv[1])
+docs = PyMuPDFReader().load("legal.pdf")
+
+# Combining text content from all documents into a single string
+combined = ""
+for doc in docs:
+    combined += doc.text
+
+# Initializing a TokenTextSplitter object with specified parameters
+splitter = TokenTextSplitter(
+    chunk_size=10000,
+    chunk_overlap=10,
+    tokenizer=tiktoken.encoding_for_model("gpt-4-turbo-preview").encode)
+
+pieces = splitter.split_text(combined)
+
+# Checking if the specified index is valid
+if index >= len(pieces):
+    print("No more content")
+    sys.exit(0)
+
+print(pieces[index])

examples/legalsimplifier/main.py

@@ -0,0 +1,4 @@
+Flask==2.0.1
+tiktoken==0.6.0
+llama-index-core==0.10.14
+llama-index-readers-file==0.1.6

examples/legalsimplifier/requirements.txt

@@ -0,0 +1,54 @@
+body {
+    padding-top: 20px;
+    font-family: 'Roboto', sans-serif;
+    background-color: #ffffff;
+}
+
+.navbar {
+    margin-bottom: 20px;
+    background-color: #009688; /* Teal color */
+}
+
+.navbar-brand, .nav-link {
+    color: #fff !important;
+}
+
+.container-fluid {
+    max-width: 1200px; /* Adjust based on your preference */
+}
+
+.row {
+    margin: 0;
+}
+
+.col-md-6 {
+    width: 50%;
+    padding: 20px;
+    box-sizing: border-box;
+}
+
+.form-control, .btn, .custom-file-label {
+    border-radius: 0; /* Material design doesn't use rounded corners for inputs/buttons */
+}
+
+/* Simplified content styling */
+#simplified-content {
+    background-color: #fff;
+    padding: 20px;
+    border-radius: 5px;
+    box-shadow: 0 2px 4px rgba(0,0,0,0.1);
+}
+
+.loader {
+    display: none;
+    border: 4px solid #f3f3f3;
+    border-top: 4px solid #3498db;
+    border-radius: 50%;
+    width: 30px;
+    height: 30px;
+    animation: spin 2s linear infinite;
+  }
+  @keyframes spin {
+    0% { transform: rotate(0deg); }
+    100% { transform: rotate(360deg); }
+  }

examples/legalsimplifier/static/css/style.css

@@ -0,0 +1,56 @@
+document.addEventListener('DOMContentLoaded', function() {
+
+    const randomMessages = [
+      "Brewing up some simplicity.",
+      "Decoding legalese.",
+      "Simplifying complex texts.",
+      "Turning the complicated into the understandable.",
+      "Working our magic on your document."
+    ];
+
+    // Define uploadFile globally
+    window.uploadFile = function() {
+      var form = document.getElementById('uploadForm');
+      var formData = new FormData(form);
+      var summaryBlock = document.getElementById('summaryBlock');
+      var summaryOutput = document.getElementById('documentSummary');
+
+      // Display a random message
+      var messageDiv = document.getElementById('randomMessage');
+      messageDiv.innerHTML = randomMessages[Math.floor(Math.random() * randomMessages.length)]; // Display initial random message
+      var messageInterval = setInterval(function() {
+        messageDiv.innerHTML = randomMessages[Math.floor(Math.random() * randomMessages.length)];
+      }, 5000); // Change message every 5 seconds
+  
+      fetch('/upload', {
+        method: 'POST',
+        body: formData,
+      })
+      .then(response => response.json()) // Parse the JSON response
+      .then(data => {
+        if(data.summary) {
+          console.log(data.summary)
+          var converter = new showdown.Converter()
+          var parsedHtml = converter.makeHtml(data.summary);
+          summaryOutput.innerHTML = parsedHtml; // Display the recipe
+          summaryBlock.style.display='block'
+          messageDiv.style.display = 'none' // Clear message
+
+           // Scroll to the documentSummary div
+          document.getElementById('documentSummary').scrollIntoView({
+          behavior: 'smooth', // Smooth scroll
+          block: 'start' // Align to the top of the view
+          });
+
+        } else if (data.error) {
+          summaryOutput.innerHTML = `<p>Error: ${data.error}</p>`;
+          messageDiv.style.display = 'none' // Clear message
+        }
+      })
+      .catch(error => {
+        console.error('Error:', error);
+        summaryOutput.innerHTML = `<p>Error: ${error}</p>`;
+        messageDiv.style.display = 'none' // Clear message
+      });
+    };
+  });

examples/legalsimplifier/static/js/script.js

@@ -0,0 +1,56 @@
+### Summary
+
+- **Proposal**: When someone shows their willingness to do or not do something to get agreement from another.
+- **Promise**: A proposal that has been agreed upon.
+- **Promisor and Promisee**: The one making the proposal and the one accepting it, respectively.
+- **Consideration**: Something done or not done, or promised to be done or not done, which forms the reason for a party's agreement to a promise.
+- **Agreement**: A set of promises forming the reason for each other's agreement.
+- **Contract**: An agreement enforceable by law.
+- **Voidable Contract**: A contract that can be enforced or nullified at the option of one or more parties.
+- **Void Agreement**: An agreement not enforceable by law.
+
+- The document begins by defining key terms related to contracts, such as proposal, promise, consideration, agreement, contract, voidable contract, and void agreement.
+- It outlines the process of making a proposal, accepting it, and the conditions under which a proposal or acceptance can be revoked.
+- It emphasizes that for a proposal to turn into a promise, the acceptance must be absolute and unqualified.
+- The document also explains that agreements become contracts when they are made with free consent, for a lawful consideration and object, and are not declared void.
+- Competence to contract is defined by age, sound mind, and not being disqualified by any law.
+- The document details what constitutes free consent, including the absence of coercion, undue influence, fraud, misrepresentation, or mistake.
+- It specifies conditions under which agreements are void, such as when both parties are under a mistake regarding a fact essential to the agreement.
+
+
+
+- Mistakes in contracts are addressed, clarifying that a contract is not voidable just because it was made under a mistake of one party regarding a matter of fact.
+- It outlines what considerations and objects are lawful, emphasizing that an agreement's consideration or object is lawful unless it is forbidden by law, defeats the provisions of any law, is fraudulent, involves injury to person or property, or is deemed immoral or opposed to public policy by the court. Any agreement with an unlawful object or consideration is void.
+- Examples are provided to illustrate lawful and unlawful considerations and objects in agreements, such as lawful agreements to sell property or make payments under certain conditions, and unlawful agreements involving fraud, employment in public service for payment, and agreements made without the knowledge of a principal that imply fraud.
+- It is stated that agreements void if considerations and objects are unlawful in part, highlighting that if any part of a single consideration for one or more objects, or any one or any part of any one of several considerations for a single object, is unlawful, the agreement is void.
+- The document explains that an agreement made without consideration is void unless it meets specific exceptions, such as being in writing and registered, made to compensate for something done, or to pay a debt barred by limitation law. Examples are given to illustrate these exceptions, including agreements made out of natural love and affection, to compensate for voluntary actions, or to pay a part of a debt barred by law.- **Novation, Rescission, and Alteration of Contracts**: These terms refer to the replacement of an existing contract with a new one (novation), the cancellation of a contract (rescission), and changes made to the terms of a contract (alteration).
+- **Promisee's Rights**: The right of the promisee to dispense with or remit performance, extend time for performance, or accept any satisfaction instead of performance.
+- **Voidable Contracts and Rescission**: Details on how a voidable contract can be rescinded, emphasizing the need for the party rescinding to return any benefits received.
+- **Obligations under Void Agreements**: If an agreement is found void, any person who has received advantage under such agreement must restore it or compensate for it.
+- **Communication of Rescission**: Explains how the rescission of a voidable contract should be communicated.
+- **Facilities for Performance**: If a promisee refuses to afford the promisor reasonable facilities for performance, the promisor is excused for non-performance.
+- **Necessaries Supplied to Incapable Persons**: Persons who supply necessaries to someone incapable of contracting are entitled to reimbursement from the incapable person's property.
+- **Reimbursement for Payment on Another's Behalf**: If someone pays money which another is bound by law to pay, they are entitled to be reimbursed by the other person.
+- **Benefit of Non-gratuitous Act**: If someone enjoys the benefit of a non-gratuitous act, they must compensate the person who performed the act.
+- **Finder of Goods**: A person who finds goods belonging to another and takes them into custody has the same responsibility as a bailee.
+- **Money Paid under Mistake or Coercion**: Any money paid or thing delivered by mistake or under coercion must be returned.
+
+- The document transitions into discussing the legal concept of bailment, which involves the delivery of goods by one person (the bailor) to another (the bailee) for a specific purpose, with the expectation that the goods will be returned or disposed of as per the bailor's instructions.
+- It outlines the responsibilities of the bailor, such as disclosing any faults in the goods that could affect their use or expose the bailee to risks. If the bailor fails to disclose such faults, they are liable for any resulting damage to the bailee.
+- The bailee's duties are also detailed, including taking care of the bailed goods as a person of ordinary prudence would take care of their own similar goods. The bailee is not liable for loss or damage to the goods if they have taken the proper amount of care as described.
+- The document explains various scenarios involving the mixing of the bailor's goods with the bailee's, detailing the outcomes depending on whether the bailor consented to the mixing and whether the goods can be separated after mixing.
+- It covers the rights and responsibilities related to expenses incurred during the bailment, the return of goods lent gratuitously, and the termination of bailment under different circumstances.
+- The section on bailment concludes with the rights of the bailee to retain the goods until they are compensated for any necessary expenses or services provided in relation to the bailed goods.
+
+
+
+- Agents must act in the best interest of their principals, including making good on losses due to their negligence, properly accounting for their actions, and seeking the principal's instructions in difficult situations.
+- Agents dealing in the agency's business for their own benefit without the principal's consent may face repudiation of the transaction by the principal, especially if the agent concealed material facts or the dealings were disadvantageous to the principal.
+- Principals have the right to any benefits an agent gains from unauthorized dealings in the agency's business.
+- Agents can retain from any received sums, the amounts due to them for expenses or services in the agency's business, but must pay the principal any remaining sums.
+- Agents are not entitled to remuneration for misconducted business and have a right to retain the principal's property as security for what is owed to them.
+- Principals must indemnify agents against consequences of lawful acts or acts done in good faith, but not for criminal acts.
+- Contracts made through agents are as enforceable as if made by the principals themselves. However, agents cannot enforce or be bound by these contracts unless specifically agreed otherwise.
+- Principals are bound by the acts of agents within their authority, and in some cases, even by unauthorized acts if they led third parties to believe these were within the agent's authority.
+- Misrepresentations or frauds by agents in their business affect the principal as if they had committed them, but not if these acts were outside the agent's authority.
+- The chapter on partnership has been repealed and replaced by the Indian Partnership Act, 1932.