open source slack ai

オープンソーススラックAIアプリ

このリポジトリは、自分自身をホストし、OpenAIを使用してスレッドとチャネルを要約する機能のロックを解除できる、すぐに実行できる基本的なSlack AIソリューションです（需要がある場合は、代替およびオープンソースLLMのサポートが追加されます）。公式のSlack AI製品は素晴らしく見えますが、アクセスとアドオンの価格が限られているため、2023年9月に作成したバージョンをオープンソースすることにしました。

稼働した後（プロセス全体の指示を以下に示します）、すべてのSlackユーザーは、パブリックとプライベートの両方に生成できます。

1. スレッドの要約- 任意のスラックスレッドの詳細な概要を生成します（GPT-3.5-ターボを搭載）
2. チャネルの概要- 拡張メッセージ履歴に基づいてチャネルの目的の概要を生成します（NLPモデルのアンサンブルと少しGPT -4を搭載して、自然言語での分析を説明する）
3. 以降のチャネルの要約- 特定の時点からチャネルのメッセージの詳細な要約を生成します（GPT-3.5-ターボを搭載）。カスタムプロンプトをサポートして！ eg /tldr_since anonymize the summary 。注：これにはまだスレッドが含まれていません。
4. フルチャネルの要約（実験） - チャネルの拡張履歴（GPT-3.5-ターボを搭載した）の詳細な要約を生成します。カスタムプロンプトをサポートして！ EG /tldr_extended anonymize the summary 。注：これは非常に長くなる可能性があります！

目次

• はじめる
  • 前提条件
  • インストール
  • 使用法
  • カスタマイズ
• テスト
• 将来の強化
• 貢献

はじめる

これらの指示に従って、開発とテストの目的で地元のマシンでプロジェクトのコピーを稼働させます。

前提条件

地元の開発マシンに次の事前に設定またはインストールされていることを確認してください。

• Python 3.9.x -3.11.x
• Openai APIキー
• Slack App＆Assotioning 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

スラックアプリの構成

manifest.jsonのコピーを作成し、要求URLをngrokまたはサーバーURLに変更します。

ここで新しいスラックアプリを作成し、 manifest.yamlファイルを使用して構成します。

他の変更を加える必要はありませんが、名前、説明、その他のコピーに関連する設定を変更できます。

スラッシュコマンドの名前を調整する場合は、 slack_server.py変更する必要があります。

構成したら、「インストールアプリ」ページから「ボットユーザーOAuthトークン」を取得し、 .envファイルにSLACK_BOT_TOKENとして追加します。

次に、アプリレベルのトークンの下の基本情報ページで、 SLACK_APP_TOKEN connections:writeトークン.env作成します。

使用法

アプリケーションを実行するには、Fastapiサーバーを実行します。

poetry run uvicorn ossai.slack_server:app --reload

その後、ngrokを使用してサーバーをインターネットに公開する必要があります。

次のコマンドでngrokを実行します： ngrok http 8000

次に、Slackアプリの設定にngrok URLを追加します。

カスタマイズ

主なカスタマイズオプションは次のとおりです。

• チャネルの概要： topic_analysis.pyでchatgptプロンプトをカスタマイズします
• スレッドの概要： summarizer.pyでchatgptプロンプトをカスタマイズします

テスト

このプロジェクトでは、 pytestとpytest-covを使用してテストを実行し、テストカバレッジを測定します。

これらの手順に従って、カバレッジでテストを実行します。

1. プロジェクトルートディレクトリに移動します。

2. 次のコマンドを実行して、カバレッジでテストを実行します。

   pytest --cov=ossai tests/

   このコマンドはtests/ディレクトリですべてのテストを実行し、 ossaiモジュールのカバレッジレポートを生成します。

3. テストを実行した後、テストでカバーされているコードの割合を示すレポートが端末に表示され、カバーされていない行が強調表示されます。

仮想環境を使用している場合は、これらのコマンドを実行する前にアクティブ化されていることを確認してください。

将来の強化

• 拡張性、トレース、コントロールのために、Langchain＆Langsmithに移動します
• Langsmithのフィードバック機能を活用して、ユーザーのフィードバックからキャプチャして学習する
• /tldr_sinceコマンドを追加して、特定の日付からチャネルのメッセージを要約する
• Slackアプリのセットアップの詳細とサンプルアプリマニフェストをREADMEに追加する
• チャネルレベルの要約にスレッド会話を組み込みます
• ユニットテストを補完するためにEVALSスイートを実装します
• 代替およびオープンソースLLMのサポートを追加します
• データを収集するためのワークフローを探索し、コスト削減のための微調整モデル
• 匿名化されたメッセージの概要のサポートを追加します
• Chain of Destinyなどのプロンプトツールを活用します
• 会社の知識ベースなどの外部ソースからサポートコンテキストを引くためのサポートを追加する
• キャッシュやその他のパフォーマンスの最適化を調べてください
• 感情分析を探索します

貢献

私は貢献を歓迎します！フィードバック、バグ、機能リクエスト、拡張機能、または自分のプルリクエストを送信する方法の詳細については、 CONTRIBUTING.mdをお読みください。

ライセンス

このプロジェクトは、GPL -3.0ライセンスに基づいてライセンスされています。詳細については、 LICENSE.mdファイルを参照してください。