Slackでオウム返しをするBotを作る

はじめに

ほんとにやりたいことはRAGでAIエージェントを作ることですが、一旦基礎として一番簡単なオウム返しBotを作ってみます。

前提

• サーバー側の使用言語は Python、ローカルで起動
• Slack が使えること

実装

Slack アプリの作成

1. (Slack API)[https://api.slack.com/apps]にアクセス
2. Create New Appを選択
   
3. From a manifestを選択
   
4. アプリを入れたい Slack のワークスペースを選択
5. Manifest ファイルを作成する(name だけいじりまいた)
   
6. Createを押して完了

Slack アプリの設定

1. Socket Mode の有効化
   • 左側メニューバーより Socket Modeを選択
   • Enable Socker Mode を on にする
   • Token Name に任意の名前を入れる
   • scope はもともとあるものにする(connections:write)
   • Generate を押して、Token を控えておく
2. Bot Token Scopes の設定
   • メニューバーから OAuth & Permissions
   • Bot Token ScopesでAdd an OAuth Scopeをクリック
   • chat:writeを選択
3. トリガーの設定
   • 左側メニューバーよりEvent Subscriptions
   • Enable Eventsを on にする
   • Subscribe to bot eventsからAdd Bot User Eventを選択
   • イベントリストから app_mention を選択(メンションされた時に動くようにする)
   • Save Changeをクリック
4. アプリのインストール
   • メニューバーから Install App
   • Install to Workspace を選択
   • 許可を選択
   • Token を控えておく

Socket Mode とは？

• WebSocket を用いた通信を行う設定
• サーバーとクライアントを常にオンライン状態を維持することで双方向通信をし、リアルタイムに情報通信を可能にする
• アプリ側でHTTPリクエストを受け取るためのAPIエンドポイントを用意する必要がないため、アプリに対するインバウンドの通信が不要

Socket の Scopeについて(一例)

• connections:write
  • Socker Modeを使う上では必須
  • アプリが WebSocket 接続を確立して、イベントやペイロードを受信できるようになる
• authorizations:read
  • このアプリが複数のワークスペースに入っている場合、それぞれの情報が取得できる

App token と Bot Token とは？

• App token
  • Slack アプリに組み込むためのトークン
  • Socket Mode の connections:write の説明をみるとイメージが湧くと思います
• Bot Token
  • Slack アプリそのものが動作する際に必要なもの

Bot Token Scopesの種類(一例)

• chat:write
  • この Bot がメッセージを送れるようになる
• usergroups:read
  • Bot がワークスペース内のユーザーを見れる
• users:read.email
  • Bot がワークスペース内のユーザーのメールアドレスを見れる

補足: アプリの装飾

アイコンなどをつけるとそれっぽくなりますね。

サーバーの設定

ローカルの適当な場所で実行してください。

1. 仮想環境の作成
   • 例: venvで作る場合
   • python -m venv .venv
2. 仮想環境に入る
   • (Macの場合)source .venv/bin/activate
3. ライブラリのインストール

• pip install slack-bolt

4. 環境変数の設定
   • export SLACK_APP_TOKEN="xapp-********"
   • export SLACK_BOT_TOKEN="xoxb-********"
5. app.py の作成

from slack_bolt import App
from slack_bolt.adapter.socket_mode import SocketModeHandler
import os


app = App(token=os.environ.get("SLACK_BOT_TOKEN"))

@app.event("app_mention")
def handle_app_mention_events(event, say):
    say(event["text"])


if __name__ == "__main__":
    SocketModeHandler(app, os.environ.get("SLACK_APP_TOKEN")).start()

6. 立ち上げ
   • python app.py

slack bolt とは

• Slack APIをプログラムから呼び出すためのSlack公式のフレームワーク
• Slack SDKよりも簡単に使える
• reference: https://tools.slack.dev/bolt-python/

動作確認

動いた！

さいごに

次はAWSを使って作ってみます！