Go to Qiita Advent Calendar 2024 Top
LoginSignup
5
2

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

@hidechainUiPath

【UiPath】Context-Grounding対応のSlackボットを作成する

Last updated at Posted at 2024-09-24

はじめに

  • 本記事では、UiPath製品を利用してContext-Grounding (RAG) に対応したSlackボットを作成します。これによって普段お使いのSlackのユーザーインターフェイスを使用して、関連文書を参照して回答するチャットボットをUiPath Automation Cloud環境に構築することができます。
  • チャットボットの実装で一般的に利用されるサーバーレスコンピューティング(AWS LambdaやAzure Functionsなど)やNode.js・Pythonなどによるコーディングは不要です。

【完成形】
Slack_ContextGrounding.png

全体像

  • 今回作成するSlackボットの全体像はこちらです。

AITL_SlackBot_Architecture.PNG

必要なもの

  • UiPath Automation Cloud

    • 現時点ではCommunity版でもOKです。

    ただし今後UiPath GenAIアクティビティのContext-Grounding機能がプレビューから一般利用可能(GA)になるタイミングで AIユニット ライセンスが必要となる可能性があります。
    またサーバーレスロボットの利用には ロボットユニット ライセンスが必要となります。Community版でも検証用途で少量のライセンスが付与されていますが、本番利用にあたってはライセンスのご購入をご検討ください。

  • Slackアカウント
    • Slackアプリ作成の権限が必要となります。

実装手順

大まかには次の手順にて実装します。

  1. Slackの設定
  2. Integration Service(Slackコネクタ)の設定
  3. Integration Service(HTTP Webhookコネクタ)の設定
  4. Orchestratorの設定
  5. ワークフローの実装① ～ Slack連携
  6. ワークフローの実装② ～ Slack返信
  7. ワークフローの実装③ ～ Context-Grounding

それぞれ詳細な手順を説明します。

1. Slackの設定

まずSlackボット専用のSlackチャンネルとSlackアプリを作成します。

  • 最初は試行錯誤して意図せずメッセージ投稿される可能性がありますので、通常業務の妨げにならないように既存チャンネルは使用せず新規作成することをお勧めします。

  • 本記事では uipath-slackbot というチャンネル名にします。
    01.png

  • チャンネルを右クリックして詳細を表示し、一番下の Channel ID をメモします。
    02.png

  • 次にSlackアプリを作成します。Slack API にアクセスし [Create New App] をクリックし、 From scratch を選択します。
    03.png

  • App Nameを指定します。本記事では uipath-slackbot-app というアプリ名にします。[Create App] をクリックして、Slackアプリ作成を完了します。
    04.png

2. Integration Service(Slackコネクタ)の設定

Integration ServiceにてSlackコネクタを設定します。この設定はSlackチャンネルにメッセージを投稿・返信するために使用されます。

  • Automation Cloud にサインインし、Integration Serviceの管理画面に遷移します。
    04.png

  • Integration ServiceにてOrchestratorフォルダーを選択します。(最終的にプロセスをデプロイするフォルダーを選択しますが、本記事ではSharedフォルダーを使用します)

  • コネクションにて コネクションを追加 をクリックします。
    05.png

  • Slack を選択し、接続 をクリックします。
    06.png

    07.png

  • UiPath EU という名前のSlackアプリにワークスペースへのアクセス許可を与えます。
    08.png

  • コネクションが作成されたことを確認します。(任意でコネクション名を変更することもできます)
    09.png

3. Integration Service(HTTP Webhookコネクタ)の設定

次にIntegration ServiceにてHTTP Webhookコネクタを設定します。この設定はSlackの特定チャンネルにメッセージが投稿されたのをトリガーにワークフローを実行するために使用されます。

  • Integration ServiceにてSharedフォルダーを選択し、コネクションにて コネクションを追加 をクリックします。HTTP Webhook を選択します。
    10.png

  • What application is this webhook for? には Slack と入力して接続をクリックします。
    11.png

  • コネクションが作成されたことを確認します。
    12.png

  • Slackにて Add apps をクリックします。
    39.png

  • UiPath EU を選択してアプリケーションを追加します。追加された UiPath を右クリックし、View app details をクリックします。
    41.png

  • Member ID をコピーしてメモします。
    42.png

4. Orchestratorの設定

ワークフローの実行環境を整えるためにOrchestratorの設定を行います。

  • まずサーバーレスロボットを実行するためのロボットアカウントを作成し、テナントロールを割り当てます。

    • Automation Cloudの管理メニューより アカウントとグループ にアクセスします。
      68.png
    • [ロボットアカウント]タブにて ロボットアカウントを追加 をクリックし、ロボットアカウントを作成します。
      69.png

  • Orchestrator管理画面に移動し、ロボットアカウントにロールを割り当てます。

    • テナント > アクセス権を管理 > ロールを割り当て > ロボットアカウント を順にクリックします。
      70.png
    • 先ほど作成したロボットアカウントを選択し、Robotロール を割り当て、次へ をクリックします。
      71.png
    • 無人オートメーションの設定で 仮想マシンの事前設定済みの資格情報 が選択されていることを確認し、スキップして割り当て をクリックします。
      72.png

  • 次にマシン作成とフォルダーへの割り当てを行います。

    • テナント > マシン > マシンを追加 > Cloud ロボット - サーバーレス をクリックし、マシンを作成します。
      62.png

    • このマシンをSharedフォルダーに割り当てます。
      63.png

    • このフォルダーに Robotロール でロボットアカウントを割り当てます。
      61.png

