Slack

Slack は、ユーザーがさまざまなパブリックチャネルやプライベートチャネルを通じてメッセージや添付ファイルを送信できる、エンタープライズコミュニケーションアプリです。Amazon Kendraを使用して、Slack のパブリックチャネルとプライベートチャネル、ボットとアーカイブのメッセージ、ファイルと添付ファイル、ダイレクトメッセージとグループメッセージのインデックスを作成できます。また、フィルタリングする特定のコンテンツを選択することもできます。

注記

Amazon Kendraがアップグレードされた Slack コネクタをサポートするようになりました。

コンソールは自動的にアップグレードされています。コンソールで新しくコネクタを作成すると、コネクタにはアップグレードされたアーキテクチャが使用されます。API を使用する場合は、SlackConfiguration オブジェクトではなく TemplateConfiguration オブジェクトを使用してコネクタを設定する必要があります。

古いコンソールと API アーキテクチャを使用して設定されたコネクタは、引き続き設定どおりに機能します。ただし、それらを編集したり更新したりすることはできません。コネクタ設定を編集または更新する場合は、新しいコネクタを作成する必要があります。

コネクタワークフローをアップグレードされたバージョンに移行することをお勧めします。古いアーキテクチャを使用して設定されたコネクタのサポートは、2024 年 6 月までに終了する予定です。

Amazon Kendraコンソールまたは TemplateConfiguration API を使用して Slack データソースAmazon Kendraに接続できます。

Slack データソースコネクタAmazon Kendraのトラブルシューティングについては、「」を参照してくださいデータソースのトラブルシューティング。

サポートされている機能

Amazon KendraSlack データソースコネクタは、次の機能をサポートしています。

フィールドマッピング
ユーザーアクセスコントロール
包含/除外フィルター
完全および増分コンテンツ同期
Virtual Private Cloud (VPC)

前提条件

Amazon Kendraを使用して Slack データソースのインデックスを作成する前に、Slack と AWSアカウントでこれらの変更を行います。

Slack で、次の作業を行ったことを確認してください。

Slack Bot User OAuth トークンまたは Slack User OAuth トークンを設定済みであること。いずれかのトークンを選択して Slack データソースAmazon Kendraに接続できます。トークンは、認証情報として使用するために必要です。詳しくは、アクセストークンに関する Slack のドキュメントをご覧ください。

注記
Slack 認証情報の一部としてボットトークンを使用する場合、ダイレクトメッセージやグループメッセージのインデックスを作成できないため、インデックスを作成するチャネルにボットトークンを追加する必要があります。

注記
認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨しません。
Slack ワークスペースのメインページ URL にある Slack ワークスペースチーム ID をメモすること。例えば、https://app.slack.com/client/T0123456789/... の T0123456789 がチーム ID です。

次の Oauth スコープ/アクセス権限を追加済みであること。

ユーザートークンのスコープ	ボットトークンのスコープ
channels:history channels:read emoji:read files:read groups:history groups:read im:history im:read mpim:history mpim:read team:read users.profile:read users:read users:read.email	channels:history channels:manage channels:read conversations.connect:manage conversations.connect:read files:read groups:history groups:read im:history im:read mpim:history mpim:read reactions:read team:read usergroups:read users.profile:read users:read users:read.email

各ドキュメントが Slack および同じインデックスに使用する予定の他のデータソース間で一意であると確認すること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。

でAWS アカウント、以下があることを確認します。

Amazon Kendraインデックスを作成し、 API を使用している場合はインデックス ID を記録しました。
データソースの IAMロールを作成し、 API を使用している場合はロールの ARN を記録しましたIAM。

注記
認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。
Slack の認証資格情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。

注記
認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨しません。

既存のIAMロールまたはシークレットがない場合は、Slack データソースを接続するときにコンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。

接続手順

Slack データソースAmazon Kendraに接続するには、がデータAmazon Kendraにアクセスできるように、Slack データソースの必要な詳細を指定する必要があります。Slack をまだ設定していない場合はAmazon Kendra、「」を参照してください前提条件。

Console

Slack Amazon Kendraに接続するには

にサインインAWS マネジメントコンソールし、 Amazon Kendraコンソールを開きます。
左側のナビゲーションペインで、[インデックス] を選択し、インデックスのリストから使用するインデックスを選択します。

注記
[インデックスの設定] で、[ユーザーアクセスコントロール] 設定を設定または編集できます。
[使用開始] ページで、[データソースを追加] を選択します。
[データソースを追加] ページで [Slack コネクタ] を選択し、[コネクタを追加] を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた [Slack コネクタ] を選択します。
[データソースの詳細を指定] ページで、次の情報を入力します。
1. [名前と説明] の [データソース名] に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。
2. (オプション) [説明] - オプションで、データソースの説明を入力します。
3. [デフォルト言語] - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。
4. タグで、新しいタグを追加する - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。
5. [次へ] を選択します。
[アクセスとセキュリティの定義] ページで、次の情報を入力します。
1. [Slack ワークスペースチーム ID] - Slack ワークスペースのチーム ID。チーム ID は、Slack ワークスペースのメインページの URL で確認できます。例えば、https://app.slack.com/client/T0123456789/... の T0123456789 がチーム ID です。
2. [承認] - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「User context filtering」を参照してください。
3. AWS Secrets Managersecret — 既存のシークレットを選択するか、新しいSecrets Managerシークレットを作成して Slack 認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。
  1. [AWS Secrets Manager シークレットウィンドウを作成] に次の情報を入力します。
    1. [シークレット名] - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Slack-」が自動的に追加されます。
    2. [Slack トークン] - Slack で設定した認証情報の値を入力します。
  2. シークレットを保存して追加します。
