open source slack ai

تطبيق Slack AI Open Open Source

هذا المستودع هو حل Slack AI أساسي جاهز للتشغيل ، يمكنك استضافة نفسك وإلغاء قفل القدرة على تلخيص الخيوط والقنوات عند الطلب باستخدام Openai (سيتم إضافة دعم LLMs البديل والمصدر المفتوح إذا كان هناك طلب). يبدو منتج Slack AI الرسمي رائعًا ، ولكن مع إمكانية الوصول المحدودة والأسعار الإضافية ، قررت فتح الإصدار الذي قمت ببنائه في سبتمبر 2023.

بمجرد توفير وتشغيل (تعليمات للعملية بأكملها أدناه) ، سيتمكن جميع مستخدمي الركود من توليده إلى كل من العام والخاص:

1. ملخصات الموضوع -قم بإنشاء ملخص مفصل لأي موضوع تراكب (مدعوم من GPT-3.5 توربو)
2. نظرة عامة على القناة - قم بإنشاء مخطط تفصيلي لغرض القناة استنادًا إلى سجل الرسائل الممتد (مدعوم من مجموعة من نماذج NLP و GPT -4 قليلاً لشرح التحليل باللغة الطبيعية)
3. ملخصات القناة منذ ذلك الحين -قم بإنشاء ملخص مفصل لرسائل القناة منذ فترة زمنية معينة (مدعوم من GPT-3.5 توربو). الآن مع دعم المطالبات المخصصة! على سبيل المثال /tldr_since anonymize the summary . ملاحظة: هذا لا يشمل المواضيع حتى الآن.
4. ملخصات القناة الكاملة (التجريبية)-قم بإنشاء ملخص مفصل لتاريخ القناة الممتد (مدعوم من GPT-3.5-TURBO). الآن مع دعم المطالبات المخصصة! على سبيل المثال /tldr_extended anonymize the summary . ملاحظة: هذا يمكن أن يزول وقتًا طويلاً!

جدول المحتويات

• ابدء
  • المتطلبات الأساسية
  • تثبيت
  • الاستخدام
  • التخصيص
• الاختبار
• التحسينات المستقبلية
• المساهمة

ابدء

اتبع هذه التعليمات للحصول على نسخة من المشروع وتشغيلها على الجهاز المحلي لأغراض التطوير والاختبار.

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

تأكد من أن لديك ما يلي ما قبل التكوين أو تثبيته على جهاز التطوير المحلي الخاص بك:

• بيثون 3.9.x - 3.11.x
• مفتاح API Openai
• Slack App و Associated API الرموز
• مدير حزمة الشعر
• ngrok (موصى به)

تثبيت

1. استنساخ المستودع إلى جهازك المحلي.
2. انتقل إلى دليل المشروع.
3. قم بتثبيت حزم Python المطلوبة باستخدام الشعر:

poetry install

4. تثبيت نموذج القاموس

poetry run python -m spacy download en_core_web_md

5. قم بإنشاء ملف .env في الدليل الجذر للمشروع ، واملأه بمفاتيح API ورموزك. استخدم ملف example.env كقالب.

cp example.env .env && open .env

تكوين تطبيق Slack

قم بعمل نسخة من manifest.json وقم بتغيير عنوان URL للطلب إلى عنوان URL NGROK أو Server.

قم بإنشاء تطبيق Slack جديد هنا وتكوينه باستخدام ملف manifest.yaml الخاص بك.

يجب ألا تحتاج إلى إجراء أي تغييرات أخرى ولكن يمكنك تغيير الاسم والوصف والإعدادات الأخرى ذات الصلة بالنسخ.

إذا كنت ترغب في ضبط اسم أوامر Slash ، فستحتاج إلى تعديل slack_server.py .

بمجرد تكوينه ، استرجع "Token Oauth user bot" من صفحة "تثبيت التطبيق" وأضفه إلى ملف .env الخاص بك مثل SLACK_BOT_TOKEN .

بعد ذلك ، في صفحة المعلومات الأساسية تحت عنوان الرموز على مستوى التطبيق ، قم بإنشاء رمز رمز مع connections:write وأضفه إلى ملف .env الخاص بك مثل SLACK_APP_TOKEN .

الاستخدام

لتشغيل التطبيق ، قم بتشغيل خادم Fastapi:

poetry run uvicorn ossai.slack_server:app --reload

ستحتاج بعد ذلك إلى فضح الخادم على الإنترنت باستخدام NGROK.

قم بتشغيل Ngrok مع الأمر التالي: ngrok http 8000

ثم أضف عنوان URL NGROK إلى إعدادات تطبيق Slack.

التخصيص

خيارات التخصيص الرئيسية هي:

• ملخص القناة: تخصيص موجه ChatGPT في topic_analysis.py
• ملخص الموضوع: تخصيص موجه ChatGPT في summarizer.py

الاختبار

يستخدم هذا المشروع pytest و pytest-cov لتشغيل الاختبارات وقياس تغطية الاختبار.

اتبع هذه الخطوات لتشغيل الاختبارات بالتغطية:

1. انتقل إلى دليل جذر المشروع.

2. قم بتشغيل الأمر التالي لتنفيذ الاختبارات بالتغطية:

   pytest --cov=ossai tests/

   سيقوم هذا الأمر بتشغيل جميع الاختبارات في tests/ الدليل وإنشاء تقرير تغطية لوحدة ossai .

3. بعد إجراء الاختبارات ، سترى تقريرًا في المحطة الخاصة بك يوضح النسبة المئوية من التعليمات البرمجية التي تغطيها الاختبارات وتسلط الضوء على أي خطوط غير مغطاة.

يرجى ملاحظة أنه إذا كنت تستخدم بيئة افتراضية ، فتأكد من تنشيطها قبل تشغيل هذه الأوامر.

التحسينات المستقبلية

• انتقل إلى Langchain & Langsmith من أجل التوسيع والتتبع والتحكم
• استفد من إمكانيات التغذية المرتدة في Langsmith لالتقاط وتعلم من ملاحظات المستخدم
• إضافة أمر A /tldr_since لتلخيص رسائل القناة منذ تاريخ معين
• أضف تفاصيل إعداد تطبيق Slack وعينة من بيان التطبيق إلى README
• دمج المحادثات الخيطية في ملخصات على مستوى القناة
• قم بتنفيذ مجموعة EVALS لتكملة اختبارات الوحدة
• أضف دعمًا ل LLMS البديل والمفتوح المصدر
• استكشاف سير العمل لجمع البيانات ونماذج الضبط الدقيق لخفض التكاليف
• أضف دعمًا لملخصات الرسائل المجهولة المصدر
• الاستفادة من الأدوات السريعة مثل سلسلة القدر
• أضف دعمًا لسحب السياق الداعم من مصادر خارجية مثل قواعد المعرفة بالشركة
• استكشف التخزين المؤقت وغيرها من تحسينات الأداء
• استكشاف تحليل المشاعر

المساهمة

أنا أكثر من الترحيب بالمساهمات! يرجى قراءة CONTRIBUTING.md للحصول على تفاصيل حول كيفية إرسال التعليقات أو الأخطاء أو طلبات الميزات أو التحسينات أو طلبات السحب الخاصة بك.

رخصة

تم ترخيص هذا المشروع بموجب ترخيص GPL -3.0 - راجع ملف LICENSE.md .