Framework Docs AI

Рамочные документы AI

Framework Docs AI - это мощное решение SaaS, которое революционизирует управление документациями для различных структур. Он беспрепятственно сочетает структуру документации, создает исчерпывающую базу знаний и использует расширенные языковые модели для обеспечения точных, основанных на поиске ответов на запросы пользователей.

Функции

• Автоматическая документация по цене : без особых усилий собирать документацию из популярных рамок.
• Интеллектуальная база знаний : хранить и организовать сокраренные данные для эффективного поиска.
• Ответы с AI , использующие современные языковые модели для точных ответов.
• Настраиваемая фреймворческая поддержка : добавьте свои собственные фреймворки или используйте существующие.
• Интерфейс, удобный для пользователя : построенный с Streamlit для плавного пользовательского опыта.

Технологии используются

• UI : Streamlit
• Векторная база данных : Chroma DB
• Функция вызова : PHI данные
• Языковая модель : GPT-4O-Mini

Поддерживаемые рамки

1. Лангхейн
2. Next.js
3. Vue.js
4. Пирог
5. Цепно
6. MDN Web Docs

Начиная

Предварительные условия

• Python 3.7+
• пип

Установка

1. Клонировать репозиторий:

    git clone https://github.com/yourusername/framework-docs-ai.git
   cd framework-docs-ai
   

2. Установите требуемые зависимости:

    pip install -r requirements.txt
   

3. Настройте свой ключ API OpenAI:

   • Создайте файл .env в корневом каталоге
   • Добавьте свой ключ API OpenAI:

      OPENAI_API_KEY=your_api_key_here
     

Использование

1. Запустите приложение:

    python app.py
   

2. Откройте свой веб -браузер и перейдите в предоставленный локальный URL (обычно http://localhost:8501 ).

3. Начните изучать структуру документации и задавать вопросы!

? Добавление пользовательских фреймворков

Вы можете добавить свои собственные индивидуальные фреймворки в Framework Docs AI. Следуйте этим шагам:

1. Пожмите URLS (Crawler.py) :

   • Файл crawler.py использует класс DomainCrawler для ползания веб -сайтов и сбора URL -адресов.
   • Ключевые компоненты для изменения:

      CONFIGS = [
         {
             "start_url" : "https://your-framework-docs-url.com" ,
             "docs_path" : "/" ,
             "avoid_keywords" : [ "blog" , "about" , "community" ]
         },
         # You can add multiple configurations for different sections of your documentation
     ]
     
     OUTPUT_PATH = "data/Crawled_url/"
     FILE_NAME = "YOUR_FRAMEWORK_crawled.json"

   • Настройте список CONFIGS :
     • start_url : базовый URL -адрес документации вашей структуры.
     • docs_path : конкретный путь, в котором начинается документация.
     • avoid_keywords : список ключевых слов, которых следует избегать в URL (например, сообщения в блоге, страницы сообщества).
   • Обновление OUTPUT_PATH и FILE_NAME по мере необходимости.
   • Груплер пытается использовать SiteMap.xml, если таковой имеется, затем возвращается к ползанию из указанных docs_path .
   • Он использует многопоточную для одновременного полза для многократных конфигураций.
   • Запустите crawler.py , чтобы сохранить ползанные URL -адреса в указанном выходном файле.

2. Соскребайте контент :

   • Используйте scrape.py , чтобы извлечь контент из ползанных URL -адресов.
   • Измените пути файла в scrape.py , чтобы соответствовать вашей новой структуре:

      if __name__ == "__main__" :
         Scrape ( "data/Crawled_url/YOUR_FRAMEWORK_crawled.json" , "data/Scraped_data/YOUR_FRAMEWORK_scraped.json" )

   • Запустите scrape.py , чтобы сохранить сохраненный контент в каталоге data/Scraped_data .

3. Преобразовать в формат документа Langchain :

   • Используйте save.py , чтобы преобразовать скрасной JSON в файл Pickle, совместимый со схемой документов Langchain.
   • Обновите пути файла в save.py :

      if __name__ == "__main__" :
         convert_json_to_pkl ( 'data/Scraped_data/YOUR_FRAMEWORK_scraped.json' , 'data/Scraped_data/YOUR_FRAMEWORK_scraped.pkl' )

   • Запустите save.py , чтобы создать файл Pickle.

4. Обновить app.py :

   • Инициализируйте базу знаний для вашей новой структуры:

      kb_manager_your_framework = initialize_kb ( "Your Framework Name" , "./Vector_DB/YOUR_FRAMEWORK" , "data/Scraped_data/YOUR_FRAMEWORK_scraped.pkl" )

   • Создайте помощника для вашей структуры:

      assistant_your_framework = create_assistant ( "Your Framework Name" , api_key , kb_manager_your_framework ) if kb_manager_your_framework else None

   • Добавьте свою структуру в варианты боковой панели:

      options = [ "Langchain Python" , "Next.js" , "Vue.js" , "MDN_WEB" , "Pytorch" , "Chainlit" , "Your Framework Name" ],

   • Обработайте выбор вашей структуры:

      elif selected == "Your Framework Name" and assistant_your_framework :
         display_framework ( assistant_your_framework , "Your Framework Name" )

5. Перезагрузите приложение :

   • Запустите app.py еще раз, чтобы увидеть вашу новую структуру в действии.

Не забудьте заменить «your_framework» и «ваше кадровое имя» на соответствующие имена для вашей пользовательской структуры.

? Внося

Мы приветствуем вклад! Пожалуйста, смотрите наше руководство для получения более подробной информации.

? Лицензия

Этот проект лицензирован по лицензии MIT - для получения подробной информации см. Файл лицензии.

Благодарности

• Уточняя для интуитивно понятного пользовательского интерфейса
• Все проекты с открытым исходным кодом, которые сделали это возможным

---