CoolFace
Apppublic

william-ai-dev/xai-document-research

sourceHugging Faceupdated 7mo agoView on Hugging Face
0likes
App README

XAI Document Research Assistant

A sophisticated RAG (Retrieval-Augmented Generation) application for document analysis with advanced evaluation metrics and LangSmith tracing.

Features

  • โ€”๐Ÿ“„ Multi-format Support: PDF, TXT, MD, DOCX document processing
  • โ€”๐Ÿ” Advanced Retrieval: Hybrid search with semantic and BM25 ranking
  • โ€”๐Ÿง  AI-Powered Analysis: Groq Llama 3.1 integration for intelligent responses
  • โ€”๐Ÿ“Š Quality Metrics: Faithfulness and answer relevancy evaluation using Ragas
  • โ€”๐Ÿ”— LangSmith Tracing: Full observability and debugging capabilities
  • โ€”๐Ÿ’ฌ Interactive Chat: Streamlit-based conversational interface
  • โ€”โšก Real-time Processing: Efficient embedding and retrieval pipeline

Technical Stack

  • โ€”Frontend: Streamlit
  • โ€”LLM: Groq Llama 3.1
  • โ€”Vector Database: ChromaDB
  • โ€”Embeddings: Sentence Transformers
  • โ€”Evaluation: Ragas framework
  • โ€”Tracing: LangSmith
  • โ€”Document Processing: PyMuPDF4LLM, MarkItDown

Usage

  1. 1.Upload a document (PDF, TXT, MD, or DOCX)
  2. 2.Click "Process Document" to analyze and embed the content
  3. 3.Ask questions about the document
  4. 4.View detailed analysis including reasoning, sources, and quality metrics

Environment Variables

For Hugging Face Spaces, set these in the Secrets section:

  • โ€”LANGCHAIN_API_KEY: Required for LangSmith tracing
  • โ€”GROQ_API_KEY: Required for Groq LLM access
  • โ€”LANGCHAIN_PROJECT: Project name for LangSmith (optional, defaults to "default")

Installation

bash
pip install -r requirements.txt
streamlit run app.py

License

MIT License