ragtimeダウンロードragtimeソースコードのダウンロード

ragtime

AI ソースコード

1.0.0

ダウンロード

ラグタイム

Vectaraを使用したSlackとSiscord用のオープンソースラグボット。このボットを使用すると、サーバーに接続されているスラックまたはディスコードボットを作成し、Vectaraコーパスを照会してユーザーの質問に答えることができます。

使用法

メッセージにボットに言及して、返信を受信してください。
1：1の会話のために、ボットに直接メッセージを送信します。
ボットはメッセージとスレッドIDを保存して、スレッドまたは返信中にコンテキスト対応の返信を提供します。

例コマンド

ボットに言及してください： @bot-name Your message here
直接メッセージを送信： Your message here

インストール

前提条件

Python 3.8以降

設定

リポジトリをクローンします：

git clone https://github.com/vectara/ragtime.git
cd ragtime

必要な依存関係をインストールします。
```
 pip3 install requirement.txt
```

環境変数の設定：

プロジェクトのルートで.envファイルを作成し、次のものを追加します。

 SLACK_BOT_TOKEN=<OAuth level token>
SLACK_APP_TOKEN=<APP level token>
DISCORD_BOT_TOKEN=<Discord bot token>
VECTARA_CUSTOMER_ID="<VECTARA_CUSTOMER_ID>"
VECTARA_CORPUS_IDS="<VECTARA_CORPUS_IDS>"
VECTARA_API_KEY="<VECTARA_API_KEY>"
ACCOUNT_SID=<Twilio account SID>
Auth_TOKEN=<Twilio auth token>
TWILIO_WHATSAPP_NUMBER=<Whatsapp number configured in twilio>

エージェントラグを有効にするには、次の変数を追加します。

 ENABLE_AGENTIC_RAG=True ## To enable agentic rag. By default ragtime uses vanilla RAG.
AGENTIC_RAG_DATA_DESCRIPTION='Vectara website, docs and forum data'
AGENTIC_RAG_ASSISTANT_SPECIALTY='Vectara'
AGENTIC_RAG_TOOL_NAME='ask_vectara'

VECTARA_CUSTOMER_IDとVECTARA_CORPUS_IDS 、Vectaraアカウントと使用する関連するコーパスを指します。
VECTARA_CORPUS_IDS 、単一のコーパスID（数値）またはCORMAを分離したコーパスのリストにすることができます。

ラグタイムボットを実行します

Ragtimeは、Slack Bot、Discord Bot、WhatsApp Botをサポートしています。これらのいずれかまたはすべてを実行できます。

ローカルで実行する方法

両方のボットを実行します
```
python3 main.py
```
スラックボットのみを実行します
```
python3 main.py slack
```
不一致のボットのみを実行します
```
python3 main.py discord
```
WhatsAppボットのみを実行します
```
python3 main.py whatsapp
```

Dockerを使用してアプリケーションを実行します

Dockerで構築して実行します。

両方のボットを実行します
```
bash run_docker.sh
```
スラックボットのみを実行します
```
bash run_docker.sh slack
```
不一致のボットのみを実行します
```
bash run_docker.sh discord
```
WhatsAppボットのみを実行します
```
bash run_docker.sh whatsapp
```

スラックボットを作成する手順

OrerでラグタイムボットをSlackサービスに接続するには、次の手順に従ってください。

Slack Workspaceにログインし、Slack API Webサイトに移動します。「アプリ」をクリックしてから「新しいアプリの作成」。アプリに名前を提供し、インストールするワークスペースを選択し、[アプリの作成]をクリックします。
アプリの設定では、アプリ名、アイコン、説明など、さまざまな詳細を構成できます。必要な情報を正確に記入してください。
アプリを構成したら、「アプリのインストール」セクションに移動します。 [アプリをワークスペースにインストール]ボタンをクリックして、スラックワークスペースにボットを追加します。このステップは、ボットを認証するために使用する必要があるOAuthアクセストークンを生成します。
ユーザートークンスコープを追加するには、アプリ設定の「OAuth＆Permissions」セクションに移動します。「ワークスペース用のOAuthトークン」セクションでは、 app_mentions:read 、 channels:history 、 chat:write 、write chat:write.public 、 groups:history 、mpim im:history mpim:history 、 mpim:read 、 mpim:write 、 users:read scopes。トークンを作成し、 .envファイルでSLACK_BOT_TOKENとして保存します。
connection:writeスコープ。このトークンを.envファイルにSLACK_APP_TOKENとして保存します。
アプリの設定に変更した変更を保存し、ボットを職場にインストール/再インストールしてください。

不一致ボットを作成する手順

ラグタイムボットをDiscordサーバーに接続するには、次の手順に従ってください。

Discord Developer Portal Applicationsページに移動し、右上隅の[新しいアプリケーション]ボタンをクリックして新しいアプリケーションを作成します。
左列から「ボット」オプションを選択して、「ボット」ページに移動します。
提供されたトークンをコピーして、 DISCORD_BOT_TOKENとして保存します。
左列から「OAuth2」を選択し、URLジェネレーターを選択します。
下部の「ボット許可」セクションで、必要な権限を選択します。
「スコープ」ボックスで「ボット」オプションを選択すると、「ボット許可」ボックスがその下に表示されます。
「メッセージの読み取り」、「メッセージの送信」、「メッセージの管理」オプションを選択します。
生成されたURLをコピーして、Webブラウザに貼り付けます。それはあなたをあなたのサーバーにボットを追加するためにあなたをDiscordページにリダイレクトします。