mainbot

メインボット

マルチテナントのヘッドレス RAG チャット ボット。

これは、取得拡張生成を使用するマルチテナント チャット ボットの単純な実装です。

このコードの一部は Wanderling からのものですが、ゲーム固有の機能とルール エンジンはすべて削除されています (まだオープンソース化する準備ができていません)。

クイックスタート

example.envファイルを.envにコピーします。
openai と pinecone の値を更新します。

 make dev

http://localhost:8080/swagger-ui/index.html を開きます

概要

特徴

• マルチテナントの準備のための名前空間ベクトル ストレージ
• JWTヘッダーによるOAuth認証
• ユーザーセッションの分離
• ユーザーセッションの履歴と継続
• シンプルな埋め込みパイプラインを使用してベクター ストレージにドキュメントを追加する
• デフォルトのチャットエクスペリエンスとしての拡張生成の取得

認証オプション

• 匿名
• JWT
• OAuth2

会話の保存オプション

• H2
• ポストグレ

ベクターストレージオプション

• 松ぼっくり
• オープンサーチ
• 記憶の中で

パイプラインのオプションの埋め込み

• OpenAI
• オープンサーチ
• 複製する

闊歩する

セッションを開始する

メッセージを送信する

構成例

Spring プロファイルは、アプリケーションの構成に使用されます。
いくつかの設定例を参照してください (./src/main/resources/)[./src/main/resources/]

構成は、YAML、プロパティ、または環境変数で設定できます。

埋め込み用の OpenAI とベクトル ストレージ用の Pinecone

OPENAI_ENABLED=true
OPENAI_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxx
OPENAI_CHAT_MODEL_ID=gpt-3.5-turbo
PINECONE_ENABLED=true
PINECONE_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
PINECONE_PROJECT_NAME=my-project
PINECONE_INDEX=my-index
PINECONE_ENVIRONMENT=us-east4-gcp
APP_SECURITY_ENABLED=false

埋め込み用の OpenAI とベクトル ストレージ用の OpenSearch

詳細については、application-opensearch.yml のアプリケーション構成を参照してください。

SPRING_PROFILES_ACTIVE=opensearch
OPENAI_ENABLED=true
OPENAI_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxx
OPENAI_CHAT_MODEL_ID=gpt-3.5-turbo
OPENSEARCH_URL=https://localhost:9200

アップロードする GitHub アクション

ドキュメントをリポジトリに保存すると、メインボットに簡単にアップロードできます。
GitHub アクションを利用して、テキスト/マークダウン ファイルをメインボットに直接アップロードします。

 name : Upload Files to Mainbot

on :
  workflow_dispatch : {} # Manually trigger the workflow
  push :
    branches :
      - main
    paths :
      - ' docs/** '
      - ' README.md '

jobs :
  upload :
    runs-on : ubuntu-latest
    steps :
      - name : Checkout repository
        uses : actions/checkout@v2
      
      - name : Upload Files
        uses : savantly-net/mainbot-github-action@main
        with :
          glob-patterns : ' *.md '  # Set your file pattern here
          namespace : ' /mainbot-documents '
          api-url : ' https://mainbot.my-company.apps.savantly.cloud '
          client-id : ${{ secrets.MAINBOT_CLIENT_ID }}
          client-secret : ${{ secrets.MAINBOT_CLIENT_SECRET }}
          token-endpoint : https://oidc.apps.savantly.cloud/realms/savantly/protocol/openid-connect/token 

バックステージ統合

また、メインボットと統合するための Backstage プラグインも構築しました。
Github アクションと Techdocs プラグインを組み合わせると、すべてのドキュメントを Backstage ですぐに利用でき、メインボットで検索できるようになります。