/DocsGPT

GPT-powered chat for documentation search & assistance.

Primary LanguagePythonMIT LicenseMIT

DocsGPT 🦖

Помічник з документації з відкритим кодом

DocsGPT це передове рішення з відкритим кодом, яке спрощує процес пошуку інформації в проектній документації. Завдяки інтеграції потужних моделей GPT розробники можуть легко ставити запитання про проект і отримувати точні відповіді.

Попрощайтеся з трудомістким ручним пошуком і дозвольте DocsGPT допомогти вам швидко знайти потрібну інформацію. Спробуйте й подивіться, як це революціонізує ваш досвід проектної документації. Внесіть свій внесок у його розвиток і станьте частиною майбутнього допомоги на основі ШІ.

example1 example2 example3 example3

video-example-of-docs-gpt

Oсобливості

Group 9

Дорожня карта

Ви можете знайти нашу Roadmap тут, будь ласка, не соромтеся робити внески або створювати проблеми, це допоможе нам покращити DocsGPT!

Структура проекту

  • Application - програма flask (основна програма)

  • Extensions - розширення chrome

  • Scripts - сценарій, який створює індекс пошуку подібності та зберігає для інших бібліотек.

  • frontend - інтерфейс in vite and

Швидкий початок

Примітка. Переконайтеся, що докер встановлено

  1. Відкрийте завантажте це сховище за допомогою git clone https://github.com/arc53/DocsGPT.git
  2. Відкрийте docker-compose.yaml і замініть <your_api_key> на ваш ключ OpenAI (є 4 місця)
  3. Запустіть docker-compose build && docker-compose up

Щоб зупинитися, просто запустіть Ctrl + C

Середовища розробки

Розгорнути лише 2 контейнери з docker-compose.yaml (видаливши всі служби, крім redis і mongo)

Переконайтеся, що у вас встановлено python 3.10 або 3.11

  1. Перейдіть до папки /application
  2. Встановити залежності pip install -r requirements.txt
  3. Підготуйте файл .env Скопіюйте .env_sample і створіть .env за допомогою токена openai API
  4. Запустіть програму python app.py
  5. Почніть робщту з celery -A app.celery worker -l INFO

Щоб запустити інтерфейс:

  1. Navigate to /frontend folder
  2. Install dependencies npm install
  3. In the file .env.development instead of VITE_API_HOST = https://docsapi.arc53.com use VITE_API_HOST=http://localhost:5001
  4. Run the app
  5. npm run dev

Як встановити розширення Chrome?

Побудований 🦜️🔗 LangChain