Developed RAG-based URL Analyzer for Personalized Article Insights

[Varsha-1605]

Fixes: #371

Description

Implement a RAG-based URL Analyzer for Retro to allow users to input article URLs related to vintage topics and receive personalized answers. The system will retrieve article content, generate embeddings, and provide custom responses using Retrieval-Augmented Generation (RAG) for enhanced user engagement.

Created 4 files:

• app.py - for backend
• qa.html - for frontend
• environment variable - for storing secrets
• .gitignore file - to avoid secrets get committed

1. Navbar Functionality:

   • Navigation links for different sections like Home, Sign-in and Share Experience.

2. URL-based Question-Answer (QA) System:

   • URL Input:
     • Input field for users to enter a URL for document processing.
     • Submit button to trigger backend processing of the URL.
   • Question Input:
     • Input field for users to enter a question related to the processed document.
     • Submit button to receive an answer based on the document content.
   • Answer Display:
     • Display area for showing the answer generated by the system.
     • Highlighting of relevant sources used for generating the answer.

3. Question Answering System (Q&A) using Langchain:

   • AI Model Integration:
     • Leverages AI/ML models for processing documents and answering user questions based on the content.
     • Integrates Langchain-based pipeline to manage document parsing and Q&A.
   • Document Search:
     • Uses embeddings to search for relevant answers from the vectorized documents.
   • Formatted Answer Display:
     • Provides answers to user questions with relevant sections of the document highlighted.

4. Frontend Form Submission and Response Handling:

   • Form Handling:
     • Frontend form submission for URL-based document processing and question asking.
     • Interaction between frontend and backend to submit user queries and receive answers.
   • Backend Communication:
     • Processes inputs (URLs, and questions) and forwards them to the backend AI model for Q&A processing.
   • Response Display:
     • Displays responses generated by the backend on the frontend for users to view.

5. Footer Functionality:

   • Footer Links:
     • Quick navigation links to sections such as Home, About, Services, Cart.
     • Additional information on offers and payment options.
   • Contact Form:
     • A form for users to submit their email and message.
     • Submit button for sending messages to the site admins.
   • Social Media Integration:
     • Icons and links for social media platforms like Facebook, Instagram, and Twitter.
   • Back to Top Button:
     • A button at the footer to scroll back to the top of the page.

6. Error Handling and Feedback:

   • Provides user-friendly feedback in case of errors during document processing (e.g., invalid URLs or unsupported file formats).
   • Displays error messages or notifications on both the frontend and backend to assist users in resolving issues.

7. User Session Management:

   • Manages sessions to store document embeddings for current users, ensuring smooth transition between different stages of document analysis and Q&A.

Type of PR

• Bug fix
• Feature enhancement

Screenshots:

Checklist:

• I have made this change from my own.
• I have taken help from some online resources.
• My code follows the style guidelines of this project.
• I have performed a self-review of my own code.
• I have commented my code, particularly in hard-to-understand areas.
• I have made corresponding changes to the documentation.
• My changes generate no new warnings.
• I have tested the changes thoroughly before submitting this pull request.
• I have provided relevant issue numbers and screenshots after making the changes.

@PriyaGhosal Kindly add all the required labels as per the task completion.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
buddy-trail	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 12, 2024 5:30pm

[github-actions]

Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. In the meantime, please ensure that your changes align with our contributing.md. If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊

[netlify]

❌ Deploy Preview for buddytrail failed. Why did it fail? →

Name	Link
🔨 Latest commit	811d388
🔍 Latest deploy log	https://app.netlify.com/sites/buddytrail/deploys/670ab217044cae0008df2144

[PriyaGhosal]

@Varsha-1605
Due to a conflicting issue, some code was removed from the repository. We are investigating the matter. Meanwhile, please check on your end, and if your PR code no longer exists, kindly create the PR again for merging.Please Do Sync fork before then add your part in code as none of the contributions are visible in website BuddyTrail. Thank you for your understanding!

[Varsha-1605]

@PriyaGhosal I went through that there was an issue in style.css kindly correct it from your side as everything is correct from mine.