Python+Slack APIを使用したチャットボットの実装方法の詳細な例

Chatbot (ボット) は、Slack のような実用的な対話型チャット サービスです。これまでにチャットボットを構築したことがない場合、この記事では、Python と Slack API を使用して最初のチャットボットを構築する方法に関する簡単な入門ガイドを提供します。

開発環境をセットアップし、Slack APIチャットボットトークンを取得し、Pyhonを使用した簡単なチャットボットを開発します。

必要なツール

私たちのチャットボット（「StarterBot」と呼びます）には、Python と Slack API が必要です。 Python コードを実行するには、次のものが必要です:

• Python 2 または Python 3

• pip と virtualenv Python アプリケーションの依存関係を処理する

• API アカウントにアクセスできる無料の Slack、またはSlack 開発者ハングアウト チームにサインアップできます。

• Slack チームによって構築された公式 Python Slack クライアント コード ベース

• Slack API テスト トークン

Slack API ドキュメントは非常に便利です。

このチュートリアルのすべてのコードは、slack-starterbot パブリック ライブラリに配置されており、MIT ライセンスの下でオープンソース化されています。

環境をセットアップする

プロジェクトに必要なツールがわかったので、開発環境をセットアップしましょう。まずターミナル (または Windows のコマンド プロンプト) に移動し、このプロジェクトを保存するディレクトリに変更します。そのディレクトリに新しい virtualenv を作成して、アプリケーションの依存関係を他の Python プロジェクトから分離します。

virtualenvをアクティブ化します:

プロンプトはスクリーンショットのようになります:

アクティブ化された starterbot virtualenv のコマンド プロンプト この公式の Slack クライアント API ヘルプ ライブラリは Built on Slack によって提供されており、送信できますSlack チャネルを通じてメッセージを受信します。この pip コマンドを使用して、slackclient ライブラリをインストールします:

pip コマンドが完了すると、次のような出力が表示され、プロンプトに戻るはずです。

すでにアクティブ化されている virtualenv に pip を使用してlackclientをインストールする出力 また、チャットボットがそれを使用して Slack API に接続できるように、Slack プロジェクトのアクセス トークンを取得する必要があります。

Slack リアルタイム メッセージング (RTM) API

Slack を使用すると、プログラムは Web API を通じてメッセージング チャネルにアクセスできます。この Slack Web API ページにアクセスして、独自の Slack プロジェクトを登録して構築します。管理者権限を持つ既存のアカウントにログインすることもできます。

Web API ページの右上隅にあるログイン ボタンを使用してログインすると、チャットボット ユーザー ページが表示されます。

カスタムチャットボットユーザーページ チャットボットに「starterbot」という名前を付け、「ボット統合を追加」ボタンをクリックします。

ボット統合を追加し、「starterbot」という名前を付けます。ページがリロードされ、新しく生成されたアクセス トークンが表示されます。ロゴを独自のデザインに変更することもできます。たとえば、私はこの「フルスタックPython」フラグを付けました。

新しい Slack チャットボットのアクセス トークンをコピーして貼り付け、ページの下部にある [統合を保存] ボタンをクリックします。これで、チャットボットが Slack API に接続する準備が整いました。

Python 開発者の間で一般的な方法は、シークレット トークンを環境変数としてエクスポートすることです。出力される Slack トークンの名前は SLACK_BOT_TOKEN です。

これで、この Slack API をチャットボットとして使用する権限が得られました。

チャットボットを構築するには、もう 1 つ情報が必要です。それは、チャットボットの ID です。次に、Slack API から ID を取得する短いスクリプトを作成します。

チャットボットの ID を取得する

いよいよ Python コードを作成します。StarterBot の ID を取得するための短い Python スクリプトを作成して、少しウォーミングアップしてみましょう。この ID は Slack プロジェクトによって異なります。

Slack RTM から StarterBot に送信されたメッセージを解析するときに、アプリケーションを認証するためにこの ID が必要です。このスクリプトは、SLACK_BOT_TOKEN 環境変数が正しく設定されているかどうかもテストします。

printbotid.py という名前の新しいファイルを作成し、次のコードを入力します:

私たちのコードは SlackClient をインポートし、設定した環境変数 SLACK_BOT_TOKEN を使用してインスタンス化します。 Python コマンドを介してスクリプトが実行されると、Slack API にアクセスしてすべての Slack ユーザーをリストし、「satrterbot」という名前に一致する ID を取得します。

チャットボットの ID を取得するには、このスクリプトを 1 回実行するだけです。

スクリプトが実行され、チャットボットの ID が提供されると、単純な 1 行の出力が出力されます。

Python スクリプトを使用して、Slack プロジェクト内の Slack チャットボットの ID を出力します。このスクリプトによって出力された一意の ID をコピーします。そしてそのIDを環境変数BOT_IDとして出力します。

このスクリプトは、チャットボットの ID を取得するために 1 回実行するだけで済みます。 これで、StarterBot を実行する Python アプリケーションでこの ID を使用できるようになりました。

StarterBot のコーディング

これで、StarterBot のコーディングに必要なものがすべて揃いました。 starterbot.py という名前の新しいファイルを作成し、次のコードを含めます。

OS と SlackClient のインポートは、既に printbotid.py で使用しているため、馴染みのあるものです。

インポートした依存関係パッケージを使用して、環境変数値を取得し、Slack クライアントをインスタンス化できます。

このコードは、エクスポートした環境変数 SLACK_BOT_TOKEN を通じて SlackClient` クライアントをインスタンス化します。

Slack クライアントは Slack RTM API WebSocket に接続し、firehose からのメッセージを解析しながら継続的にループします。 StarterBot にメッセージが送信された場合、handle_command という関数が何をすべきかを決定します。

次に、Slack の出力を解析してコマンドを処理する 2 つの関数を追加します。

parse_slack_output 関数は、Slack からのメッセージを受け取り、メッセージが StarterBot に送信されたかどうかを判断します。メッセージはチャットボット ID への直接コマンドで始まり、その後コードに渡されて処理されます。現時点では、Slack パイプラインを介してユーザーにさらに Python コードを記述するようにメッセージを投稿するだけです

プログラム全体をまとめると次のようになります (GitHub でファイルを表示することもできます):

コードが完成したので、python starterbot.py を通じて StarterBot コードを実行できます。

StarterBot が実行を開始し、API の出力チャネルに接続されたら、Slack で新しいチャネルを作成して StarterBot を招待するか、StarterBot を既存のチャネルに招待します。

Slack インターフェースで新しいチャンネルを作成し、StarterBot をチャンネル内で StarterBot に招待します。

Slack チャネルで StarterBot にコマンドを送信する チャットボットから得られる応答で問題が発生した場合は、変更が必要になる場合があります。このチュートリアルで上に書いたように、AT_BOT = “:” という行では、“@starter” (独自のチャットボットに付けた名前) の後にコロンが必要です。 AT_BOT 文字列の末尾から: を削除します。 Slack では @ 人の名前の後にコロンが必要なようですが、これは少し違和感があります。

終わり

これで、シンプルなチャットボットが完成しました。作成したい機能をコード内のさまざまな場所に追加できます。

Slack RTM API と Python を使用すると、さまざまなことができます。これらの記事で他に学べることを確認してください:

• 永続的なリレーショナル データベースまたは PostgreSQL、MySQL、SQLite などの NoSQL バックエンドを接続してユーザー データを保存および取得する

• チャットボットとの別の対話チャネルを追加する、テキスト メッセージや電話など

• GitHub、Twilio、api.ai などの他の Web API との統合

以上がPython+Slack APIを使用したチャットボットの実装方法の詳細な例の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。