chatdoc  by daodao97

Chat app for interacting with documents via OpenAI

created 2 years ago
457 stars

Top 67.1% on sourcepulse

GitHubView on GitHub
Project Summary

ChatDoc enables users to converse with their documents using OpenAI's language models. This tool is designed for individuals who need to quickly extract information or gain insights from various document formats, including PDF, EPUB, Markdown, TXT, and DOCX, as well as web pages.

How It Works

The application leverages OpenAI's API to process document content and facilitate natural language interactions. Users upload documents, which are then parsed and indexed. When a query is submitted, the system retrieves relevant document segments and uses OpenAI to generate a contextually appropriate answer.

Quick Start & Requirements

  • Backend: cd server && ./start {OPEN_AI_KEY} (Python 3.9.7)
  • Frontend: cd client && ./start (Node.js v16.11.0)
  • Docker: Replace OPEN_AI_KEY in docker-compose.yml and run docker-compose up.
  • Prerequisites: OpenAI API Key.

Highlighted Details

  • Supports multiple document formats: PDF, EPUB, Markdown, TXT, DOCX.
  • Can interact with web page content.
  • Offers both local and Docker deployment options.

Maintenance & Community

No specific information on contributors, sponsorships, or community channels is provided in the README.

Licensing & Compatibility

The license is not specified in the README.

Limitations & Caveats

The project appears to be an example implementation, and its stability, scalability, and long-term maintenance are not detailed. The README does not specify error handling or limitations on document size or complexity.

Health Check
Last commit

2 years ago

Responsiveness

1 day

Pull Requests (30d)
0
Issues (30d)
0
Star History
4 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.