5. ワークフローの実装① ～ Slack連携

Slackボットの処理を行うワークフローを実装します。まずはSlackへのメッセージ投稿をトリガーとしてワークフローが実行されるように連携の設定を行います。

  • Automation CloudにてHTTP Webhookの設定を行います。

    • Studio Webの管理画面に遷移し、[オートメーション] タブにて 新しいプロジェクト をクリックします。
      13.png

    • トリガーとして HTTP Webhook を選択します。
      14.png

    • ここで表示されるURLをコピーしてメモします。
      15.png

    • データフィルターをクリックし、最初のフィールドで [式エディター]を開く をクリックします。
      26.png

    • "body.event.channel" と入力して 保存 をクリックします。
      27.png

    • ドロップダウンにて 次の値と等しい を選択し、{Channel ID} を指定します。{Channel ID} はSlackチャンネル作成時にメモしたIDです。このフィルターによって指定チャンネルへの投稿時にのみ、このワークフローが実行されるように制御します。

    • フィルタービルダーにて 追加 > 条件 をクリックします。
      43.png

      • 左辺: 式エディターを使用して "body.event.user"
      • ドロップダウン: 次の値と等しくない (上のフィルターとは異なることに注意！)
      • 右辺: {UiPathアプリ Member ID} (先ほどメモした"UiPath"アプリのMember ID)

    • 保存 をクリックします。
      44.png

    ここで作成した2つ目のフィルターの意味は、返信がループすることを防ぐためです。このワークフローはユーザーの投稿をトリガーとして実行されますが、以降の処理にて返信処理を実装すると、この返信処理をトリガーとしてこのワークフローが再帰的に実行され、無限ループに陥ってしまいます。これを防ぐために"UiPath"アプリの返信では以降の処理が実行されないようにフィルターします。

  • 上記で設定したHTTP Webhookトリガーと連携するようSlackアプリの設定を行います。

    • Slack API にて uipath-slackbot-app の設定画面に遷移し、Event Subscriptions メニューをクリックします。
      16.png

    • Enable Eventsのトグルをオンにし、Request URLに先ほどコピーしたURLをペーストします。しばらくして Verified と表示されることを確認します。
      17.png

    • Subscribe to events on behalf of users を展開し、Add Workspace Event をクリックし、message.channels を選択します。
      18.png

    • [Save Changes] をクリックします。
      19.png

    • Install App メニューをクリックし、Slackアプリをワークスペースにインストールし、[Allow] をクリックしてアクセスを許可します。
      20.png

      21.png

6. ワークフローの実装② ～ Slack返信

  • Slackのメッセージ投稿に返信するようにワークフローを実装します。

    • Studio Webのワークフローにて、Create Webhook Triggerの続きで (+) をクリックし、JSONを逆シリアル化(Deserialize JSON) アクティビティを選択します。
      29.png

    • JSON文字列として {Create Webhook Trigger > Webhook Event Payload > Content} を指定します。
      30.png

    • (+) をクリックし、Slackの 返信を送信(Send Reply) アクティビティを選択します。
      31.png

    • 返信を送信 アクティビティは次のように設定します。

      • チャンネル名/ID: jsonオブジェクト("event")("channel").ToString (式エディターを使用)
      • メッセージのタイムスタンプ: jsonオブジェクト("event")("ts").ToString (式エディターを使用)
      • メッセージ: OK
      • 送信元: Bot

    jsonオブジェクトが変数として認識されない場合には、式エディターにて 変数を挿入 をクリックし、{JSONを逆シリアル化 > JSONオブジェクト} を選択します。

    79.png

  • ワークフローの続きを実装します。

    • (+) をクリックし、待機 アクティビティを選択し、1分間待機するように設定します。これはワークフロー実行が無限ループに陥った時に強制終了する時間を設けるための一時的な実装です。
      37.png

      38.png

    • 上部の鉛筆アイコンをクリックしてプロジェクト名を uipath-slackbot のように変更し、パブリッシュ ボタンをクリックします。
      33.png

    • パブリッシュ先として Orchestrator テナント プロセス フィード を選択し、 [パブリッシュ] をクリックします。
      73.png

  • Orchestratorの管理画面でプロセスのデプロイを行います。

    • Sharedフォルダー > オートメーション > プロセス > プロセスの追加 をクリックします。パッケージソース名として uipath-slackbot を選択し、パッケージ要件でエラーが発生しないことを確認してプロセスを作成します。
      74.png

    • トリガーとしてイベントトリガーが追加されていることを確認します。
      75.png

  • Slackのユーザーインターフェースにて動作確認を行います。

    • uipath-slackbot チャンネルにて「テスト」と投稿します。
      36.png

    • Automation CloudにてOrchestrator管理画面に遷移し、Sharedフォルダーのジョブ画面を表示します。サーバーレスロボットにてジョブが実行されていることを確認します。
      76.png

    • 実行が完了すると、投稿メッセージに「OK」と返信されることを確認します。
      46.png

    もしOKが連続して投稿されてしまう場合にはワークフローが繰り返し実行され無限ループに陥っている可能性があります。ひとまずOrchestratorジョブ画面にて保留中・実行中のジョブを強制終了し、プロセスを一旦削除します。その上でワークフロー内のHTTP Webhookトリガーのデータフィルター設定を再度確認し修正した上でパブリッシュしなおします。

    77.png

    78.png

