chatdoc - Enhance Document Interaction Across Formats with AI Technology

Introduction to ChatDoc

ChatDoc is an innovative project showcasing the integration of OpenAI's capabilities with document interaction. It offers users a seamless experience to engage with various document types using conversational AI technology. Currently, ChatDoc supports several popular document formats including .pdf, .epub, .md, .txt, .docx, and even content from the web.

Setting Up the Backend

To get started with ChatDoc, users need to launch the backend service. This requires a local Python environment, specifically version 3.9.7 in the example provided. Here's a straightforward process to initiate the backend:

Navigate to the server directory in your command line interface.
Execute the startup command while providing your OpenAI API key:
```
cd server
./start {OPEN_AI_KEY}
```

This will activate the backend service capable of handling the document interactions.

Setting Up the Frontend

After the backend is up and running, the next step is to set up the frontend. The example utilizes Node.js version 16.11.0. Launching the frontend involves:

Moving into the client directory.
Starting the client application with a simple command:
```
cd client
./start
```

This will make the application available for users to start engaging with their documents in a conversational manner.

Docker Deployment

For those inclined towards containerized environments, ChatDoc also offers a Docker deployment option. This is particularly useful for ensuring consistency across different setups. Here’s a brief guide to deploying using Docker:

Replace the placeholder in the docker-compose.yml file with your actual OpenAI API key.
Run the Docker Compose command to set up the environment:
```
docker-compose up
```

This method simplifies the deployment process by encapsulating both the backend and frontend within Docker containers.

In summary, ChatDoc provides a robust framework for interacting with documents conversationally, leveraging the power of OpenAI. Its ability to handle multiple document formats and offer deployment flexibility through Docker makes it a practical solution for various use cases.