feat: Initial SCP project setup with AI-powered document compliance tools

2025-04-21 22:49:29 +01:00
commit b0ec64b883
28 changed files with 2405 additions and 0 deletions
@@ -0,0 +1,64 @@
+# Mini SpecsComply Pro (SCP)
+
+## Overview
+
+Mini SpecsComply Pro (SCP) is a lightweight document compliance and validation tool designed to analyze and verify technical documents against predefined standards and project-specific requirements. It leverages advanced AI models for embedding, reasoning, and ranking to ensure fast and accurate document processing.
+
+## Key Features
+
+- **Document Embedding:** Uses Cohere Embedding Model to generate vector representations for efficient comparison.
+- **Fast LLM Processing:** GROQ LLM provides rapid document parsing and analysis.
+- **Advanced Reasoning:** Claude 3.5 Sonnet is used for deep reasoning and compliance verification.
+- **Enhanced Ranking:** Cohere Reranker ensures the most relevant compliance issues are prioritized.
+- **Structured Compliance Feedback:** Generates summaries and detailed issue breakdowns for document corrections.
+- **Efficient Resubmission Workflow:** Allows users to revise and resubmit documents based on feedback.
+
+## Tech Stack
+
+- **Backend:** Python (FastAPI or Flask for API development)
+- **Vector Database:** Pinecone or Weaviate for document embeddings storage and retrieval
+- **LLMs:**
+
+  - GROQ for quick responses
+  - Claude 3.5 Sonnet for reasoning
+- **Embedding & Reranking:**
+
+  - Cohere Embedding Model
+  - Cohere Reranker
+
+## Workflow
+
+1. **Document Upload**
+
+   - User uploads a document for compliance verification.
+   - Document is converted into embeddings using the Cohere Embedding Model.
+   - Stored in the vector database for efficient retrieval.
+2. **Processing & Analysis**
+
+   - GROQ LLM parses the document and extracts key sections.
+   - Claude 3.5 Sonnet performs reasoning to check compliance against standards.
+   - Cohere Reranker prioritizes the most critical compliance issues.
+3. **Compliance Report Generation**
+
+   - A structured report is generated, including:
+     - **Summary of Findings**
+     - **Detailed Compliance Issues**
+     - **Recommended Fixes**
+4. **Feedback & Resubmission**
+
+   - User receives feedback and revises the document.
+   - Resubmitted documents undergo the same pipeline for re-evaluation.
+
+## API Endpoints (Example)
+
+```yaml
+POST /upload-document
+  - Uploads a document for analysis
+  - Returns document ID for tracking
+
+GET /document/{doc_id}/analysis
+  - Retrieves the compliance report for a document
+
+POST /document/{doc_id}/resubmit
+  - Allows resubmission of a revised document
+```