Openflow Connector for Slack の設定¶

前提条件¶

1. Openflow Connector for Slack について を確認してください。

2. :doc:`/user-guide/data-integration/openflow/setup-openflow-byoc`または:doc:`Openflow のセットアップ - Snowflake デプロイメント</user-guide/data-integration/openflow/setup-openflow-spcs>`があることを確認してください。

3. Openflow - Snowflake Deployments を使用する場合、:doc:`必要なドメインの構成</user-guide/data-integration/openflow/setup-openflow-spcs-sf-allow-list>`を精査し、:ref:`label-openflow_domains_used_by_openflow_connectors_slack`コネクタに必要なドメインへのアクセス許可を付与していることを確認してください。

Slack Appを設定する¶

SlackワークスペースにSlackアプリを設定します。Slack Workspaceに対するアクセス権を設定するには、Slack Admin権限が必要です。これは、Slack Appの認証情報を作成または提供し、Slackワークスペースとチャンネルにアプリをインストールすることによって行われます。JSON 構成を使用して、Slack Appを作成することができます。

1. JSON マニフェストを更新します。下記の JSON マニフェストテキストをコピーします。名前と表示名のプロパティを、 EXAMPLE_NAME_CHANGE_THIS からSlack Appの任意の名前に変更します。Appには同じ名前と表示名を使用することを推奨します。

   CopyExpand

   {
       "display_information": {
           "name": "EXAMPLE_NAME_CHANGE_THIS"
       },
       "features": {
           "bot_user": {
               "display_name": "EXAMPLE_NAME_CHANGE_THIS",
               "always_online": false
           }
       },
       "oauth_config": {
           "scopes": {
               "bot": [
                   "channels:history",
                   "channels:read",
                   "groups:history",
                   "groups:read",
                   "im:history",
                   "im:read",
                   "mpim:history",
                   "mpim:read",
                   "users.profile:read",
                   "users:read",
                   "users:read.email",
                   "files:read",
                   "app_mentions:read",
                   "reactions:read"
               ]
           }
       },
       "settings": {
           "event_subscriptions": {
               "bot_events": [
                   "message.channels",
                   "message.groups",
                   "message.im",
                   "message.mpim",
                   "reaction_added",
                   "reaction_removed",
                   "file_created",
                   "file_deleted",
                   "file_change"
               ]
           },
           "interactivity": {
               "is_enabled": true
           },
           "org_deploy_enabled": false,
           "socket_mode_enabled": true,
           "token_rotation_enabled": false
       }
   }
   

   Show lessSee more

   Scroll to top