4. [仮想プライベートクラウド (VPC)] - VPC の使用を選択できます。選択する場合は、[サブネット] と [VPC セキュリティグループ] を追加する必要があります。
5. [ID クローラー] - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果のユーザーコンテキストフィルタリングを設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに PutPrincipalMapping API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。
6. IAMrole — 既存のIAMロールを選択するか、新しいIAMロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。
  
  注記
  IAMインデックスに使用されるロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、[新しいロールを作成] を選択してください。
7. [次へ] を選択します。
[同期設定の構成] ページで、次の情報を入力します。
1. [コンテンツタイプを選択] - クロールする Slack エンティティまたはコンテンツタイプを選択します。すべてのコンテンツ、パブリックチャネル、プライベートチャネル、グループメッセージ、プライベートメッセージから選択できます。
2. [クロール開始日を選択] - コンテンツのクローリングを開始する日付を入力します。
3. [追加設定] - ボットメッセージとアーカイブ済みメッセージを含める場合、および特定のコンテンツを含める、または除外するための正規表現パターンを使用する場合に選択します。
  
  注記
  チャネル IDs とチャネル名の両方にを含めることを選択した場合、Slack コネクタはチャネル名よりもチャネル IDs Amazon Kendraを優先します。
  特定のプライベートメッセージとグループメッセージを含めることを選択した場合は、Amazon Kendra Slack コネクタではすべてのプライベートメッセージとグループメッセージが無視され、指定したプライベートメッセージとグループメッセージのみがクロールされます。
4. [同期モード] - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。
  - 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。
  - 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。
5. [同期実行スケジュール] の [頻度] - データソースコンテンツを同期してインデックスを更新する頻度を選択します。
6. [次へ] を選択します。
[フィールドマッピングを設定] ページで、次の情報を入力します。
1. デフォルトのデータソースフィールド — インデックスにマッピングするAmazon Kendra生成されたデフォルトのデータソースフィールドから選択します。
2. [フィールドを追加] - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。
3. [次へ] を選択します。
[確認と作成] ページで、入力した情報が正しいことを確認し、[データソースを追加] を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが [データソース] ページに表示されます。

API

Slack Amazon Kendraに接続するには

TemplateConfiguration API を使用してデータソーススキーマの JSON を指定する必要があります。これには、以下の情報を入力する必要があります。

[データソース] — TemplateConfiguration JSON スキーマを使用する場合は、データソースタイプを SLACK と指定します。また、CreateDataSource API を呼び出す場合は、データソースを TEMPLATE と指定します。
Slack ワークスペースチーム ID - Slack のメインページ URL からコピーした Slack チーム ID。
[開始日] - Slack ワークスペースチームからのデータのクローリングを開始する日付。日付は yyyy-mm-dd の形式にする必要があります。
同期モード — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。
- FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。
- FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。
- CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
[ID クローラー] - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果のユーザーコンテキストフィルタリングを設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに PutPrincipalMapping API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。
Secret Amazon Resource Name (ARN) — Slack アカウントの認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。
```
{
    "slackToken": "token"
}
```
IAMrole — を呼び出しCreateDataSourceて、シーSecrets Managerクレットにアクセスするためのアクセス許可を IAMロールに提供し、Slack コネクタとに必要なパブリック APIs を呼び出すRoleArnタイミングを指定しますAmazon Kendra。詳細については、「Slack データソースの IAM ロール」を参照してください。

オプションで、次の機能を追加することもできます。

[仮想プライベートクラウド (VPC)] - VpcConfiguration で CreateDataSource を呼び出すタイミングを指定します。詳細については、「を使用するAmazon Kendraようにを設定するAmazon VPC」を参照してください。
[特定のチャネル] — パブリックチャネルまたはプライベートチャネルでフィルタリングし、特定のチャネルを ID で指定します。
[チャネルとメッセージのタイプ] — Amazon Kendra が、パブリックチャネルとプライベートチャネル、グループメッセージとダイレクトメッセージ、ボットメッセージとアーカイブ済みメッセージのインデックスを作成するかどうか。Slack 認証情報の一部としてボットトークンを使用する場合、インデックスを作成するチャネルにボットトークンを追加する必要があります。ボットトークンを使用してダイレクトメッセージやグループメッセージのインデックスを作成することはできません。
[ルックバック] — Slack コネクタが、最後のコネクタ同期までの指定された時間の間、更新または削除されたコンテンツをクロールするように、lookBack パラメータを設定できます。
[包含フィルターと除外フィルター] - Slack の特定のコンテンツを含める、または除外するように指定できます。Slack 認証情報の一部としてボットトークンを使用する場合、インデックスを作成するチャネルにボットトークンを追加する必要があります。ボットトークンを使用してダイレクトメッセージやグループメッセージのインデックスを作成することはできません。

注記
ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。
フィールドマッピング - 選択すると、Slack データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「データソースフィールドのマッピング」を参照してください。

注記
がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 _document_body にマッピングする必要があります。その他のすべてのフィールドはオプションです。

設定が必要なその他の重要な JSON キーのリストについては、「Slack template schema」を参照してください。

詳細はこちら

Slack データソースAmazon Kendraとの統合の詳細については、以下を参照してください。

Unravel the knowledge in Slack workspaces with intelligent search using the Amazon Kendra Slack connector

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

クエリでドキュメントを指定する

Zendesk