7. ワークフローの実装③ ～ Context-Grounding

最後にワークフローを改修して、Slackへのメッセージ投稿の質問に対してインデックスを参照して回答するように実装します。Context-Groundingは個人用ワークスペースでは動作しないため、ここまでの手順通りSharedフォルダーにパッケージをパブリッシュしてサーバーレスロボットで実行します。

  • 関連文書のインデックスは事前に作成します。詳細な手順は 【UiPath】AI Trust LayerによるContext-Grounding機能のメリットと利用手順 をご参照ください。

  • Studio Webにてワークフローを修正します。

    • 既存ワークフローを開き、JSONを逆シリアル化アクティビティと返信を送信アクティビティの間に、UiPath GenAIアクティビティの コンテンツ生成(Content Generation) を追加します。
      49.png

    • コンテンツ生成アクティビティでは次のように設定します。

      • モデル名: gpt-4o-2024-05-13
      • プロンプト: jsonオブジェクト("event")("text").ToString (式エディターを使用)
      • コンテキストグラウンディング: Existing index
      • インデックス: {作成済みインデックス名}

    • 返信を送信アクティビティを修正し、次のように設定します。

      • メッセージ: {コンテンツ生成 > Text} 変数
        51.png

    • 待機アクティビティを無効化します。
      52.png

    • パブリッシュ ボタンをクリックし、 Orchestrator テナント プロセス フィード にパブリッシュします。
      53.png

      57.png

  • Sharedフォルダーにて uipath-slackbot プロセスを最新バージョンにアップグレードします。
    80.png

  • Slackチャンネルにて関連文書にかかわる質問を投稿します。

    • しばらくするとインデックスを参照した回答が返ってくることを確認します。
      58.png

    • 応答がない場合にはOrchestratorのジョブ画面にてジョブの実行結果を確認します。
      64.png

    • ジョブがそもそも実行されていない場合にはHTTP Webhookやプロセス・マシン・ロボットアカウントの設定を見直し、ジョブがエラーになっている場合にはワークフローの内容を見直します。

更なるワークフローの改善

ここまで実装したワークフローでも一応動作しますが、いくつか改善すべき点がありますのでそれらについて説明します。

新規投稿イベントのみに応答

  • HTTP Webhookイベントは新規投稿だけでなくメッセージの編集や削除にも実行されます。現時点でのワークフローではコンテンツ生成を呼び出す際のプロンプトで指定される jsonオブジェクト("event")("text") の値がメッセージの編集・削除ではNullになるため Object reference not set to an instance of an object. というエラーでジョブ実行が失敗します。
  • これを回避するためにコンテンツ生成の前に 条件分岐(If) アクティビティを配置し、条件 を式エディターにて jsonオブジェクト("event")("text") IsNot Nothing と指定し、このオブジェクトが存在した場合に「コンテンツ生成」や「返信を送信」などの後続処理を実行するように修正します。
    65.png

出力形式の変更

  • 現時点での回答文は大規模言語モデル gpt-4o が生成した文章をそのまま出力しています。そのためSlackの出力形式に合わない部分があります。たとえばSlackで太字にするためにはアスタリスクで文字を囲みます(例: *太字*)が、現在の出力ではアスタリスク2つで囲まれている(例: **太字**)ため太字にはなりません。この見栄えを良くするためには回答文を地道に文字列置換するより他にありません。

  • 次の手順で、正規表現を使用してアスタリスク2つで囲まれた文字列をアスタリスク1つで囲まる文字列に変換します。

    • データーマネージャーにて output というテキスト型の変数を追加
    • 変数の値を設定 アクティビティを配置して次の通り設定
      • 出力: output
      • 設定する値: System.Text.RegularExpressions.Regex.Replace(コンテンツ生成.text, "\*\*(.*?)\*\*", " *$1*")
    • 返信を送信アクティビティの メッセージ を ouput に変更
      66.png

  • パッケージをパブリッシュして、プロセスを最新版にアップグレードします。

  • この修正によって見栄えが幾分良くなります。
    67.png

おわりに

今回はSlackへの投稿をトリガーとしてContext-Groundingを実行するSlackボットの実装について解説しました。このようにUiPath製品を組み合わせてフロントエンドの実装も可能になります。皆さまも是非お試しください！

5
2
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
5
2

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?