Framework Docs AI

Framework docs ai

Framework Docs AI ist eine leistungsstarke SaaS -Lösung, die das Dokumentationsmanagement für verschiedene Rahmenbedingungen revolutioniert. Es kratzt die Framework-Dokumentation nahtlos ab, erstellt eine umfassende Wissensbasis und verwendet erweiterte Sprachmodelle, um genaue Reaktionen auf Abrufbasis auf Benutzeranfragen zu liefern.

Merkmale

• Automatische Dokumentation Scraping : Mühelos Dokumentation aus beliebten Frameworks sammeln.
• Intelligente Wissensbasis : Store und organisierst abgekratzte Daten zum effizienten Abruf.
• Antworten auf KI-betriebene Antworten : Nutzen Sie hochmoderne Sprachmodelle für genaue Antworten.
• Anpassbare Framework -Unterstützung : Fügen Sie Ihre eigenen Frameworks hinzu oder verwenden Sie vorhandene.
• Benutzerfreundliche Schnittstelle : Erstellt mit Stromflächen für eine reibungslose Benutzererfahrung.

Technologien verwendet

• UI : Stromlit
• Vektordatenbank : Chroma DB
• Funktionsaufruf : PHI -Daten
• Sprachmodell : GPT-4O-Mini

Unterstützte Frameworks

1. Langchain
2. Weiter.js
3. Vue.js
4. Pytorch
5. Kette
6. MDN Web Docs

Erste Schritte

Voraussetzungen

• Python 3.7+
• Pip

Installation

1. Klonen Sie das Repository:

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

2. Installieren Sie die erforderlichen Abhängigkeiten:

    pip install -r requirements.txt
   

3. Richten Sie Ihren OpenAI -API -Schlüssel ein:

   • Erstellen Sie eine .env -Datei im Stammverzeichnis
   • Fügen Sie Ihren OpenAI -API -Schlüssel hinzu:

      OPENAI_API_KEY=your_api_key_here
     

Verwendung

1. Führen Sie die Anwendung aus:

    python app.py
   

2. Öffnen Sie Ihren Webbrowser und navigieren Sie zur bereitgestellten lokalen URL (normalerweise http://localhost:8501 ).

3. Beginnen Sie mit der Erkundung von Framework -Dokumentation und stellen Sie Fragen!

? Hinzufügen von benutzerdefinierten Frameworks

Sie können der Rahmendocs AI Ihre eigenen benutzerdefinierten Frameworks hinzufügen. Folgen Sie folgenden Schritten:

1. Kriechen Sie die URLs (crawler.py) :

   • Die Datei crawler.py verwendet eine DomainCrawler -Klasse, um Websites zu kriechen und URLs zu sammeln.
   • Schlüsselkomponenten zum Ändern:

      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"

   • Passen Sie die Liste CONFIGS an:
     • start_url : Die Basis -URL der Dokumentation Ihres Frameworks.
     • docs_path : Der spezifische Pfad, in dem die Dokumentation beginnt.
     • avoid_keywords : Liste der Schlüsselwörter, die in URLs vermieden werden sollen (z. B. Blog -Beiträge, Community -Seiten).
   • Update OUTPUT_PATH und FILE_NAME nach Bedarf.
   • Der Crawler versucht, eine Sitemap.xml zu verwenden, falls verfügbar, und fällt dann auf das Kriechen aus dem angegebenen docs_path zurück.
   • Es verwendet Multi-Threading, um mehrere Konfigurationen gleichzeitig zu kriechen.
   • Führen Sie crawler.py aus, um die krabbenden URLs in der angegebenen Ausgabedatei zu speichern.

2. Kratzen Sie den Inhalt ab :

   • Verwenden Sie scrape.py , um Inhalte aus den gekrabbelten URLs zu extrahieren.
   • Ändern Sie die Dateipfade in scrape.py um Ihrem neuen Framework zu entsprechen:

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

   • Führen Sie scrape.py aus, um den abgekratzten Inhalt im Verzeichnis data/Scraped_data zu speichern.

3. Konvertieren Sie in Langchain -Dokumentformat :

   • Verwenden Sie save.py , um den abgekratzten JSON in eine mit dem Dokumentschema von Langchain kompatibele Gurke -Datei umzuwandeln.
   • Aktualisieren Sie die Dateipfade in save.py :

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

   • Run save.py ausführen, um die Gurkendatei zu erstellen.

4. app.py aktualisieren :

   • Initialisieren Sie die Wissensbasis für Ihren neuen Framework:

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

   • Erstellen Sie einen Assistenten für Ihren Framework:

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

   • Fügen Sie Ihr Framework den Seitenleistenoptionen hinzu:

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

   • Behandeln Sie die Auswahl Ihres Frameworks:

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

5. Starten Sie die Anwendung neu :

   • Führen Sie app.py erneut aus, um Ihr neues Framework in Aktion zu sehen.

Denken Sie daran, "your_framework" und "Ihren Framework -Namen" durch die entsprechenden Namen für Ihr benutzerdefiniertes Framework zu ersetzen.

? Beitragen

Wir begrüßen Beiträge! Weitere Informationen finden Sie in unserem beitragenden Leitfaden.

? Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert - Einzelheiten finden Sie in der Lizenzdatei.

Anerkennung

• Straffer für das intuitive UI -Framework
• Alle Open-Source-Projekte, die dies möglich machten

---