DocsGPT - Open Source Intelligent Document Assistant

Project Overview

DocsGPT is an open-source generative AI tool that helps users obtain reliable answers from any knowledge source while avoiding hallucination issues. It enables fast and reliable information retrieval with built-in tools and agent system capabilities.

DocsGPT is an open-source document assistant based on RAG (Retrieval-Augmented Generation) technology, specifically designed for document question answering and knowledge management scenarios.

Core Features

📁 Wide Format Support

• Supported Formats: PDF, DOCX, CSV, XLSX, EPUB, MD, RST, HTML, MDX, JSON, PPTX, and image files
• Multi-Source Data Ingestion: Supports URLs, sitemaps, Reddit, GitHub, and web crawlers

🎯 Reliable Answer Generation

• Accuracy Guarantee: Provides accurate, hallucination-free responses
• Source Citation: Displays viewable source citations in a clear UI
• Context-Based: Specifically optimized for context provided by documents

🔑 Simplified API Management

• API Key Management: Generate and set keys associated with documents and models
• Simplified Integration: Streamlines chatbot and integration setup

🔗 Actionable Tool Integration

• API Connectivity: Connect to APIs, tools, and other services
• LLM Operations: Enables operational capabilities for large language models

🧩 Pre-built Integrations

• Ready-to-Use Components: HTML/React chat widgets
• Search Tools: Built-in search functionality
• Bot Integrations: Discord/Telegram bot support

🔌 Flexible Deployment Options

• Multi-Model Support: Compatible with major LLM providers (OpenAI, Google, Anthropic)
• Local Models: Supports local models (Ollama, llama_cpp)
• Deployment Methods: Supports various deployment methods such as Docker and Kubernetes

🏢 Security and Scalability

• Private Running: Supports private deployment
• Enterprise-Grade: Designed for enterprise-level reliability
• Kubernetes Support: Supports containerized deployment

Technical Architecture

Project Structure

• Application: Flask application (main application)
• Extensions: Extension components, such as React widgets or Discord bots
• Scripts: Various auxiliary scripts

Deployment Methods

The project offers several deployment options:

1. Using a public API
2. Running locally
3. Connecting to a local inference engine
4. Using a cloud API provider

Quick Start

System Requirements

Ensure Docker is installed

Installation Steps

1. Clone the Repository

git clone https://github.com/arc53/DocsGPT.git
cd DocsGPT

2. Run the Setup Script

For macOS and Linux:

./setup.sh

For Windows:

PowerShell -ExecutionPolicy Bypass -File .\setup.ps1

3. Access the Application Navigate to http://localhost:5173/

4. Stop the Service

docker compose -f deployment/docker-compose.yaml down

Use Cases

Enterprise Document Management

• Internal knowledge base Q&A
• Technical documentation retrieval
• Employee training support

Developer Support

• Code documentation query
• API documentation assistant
• Technical support automation

Education and Training

• Learning material Q&A
• Course content retrieval
• Online education assistance

Summary

DocsGPT, as a powerful and flexible open-source document assistant, provides organizations of all sizes with solutions to improve document workflows and increase productivity. Its private deployment capabilities and enterprise-grade features make it particularly suitable for organizations with strict data security requirements.