File size: 15,957 Bytes
0ef9213 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 | import logging
import os
import docx
import PyPDF2
from docx.shared import RGBColor, Pt
from io import BytesIO, IOBase
import tempfile
import re
import datetime
import gradio as gr
from transformers import pipeline, AutoTokenizer, AutoModelForSeq2SeqLM
###############################################################################
# 1) Logging Configuration
###############################################################################
logging.basicConfig(
level=logging.INFO, # or logging.DEBUG for more verbose logs
format="%(asctime)s [%(levelname)s] %(name)s - %(message)s"
)
logger = logging.getLogger("LLM-Legal-App")
###############################################################################
# 2) Retrieve API Key (Hugging Face)
###############################################################################
# Use os.environ to get the API key
api_key = os.environ.get("HUGGINGFACE_API_KEY")
if not api_key:
logger.error("Hugging Face API key not found in environment variables.")
raise ValueError("Hugging Face API key not found. Set it with `os.environ['HUGGINGFACE_API_KEY'] = 'your_api_key'`")
logger.info("Successfully retrieved Hugging Face API key.")
###############################################################################
# 3) Hugging Face Model and Utility Functions
###############################################################################
# Initialize the Hugging Face model and tokenizer.
model_name = "Daemontatox/DocumentCogito"
tokenizer = AutoTokenizer.from_pretrained(model_name)
model = AutoModelForSeq2SeqLM.from_pretrained(model_name, token=api_key)
generator = pipeline("text2text-generation", model=model, tokenizer=tokenizer, device_map="auto") # Use device_map="auto"
def generate_legal_document(doc_type, party_a, party_b, context, country):
"""
Uses the Hugging Face model to generate a legal document.
"""
logger.info(f"Starting generation for doc_type={doc_type!r}.")
party_a = party_a if party_a else "[Party A Not Provided]"
party_b = party_b if party_b else "[Party B Not Provided]"
context = context if context else "[Context Not Provided]"
prompt = f"""
Generate a {doc_type} for:
1) {party_a}
2) {party_b}
Context/brief of the agreement:
{context}.
The document should include:
- Purpose of the {doc_type}
- Responsibilities and obligations of each party
- Confidentiality terms
- Payment terms (use [To Be Determined] if not specified)
- Term (duration) and termination
- Governing law: {country}
- Jurisdiction: [Appropriate region in {country} if not provided]
- Signature blocks
Use formal language, but keep it relatively clear and readable.
For any missing information, use placeholders like [To Be Determined].
Include a disclaimer that this is a draft and not legally binding until reviewed and signed.
"""
logger.debug(f"Generated prompt:\n{prompt}")
try:
# Use the Hugging Face pipeline
generated_text = generator(
prompt,
max_length=1400, # Adjust as needed
num_return_sequences=1,
temperature=0.3, # Adjust as needed
)[0]['generated_text']
logger.info("Document generation complete.")
return generated_text
except Exception as e:
logger.exception("Error generating legal document.")
return f"Error generating document: {e}"
def review_legal_document(doc_text, doc_type, party_a, party_b):
"""Reviews document using the Hugging Face model."""
logger.info("Starting document review (rule-based and wording).")
# --- Rule-Based Review ---
rule_based_prompt = f"""
Review the following document and provide feedback based on these rules:
Document text:
\"\"\"
{doc_text}
\"\"\"
1) Parties and Authority: ... (rest of prompt from previous turns) ...
"""
logger.debug(f"Generated rule-based review prompt:\n{rule_based_prompt}")
try:
rule_based_review = generator(
rule_based_prompt,
max_length=2000,
num_return_sequences=1,
temperature=0.3,
)[0]['generated_text']
except Exception as e:
logger.exception("Error during rule-based review.")
return f"Error during rule-based review: {e}"
# --- Wording Analysis ---
wording_analysis_prompt = f"""
Analyze the wording of the following legal document:
Document text:
\"\"\"
{doc_text}
\"\"\"
Provide an analysis covering: ... (rest of prompt from previous turns) ...
"""
logger.debug(f"Generated wording analysis prompt:\n{wording_analysis_prompt}")
try:
wording_analysis = generator(
wording_analysis_prompt,
max_length=1400,
num_return_sequences=1,
temperature=0.3,
)[0]['generated_text']
except Exception as e:
logger.exception("Error during wording analysis.")
return f"Error during wording analysis: {e}"
combined_review = f"Rule-Based Analysis:\n\n{rule_based_review}\n\nWording Analysis:\n\n{wording_analysis}"
return combined_review
###############################################################################
# 4) File Parsing (PDF, DOCX)
###############################################################################
def parse_bytesio(file_data: BytesIO) -> str:
"""Parses a BytesIO object."""
logger.info("Parsing BytesIO object...")
# ... (rest of parse_bytesio function from previous turns) ...
try:
# Attempt to determine file type from content
try:
doc_obj = docx.Document(file_data)
return "\n".join([para.text for para in doc_obj.paragraphs]).strip()
except docx.opc.exceptions.PackageNotFoundError:
logger.info("BytesIO is not DOCX, trying PDF.")
file_data.seek(0)
try:
pdf_reader = PyPDF2.PdfReader(file_data)
return "\n".join([page.extract_text() for page in pdf_reader.pages if page.extract_text()]).strip()
except Exception as e:
logger.exception(f"Error parsing BytesIO as PDF: {e}")
return f"Error parsing BytesIO as PDF: {e}"
except Exception as e:
logger.exception(f"Error processing BytesIO: {e}")
return f"Error processing file content: {e}"
except Exception as e:
logger.exception(f"Error parsing BytesIO: {e}")
return f"Error parsing BytesIO: {e}"
def parse_uploaded_file_path(file_data) -> str:
"""Takes file data, determines type, extracts text."""
# ... (rest of parse_uploaded_file_path from previous turns)
if not file_data:
logger.warning("No file provided.")
return ""
if isinstance(file_data, str):
file_path = file_data
logger.info(f"Received filepath: {file_path}")
elif isinstance(file_data, dict) and 'name' in file_data:
file_path = file_data['name']
logger.info(f"Received file object with name: {file_path}")
elif isinstance(file_data, (BytesIO, IOBase)):
return parse_bytesio(file_data)
else:
logger.error(f"Unexpected file_data type: {type(file_data)}")
return "Error: Unexpected file data format."
logger.info(f"Attempting to parse file at {file_path}")
try:
_, ext = os.path.splitext(file_path)
ext = ext.lower()
if ext == ".pdf":
with open(file_path, "rb") as f:
pdf_reader = PyPDF2.PdfReader(f)
return "\n".join([page.extract_text() for page in pdf_reader.pages if page.extract_text()]).strip()
elif ext == ".docx":
doc_obj = docx.Document(file_path)
return "\n".join([para.text for para in doc_obj.paragraphs]).strip()
else:
return "Unsupported file format."
except Exception as e:
logger.exception(f"Error parsing file: {e}")
return f"Error parsing file: {e}"
finally:
pass
###############################################################################
# 5) DOCX Creation and Saving
###############################################################################
def clean_markdown(text):
"""Removes common Markdown formatting."""
# ... (rest of clean_markdown from previous turns)
if not text: return ""
text = re.sub(r'^#+\s+', '', text, flags=re.MULTILINE)
text = re.sub(r'(\*\*|__)(.*?)(\*\*|__)', r'\2', text)
text = re.sub(r'(\*|_)(.*?)(\*|_)', r'\2', text)
text = re.sub(r'^[\-\+\*]\s+', '', text, flags=re.MULTILINE)
text = re.sub(r'^\d+\.\s+', '', text, flags=re.MULTILINE)
text = re.sub(r'^[-_*]{3,}$', '', text, flags=re.MULTILINE)
text = re.sub(r'!\[(.*?)\]\((.*?)\)', '', text)
text = re.sub(r'\[(.*?)\]\((.*?)\)', r'\1', text)
return text.strip()
def create_and_save_docx(doc_text, review_text=None, doc_type="Unknown", party_a="Party A", party_b="Party B"):
"""Creates DOCX, adds review, saves to temp file, returns path."""
logger.debug("Creating and saving DOCX.")
# ... (rest of create_and_save_docx from previous turns) ...
document = docx.Document()
now = datetime.datetime.now()
timestamp = now.strftime("%Y%m%d_%H%M%S")
file_name = f"GEN_AI_Review_{doc_type}_{timestamp}.docx"
title = f"Gen AI Analysis of {doc_type} between companies {party_a} and {party_b}"
document.add_heading(title, level=1)
if doc_text:
document.add_heading("Generated Document", level=2)
for para in clean_markdown(doc_text).split("\n"):
document.add_paragraph(para)
if review_text:
document.add_heading("LLM Review", level=2)
for section in review_text.split("\n\n"): # Split into sections
if section.startswith("Rule-Based Analysis:"):
analysis_heading = document.add_paragraph()
analysis_run = analysis_heading.add_run("Rule-Based Analysis")
analysis_run.font.size = Pt(14)
analysis_run.font.color.rgb = RGBColor(0xFF, 0x00, 0x00)
for para in section[len("Rule-Based Analysis:"):].split("\n"):
if re.match(r"^\d+\)", para): # Check for numbered points
p = document.add_paragraph(style='List Number')
p.add_run(para).font.color.rgb = RGBColor(0xFF, 0x00, 0x00) #red
else:
document.add_paragraph(para)
elif section.startswith("Wording Analysis:"):
analysis_heading = document.add_paragraph()
analysis_run = analysis_heading.add_run("Wording Analysis")
analysis_run.font.size = Pt(14)
analysis_run.font.color.rgb = RGBColor(0xFF, 0x00, 0x00)
for para in section[len("Wording Analysis:"):].split("\n"):
document.add_paragraph(para) # black, no numbering
else: # Other sections (if any)
document.add_paragraph(section)
with tempfile.NamedTemporaryFile(delete=False, suffix=f"_{file_name}") as tmpfile:
document.save(tmpfile.name)
logger.debug(f"DOCX saved to: {tmpfile.name}")
return tmpfile.name
###############################################################################
# 6) Gradio Interface Functions
###############################################################################
def generate_document_interface(doc_type, party_a, party_b, context, country):
"""Handles document generation."""
logger.info(f"User requested doc generation: {doc_type}, {country}")
doc_text = generate_legal_document(doc_type, party_a, party_b, context, country)
if doc_text.startswith("Error"):
return doc_text, None
docx_file_path = create_and_save_docx(doc_text, doc_type=doc_type, party_a=party_a, party_b=party_b)
return doc_text, docx_file_path
def review_document_interface(file_data, doc_type, party_a, party_b):
"""Handles document review."""
logger.info("User requested review.")
if not file_data:
return "No file uploaded.", None
original_text = parse_uploaded_file_path(file_data)
if original_text.startswith("Error") or original_text.startswith("Unsupported"):
return original_text, None
review_text = review_legal_document(original_text, doc_type, party_a, party_b)
if review_text.startswith("Error"):
return review_text, None
docx_file_path = create_and_save_docx(None, review_text, doc_type, party_a, party_b)
return review_text, docx_file_path
###############################################################################
# 7) Build & Launch Gradio App
###############################################################################
custom_css = """
.tab-one {
background-color: #D1EEFC; /* Light blue */
color: #333;
}
.tab-two {
background-color: #FCEED1; /* Light orange */
color: #333;
}
"""
def build_app():
with gr.Blocks(css=custom_css) as demo:
gr.Markdown(
"""
# UST Global LLM-based Legal Reviewer
**Review an Existing MOU, SOW, MSA in PDF/DOCX format**: Upload a document for analysis.
**Disclaimer**: This tool provides assistance but is not a substitute for professional legal advice.
"""
)
with gr.Tabs(selected=1):
with gr.Tab("Generate Document",visible=False):
doc_type = gr.Dropdown(label="Document Type", choices=["MOU", "MSA", "SoW", "NDA"], value="MOU")
party_a = gr.Textbox(label="Party A Name", placeholder="e.g., Tech Innovations LLC")
party_b = gr.Textbox(label="Party B Name", placeholder="e.g., Global Consulting Corp")
context = gr.Textbox(label="Context/Brief", placeholder="Short summary of the agreement...")
country = gr.Dropdown(label="Governing Law (Country)", choices=["India", "Malaysia", "US", "UK", "Singapore", "Japan"], value="India")
gen_button = gr.Button("Generate Document")
gen_output_text = gr.Textbox(label="Generated Document", lines=15, placeholder="Generated document will appear here...")
gen_output_file = gr.File(label="Download DOCX", type="filepath")
gen_button.click(
generate_document_interface,
inputs=[doc_type, party_a, party_b, context, country],
outputs=[gen_output_text, gen_output_file]
)
with gr.Tab("Review Document",elem_classes="tab-one", id=1):
# Hidden inputs to store values from Generate tab
doc_type_review = gr.Dropdown(label="Document Type", choices=["MOU", "MSA", "SoW", "NDA"], value="MOU", visible=False)
party_a_review = gr.Textbox(label="Party A Name", visible=False)
party_b_review = gr.Textbox(label="Party B Name", visible=False)
file_input = gr.File(label="Upload PDF/DOCX for Review", type="filepath")
review_button = gr.Button("Review Document")
review_output_text = gr.Textbox(label="Review", lines=15, placeholder="Review will appear here...")
review_output_file = gr.File(label="Download Reviewed DOCX", type="filepath")
review_button.click(
review_document_interface,
inputs=[file_input, doc_type_review, party_a_review, party_b_review],
outputs=[review_output_text, review_output_file]
)
# Copy values from Generate to Review tab (hidden fields)
gen_button.click(lambda x, y, z: (x, y, z), [doc_type, party_a, party_b], [doc_type_review, party_a_review, party_b_review])
gr.Markdown("**Note:** Scanned PDFs may not parse correctly. .docx is generally preferred.")
return demo
logger.info("Initializing Gradio interface...")
demo = build_app()
logger.info("Launching Gradio app.")
demo.launch(debug=True) |