Framework Docs AI

مستندات إطار منظمة العفو الدولية

Framework Docs AI هو حل قوي SaaS الذي يحقق ثورة في إدارة الوثائق لمختلف الأطر. إنه يقوم بإلغاء توثيق الإطار بسلاسة ، ويقوم بإنشاء قاعدة شاملة للمعرفة ، ويستخدم نماذج اللغة المتقدمة لتوفير استجابات دقيقة تستند إلى استرجاع لاستعلامات المستخدم.

سمات

• تجريف الوثائق التلقائية : جمع الوثائق دون عناء من الأطر الشعبية.
• قاعدة المعرفة الذكية : تخزين وتنظيم بيانات كشط للحصول على استرجاع فعال.
• الاستجابات التي تعمل بمواد الذكاء الاصطناعي : الاستفادة من نماذج اللغة الحديثة للحصول على إجابات دقيقة.
• دعم إطار قابلة للتخصيص : أضف الأطر الخاصة بك أو استخدم الإطار الموجود.
• واجهة سهلة الاستخدام : تم تصميمها مع STIPLELIT لتجربة مستخدم سلسة.

التقنيات المستخدمة

• واجهة المستخدم : STREMLIT
• قاعدة بيانات المتجهات : Chroma DB
• استدعاء الوظيفة : بيانات PHI
• نموذج اللغة : GPT-4O-MINI

الأطر المدعومة

1. لانجشين
2. Next.js
3. vue.js
4. Pytorch
5. سلسلة
6. مستندات الويب MDN

ابدء

المتطلبات الأساسية

• بيثون 3.7+
• pip

تثبيت

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. ابدأ في استكشاف الوثائق الإطارية وطرح الأسئلة!

؟ إضافة الأطر المخصصة

يمكنك إضافة الأطر المخصصة الخاصة بك إلى مستندات الإطار AI. اتبع هذه الخطوات:

1. زحف عناوين URL (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" و "اسم الإطار الخاص بك" بالأسماء المناسبة لإطار العمل المخصص الخاص بك.

؟ المساهمة

نرحب بالمساهمات! يرجى الاطلاع على دليل المساهمة لدينا لمزيد من التفاصيل.

؟ رخصة

تم ترخيص هذا المشروع بموجب ترخيص معهد ماساتشوستس للتكنولوجيا - راجع ملف الترخيص للحصول على التفاصيل.

شكر وتقدير

• تدفق لإطار واجهة المستخدم البديهية
• جميع المشاريع المفتوحة المصدر التي جعلت هذا ممكنًا

---