DocsGPT simplifies documentation with AI-powered assistance. Integrating it with Novita AI enhances its performance, offering faster processing, scalable resources, and advanced model support for improved productivity. This guide walks you through how to use DocsGPT with Novita AI based on the OpenAl APl, offering a way to query your content and get served customized answers.

​
How to use DocsGPT

​
Prerequisites:

Docker: Ensure you have Docker installed and running on your system.

​
Launching DocsGPT (macOS and Linux)

For macOS and Linux users, the easiest way to launch DocsGPT is using the provided setup.sh script. This script automates the configuration process and offers several setup options. Step 1: Download the DocsGPT repository
  • First, you need to download the DocsGPT repository to your local machine. You can do this using Git:
git clone https://github.com/arc53/DocsGPT.git
cd DocsGPT
Step 2: Run the setup.sh script
  • Navigate to the DocsGPT directory in your terminal and execute the setup.sh script:
./setup.sh
This interactive script will guide you through setting up DocsGPT. It offers four options: using the public API, running locally, connecting to a local inference engine, or using a cloud API provider. The script will automatically configure your .env file and handle necessary downloads and installations based on your chosen option.

​
Launching DocsGPT (Windows)

For Windows users, please refer to the Docker Deployment documentation for detailed step-by-step instructions on setting up DocsGPT using Docker.

​
How to Integrate Novita AI API with DocsGPT

Step 1: Log in to Novita AI and create an API Key
images/3-1LogintoNovitaAI.png
images/3-2CreateanAPIKey.png
Step 2: Select option4 and connect cloud API provider in your terminal
images/2SelectOption4andConnectCloudAPIProvider.png
Step 3: Choose option7 Novita and enter the API key you just created
images/4ChooseOption7NovitaandEntertheAPIKeyYouJustCreated.png
Step 4: Wait for the startup process to complete
images/5WaitfortheStartupProcesstoComplete.png
Step 5: Access DocsGPT in your browser
  • Once the setup is complete and Docker containers are running, navigate to http://localhost:5173/ in your web browser to access the DocsGPT web application.
images/6AccesstheApplicationathttp-localhost-5173.jpeg
Step 6: Stopping DocsGPT
  • To stop DocsGPT, simply open a new terminal in the DocsGPT directory and run:
docker compose -f deployment/docker-compose.yaml down
  • (or the specific docker compose command shown at the end of the setup.sh execution, which may include optional compose files depending on your choices).