2. Appsページ 経由でSlack Appアプリを作成します。

   1. Your Apps ページで、 Create New App を選択します。

   2. From a manifest を選択します。

   3. アプリを開発する Workspace を選択します。後で他のワークスペースに [アプリを配布](https://api.slack.com/distribution) することもできます。

   4. ステップ1で更新したマニフェスト JSON をコピーします。

3. アプリレベルトークンを生成します。JSON マニフェストを使用した後でも、アプリレベルトークンを作成する必要があります。Basic Information で、 App-level tokens セクションまでスクロールし、 [アプリレベルトークン](https://api.slack.com/concepts/token-types#app) を生成するボタンをクリックします。トークンに connections:write スコープを含めます。

4. アプリをインストールして認証します。

   1. アプリ管理ページの Basic Information セクションに戻ります。

   2. Install to Workspace ボタンを選択して、アプリをインストールします。

   3. Slack OAuth フローが表示されます。以下の画面で Allow を選択します。

   自分のワークスペース以外の別のワークスペースにアプリを追加したい場合は、そのワークスペースのユーザーがこれらの手順を実行する必要があります。インストール後、 OAuth & Permissions ページに戻ります。OAuth トークン の下に アクセストークン が表示されます。アクセストークンは、インストールユーザーからアプリに委任された権限を表します。安全に保管してください。公開バージョン管理へのチェックインは避けてください。代わりに、環境変数を通してアクセスします。

5. チャンネルへのAppの追加アプリはまだどのチャンネルにも属していないので、テストメッセージを追加するチャンネルを選び、アプリの /invite を行います。例えば、 /invite @Grocery Reminders です。

必要なエグレスルールを設定する¶

Snowflake管理者は、 エグレスガイド に従って、エンドポイント https://slack.com/api にエグレスルールを適用し、 wss://wss.slack.com で WebSocket エグレスを有効にする必要があります。「slack.com」ドメインでエグレスを有効にするルールを追加するのが最も簡単です。

Snowflakeアカウントを設定する¶

Snowflakeアカウント管理者として、以下のタスクを実行します。

1. 新しいロールを作成するか、既存のロールを使用して データベース権限 を付与します。

2. タイプを SERVICE として、新しいSnowflakeサービスユーザーを作成します。

3. Snowflakeサービスユーザーに、前の手順で作成したロールを付与します。

4. ステップ2のSnowflake SERVICE ユーザーを key-pair auth で構成します。

5. Snowflakeではこの手順を強く推奨します。Openflowがサポートするシークレットマネージャ（AWS、Azure、Hashicorpなど）を構成し、公開キーと秘密キーを秘密ストアに格納します。

   注釈

   何らかの理由でシークレットマネージャを使用したくない場合は、組織のセキュリティポリシーに従って、キーペア認証に使用する公開キーと秘密キーファイルを保護する責任があります。

   1. シークレットマネージャを構成したら、その認証方法を決定します。AWS 上では、Openflowに関連付けられた EC2 インスタンスロールが推奨されます。こうすることで、他の秘密を永続化する必要がなくなるからです。

   2. Openflowで、右上のハンバーガーメニューから、このシークレットマネージャーに関連付けられたパラメータープロバイダーを構成します。Controller Settings » Parameter Provider に移動してから、パラメーター値を取得します。

   3. この時点で、すべての認証情報を関連するパラメーターパスで参照することができるため、機密性の高い値をOpenflow内で永続化する必要はありません。

6. 他のSnowflakeユーザーが、コネクタによって取り込まれた生の取り込みドキュメントやとテーブルへのアクセスを必要とする場合は（Snowflakeでのカスタム処理のためなど）、それらのユーザーにステップ1で作成したロールを付与します。

7. コネクタが使用するウェアハウスを指定します。まずは最小のウェアハウスサイズから始め、複製するテーブルの数や転送するデータ量に応じて異なるサイズを試してみてください。テーブル数が大きい場合は、通常、ウェアハウスのサイズを大きくするよりも、 マルチクラスターウェアハウス を使用した方がスケーリングが向上します。

ユースケース1:Slackコンテンツ取り込みのみ¶

コネクタ定義を使用して、次を行います。

• 取り込まれたSlackデータに対してカスタム分析を実行します（Cortex Search処理なし）。

• Slackのメッセージ、リアクション、添付ファイル、メンバーリストをSnowflakeに取り込み、最新の状態に保ちます。

ユースケース2:Slackコンテンツを取り込み、Cortexを有効化する¶

コネクタ定義を使用して、次を行います。

• Snowflake CortexでSlackデータを会話型検索に対応できるようにします。

• 検索結果でSlackチャンネルのアクセス制御が尊重されるようにします。

プライベートチャンネル ACLs の有効化¶

各プライベートチャンネルに Slack Appを招待 するだけで、特別な手順は必要ありません。コネクタは、 Slackメンバーの更新 間隔で自動的にメンバーリストを更新し、メンバーシップテーブルに格納します。

Cortex Search serviceをクエリする¶

ユースケース2が実行され、Cortex Searchサービスが作成されると、以下のようにクエリを実行することができます。

SELECT PARSE_JSON(
  SNOWFLAKE.CORTEX.SEARCH_PREVIEW(
    '<openflow_db>.<openflow_schema>.<<SLACK_CORTEX_SEARCH>',
    '{
      "query": "What is my vacation carry over policy?",
      "columns": ["text","channel","ts","username"],
      "filter": {"@contains": {"memberemails": "alice@example.com"}},
      "limit": 10
    }'
  )
)['results'] AS results;

一般的な検索可能列

text、 type、 subtype、 channel、 user、 username、 connectorId、 workspaceId、 ts、 threadTs

例: AI アシスタントに人事（HR）情報をクエリする

Cortex Searchを使用して、Slackの最新投稿についてチャットする従業員向けの AI アシスタントをクエリできます。検索されるメッセージは、generalやit-helpなどの有益なSlackチャンネルから派生します。

SELECT PARSE_JSON(
     SNOWFLAKE.CORTEX.SEARCH_PREVIEW(
          '<cortex_db>.<cortex_schema>.<cortex_search_service_name>',
          '{
             "query": "What is my vacation carry over policy?",
             "columns": ["text", "channel", “ts”,”username”],
             "filter": {"@contains": {"memberemails": "<user_emailID>"} },
             "limit": 1
          }'
     )
 )['results'] AS results

import snowflake.snowpark as snowpark
from snowflake.snowpark import Session
from snowflake.core import Root

def main(session: snowpark.Session):

   root = Root(session)

   # fetch service
   my_service = (root
     .databases["<cortex_db>"]
     .schemas["<cortex_schema>"]
     .cortex_search_services["<cortex_search_service_name>"]
   )

   # query service
   resp = my_service.search(
     query="What is my vacation carry over policy?",
     columns = ["text", "channel", "ts","username"],
     filter = {"@contains": {"memberemails": "<user_emailID>"} },
     limit=1
     )
   return (resp.to_json())

curl --location "https://<account_url>/api/v2/databases/<cortex_db>/schemas/<cortex_schema>/cortex-search-services/<cortex_search_service_name>" \
     --header 'Content-Type: application/json' \
     --header 'Accept: application/json' \
     --header "Authorization: Bearer <CORTEX_SEARCH_JWT>" \
     --data '{
         "query": "What is my vacation carry over policy?",
         "columns": ["text", "channel"],
         "limit": 1
     }'

{
  "results" : [ {
  "channel" : "dev notes",
  "text" : "Answer to the question asked."
  } ]
}