Slack - Amazon Kendra

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

Slack

Slack 是一款企業通信應用程序,可讓用戶通過各種公共和私有渠道發送消息和附件。您可以用 Amazon Kendra 來為 Slack 公開和私人通道、機器人和封存訊息、檔案和附件、直接和群組訊息建立索引。您也可以選擇要過濾的特定內容。

注意

Amazon Kendra 現在支援升級的 Slack 連接器。

主機已自動為您升級。您在主控台中建立的任何新連接器都會使用升級的架構。如果您使用 API,您現在必須使用TemplateConfiguration物件而非SlackConfiguration物件來設定連接器。

使用舊版主控台和 API 架構設定的連接器將繼續如設定般運作。但是,您將無法編輯或更新它們。如果您要編輯或更新連接器組態,您必須建立新的連接器。

建議您將連接器工作流程移轉至升級版本。使用舊架構設定的連接器 Support 排程於 2024 年 6 月結束。

您可以使用Amazon Kendra 主控台TemplateConfigurationAPI 連線 Amazon Kendra 到 Slack 資料來源。

如需 Amazon Kendra Slack 資料來源連接器的疑難排解,請參閱疑難排解資料來

支援的功能

Amazon Kendra Slack 資料來源連接器支援下列功能:

  • 欄位對映

  • 使用者存取控制

  • 包含/排除過濾器

  • 完整和增量內容同步

  • 虛擬私有雲端 (VPC)

必要條件

在您可以用來 Amazon Kendra 為 Slack 資料來源建立索引之前,請先在 Slack 和 AWS 帳戶中進行這些變更。

在 Slack 中,請確定您擁有:

  • 配置了鬆弛機器人用戶 OAuth 令牌或鬆弛用戶 OAuth 令牌。您可以選擇任一權杖來連線 Amazon Kendra 至 Slack 資料來源。需要令牌才能用作您的身份驗證憑據。有關更多信息,請參閱有關訪問令牌的 Slack 文檔

    注意

    如果您將機器人令牌用作 Slack 憑據的一部分,則無法為直接消息和群組消息編制索引,並且必須將機器人令牌添加到要編制索引的渠道中。

    注意

    我們建議您定期重新整理或輪換您的認證和密碼。僅為您自己的安全提供必要的訪問級別。我們建議您跨資料來源以及連接器 1.0 和 2.0 版 (如果適用) 重複使用認證和密碼。

  • 從 Slack 工作區主頁面網址記下您的 Slack 工作區團隊 ID。舉個例子, https://app.slack.com/client/T0123456789/... 其中 T0123456789 是群組識別碼。

  • 已新增下列 Oauth 範圍/權限:

    使用者權杖範圍 機器人令牌範圍
    • 頻道:歷史

    • 頻道:讀取

    • 表情符號:讀取

    • 檔案:讀取

    • 群組:歷程

    • 群組:讀取

    • IM: 歷程

    • IM: 讀取

    • MPIM: 歷程

    • MPM: 讀取

    • team:read

    • 使用者. 設定檔:讀取

    • 使用者:讀取

    • 使用者:讀取. 電子郵件

    • 頻道:歷史

    • 通道:管理

    • 頻道:讀取

    • 交談. 連線:管理

    • 對話. 連線:讀取

    • 檔案:讀取

    • 群組:歷程

    • 群組:讀取

    • IM: 歷程

    • IM: 讀取

    • MPIM: 歷程

    • MPM: 讀取

    • 反應:讀取

    • team:read

    • 使用者群組:讀取

    • 使用者. 設定檔:讀取

    • 使用者:讀取

    • 使用者:讀取. 電子郵件

  • 已勾選的每個文件在 Slack 和您打算用於相同索引的其他資料來源中都是唯一的。您要用於索引的每個資料來源不得包含跨資料來源的相同文件。文件 ID 對索引來說是全域的,而且每個索引必須是唯一的。

在您的中 AWS 帳戶,請確保您有:

  • 建立 Amazon Kendra 索引,如果使用 API,則會記下索引 ID。

  • 為您的資料來源建立 IAM 角色,如果使用 API,則會記錄 IAM 角色的 ARN。

    注意

    如果您變更驗證類型和認證,則必須更新 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。

連接說明

若要連線 Amazon Kendra 至 Slack 資料來源,您必須提供 Slack 資料來源的必要詳細資訊, Amazon Kendra 以便存取您的資料。如果您尚未為 Slack 設定 Amazon Kendra,請參閱必要條件

Console

若要連線 Amazon Kendra 至鬆弛

  1. 登入 AWS Management Console 並開啟Amazon Kendra 主控台

  2. 在左側導覽窗格中,選擇 [索引],然後從索引清單中選擇要使用的索引。

    注意

    您可以選擇在索引設置下配置或編輯您的用戶訪問控制設置

  3. 在 [開始使用] 頁面上,選擇 [新增資料來源]。

  4. 在 [新增資料來源] 頁面上,選擇 [Slack 連接器],然後選擇 [新增連接器]。如果使用第 2 版(如果適用),請選擇帶有「V2.0」標籤的 Slack 連接器

  5. 在 [指定資料來源詳細資訊] 頁面上,輸入下列資訊:

    1. 名稱和說明中,對於資料來源名稱 — 輸入資料來源的名稱。您可以包含連字號,但不能包含空格。

    2. (選擇性) 說明 — 輸入資料來源的選用說明。

    3. 預設語言中 — 選擇一種語言來篩選索引的文件。除非另有指定,否則語言預設為英文。文件中繼資料中指定的語言會覆寫選取的語言。

    4. 在「」中,針對「新增標籤」— 包含可選標籤以搜尋和篩選資源或追蹤 AWS 成本。

    5. 選擇下一步

  6. 在 [定義存取和安全性] 頁面上,輸入下列資訊:

    1. 適用於 Slack 工作區團隊 ID — Slack 工作區的團隊 ID。您可以在 Slack 工作區主頁面 URL 中找到您的團隊 ID。舉個例子, https://app.slack.com/client/T0123456789/... 其中 T0123456789 是群組識別碼。

    2. 授權 — 開啟或關閉文件的存取控制清單 (ACL) 資訊 (如果您有 ACL),且想要將其用於存取控制。ACL 會指定使用者和群組可存取的文件。ACL 資訊可用來根據使用者或使用者對文件的群組存取來篩選搜尋結果。如需詳細資訊,請參閱使用者內容篩選

    3. AWS Secrets Manager 秘密:選擇現有密碼或建立新 Secrets Manager 密碼來儲存您的 Slack 驗證憑證。如果您選擇建立新密碼,則會開啟一個 AWS Secrets Manager 密碼視窗。

      1. 在「建立 AWS Secrets Manager 密碼視窗」中輸入下列資訊:

        1. 秘密名稱 — 您秘密的名稱。字首 'AmazonKendra-Slack-' 會自動新增至您的密碼名稱。

        2. 針對 Slack 權杖 — 輸入您設定 Slack 的驗證認證值。

      2. 保存並添加您的秘密。

    4. V@@ irtual Private Cloud (VPC) (VPC) — 您可以選擇使用 VPC。如果是這樣,您必須新增子網路VPC 安全性群組。

    5. 識別爬行者程式 — 指定是否要開啟身分爬行 Amazon Kendra者程式。識別爬行者程式會使用文件的存取控制清單 (ACL) 資訊,根據使用者或使用者對文件的群組存取權來篩選搜尋結果。如果您有文件的 ACL 並選擇使用 ACL,您也可以選擇開啟的身分識別爬行者程式,以設定搜尋結果的使用者環境定義篩選。 Amazon Kendra否則,如果關閉身分搜索器,則可以公開搜索所有文檔。如果您想要對文件使用存取控制,且身分識別編目程式已關閉,您也可以使用 PutPrincipalMappingAPI 來上傳使用者和群組存取資訊以進行使用者內容篩選。

    6. IAM role — 選擇現有 IAM 角色或建立新 IAM 角色以存取存放庫認證和索引內容。

      注意

      IAM 用於索引的角色不能用於資料來源。如果您不確定索引或常見問題集是否使用現有角色,請選擇 [建立新角色] 以避免發生錯誤。

    7. 選擇下一步

  7. 在 [設定同步設定] 頁面上,輸入下列資訊:

    1. 選取內容類型 — 選取您要編目的 Slack 實體或內容類型。您可以從所有頻道、公開頻道、私人頻道、群組訊息和私人訊息中進行選擇。

    2. 選取編目開始日期 — 輸入您要開始檢索內容的日期。

    3. 對於其他組態 — 選擇包含機器人和封存訊息,並使用規則運算式模式來包含或排除特定內容。

      注意

      如果您選擇同時包含通道 ID 和通道名稱,則 Amazon Kendra Slack 連接器會將通道 ID 優先於通道名稱。

      如果您選擇包含特定的私人和群組郵件, Amazon Kendra Slack 連接器會忽略所有私人和群組郵件,而且只會編目您指定的私人和群組郵件。

    4. 同步模式 — 選擇資料來源內容變更時要如何更新索引。當您第一次將資料來源同 Amazon Kendra 步處理時,依預設會檢索所有內容並建立索引。如果初始同步失敗,您必須執行資料的完整同步處理,即使您沒有選擇完整同步作為同步模式選項。

      • 完全同步:新鮮索引所有內容,並在每次資料來源與索引同步時取代現有內容。

      • 新增、修改、刪除的同步:每次資料來源與索引同步時,僅對新內容、已修改和刪除的內容建立索引。 Amazon Kendra 可以使用資料來源的機制來追蹤內容變更,並為上次同步後變更的內容建立索引。

    5. 同步執行排程中,對於頻率 — 選擇同步資料來源內容和更新索引的頻率。

    6. 選擇下一步

  8. [設定欄位對映] 頁面上,輸入下列資訊:

    1. 預設資料來源欄位 — 從 Amazon Kendra 產生的預設資料來源欄位中選取您要對映至索引的資料來源欄位。

    2. 新增欄位 — 新增自訂資料來源欄位,以建立要對映的索引欄位名稱和欄位資料類型。

    3. 選擇下一步

  9. 在 [檢閱並建立] 頁面上,檢查您輸入的資訊是否正確,然後選取 [新增資料來源]。您也可以從此頁面選擇編輯您的資訊。成功新增資料來源後,您的資料來源將顯示在 [資料來源] 頁面上。

API

若要連線 Amazon Kendra 至鬆弛

您必須使用 TemplateConfigurationAPI 指定資料來源結構描述的 JSON。您必須提供以下信息:

  • 資料來源 — 指定使用 TemplateConfigurationJSON 結構定義SLACK時的資料來源類型。同時指定呼叫 CreateDataSourceAPI TEMPLATE 時的資料來源。

  • 鬆弛工作區團隊 ID — 您從 Slack 主頁面 URL 複製的 Slack 團隊 ID。

  • 自日期 — 開始從 Slack 工作區團隊檢索資料的日期。日期必須遵循以下格式: yyyy-mm-dd。

  • 同步模式 — 指定資料來源內容變更時 Amazon Kendra 應如何更新索引。當您第一次將資料來源同 Amazon Kendra 步處理時,依預設會檢索所有內容並建立索引。如果初始同步失敗,您必須執行資料的完整同步處理,即使您沒有選擇完整同步作為同步模式選項。您可以選擇:

    • FORCED_FULL_CRAWL新建索引所有內容,並在每次資料來源與索引同步時取代現有內容。

    • FULL_CRAWL,以在每次資料來源與索引同步時,僅對新的、修改的和刪除的內容建立索引。 Amazon Kendra 可以使用資料來源的機制來追蹤內容變更,並為上次同步後變更的內容建立索引。

    • CHANGE_LOG每次資料來源與索引同步時,僅對新內容和修改的內容建立索引。 Amazon Kendra 可以使用資料來源的機制來追蹤內容變更,並為上次同步後變更的內容建立索引。

  • 識別爬行者程式 — 指定是否要開啟身分爬行 Amazon Kendra者程式。識別爬行者程式會使用文件的存取控制清單 (ACL) 資訊,根據使用者或使用者對文件的群組存取權來篩選搜尋結果。如果您有文件的 ACL 並選擇使用 ACL,您也可以選擇開啟的身分識別爬行者程式,以設定搜尋結果的使用者環境定義篩選。 Amazon Kendra否則,如果關閉身分搜索器,則可以公開搜索所有文檔。如果您想要對文件使用存取控制,且身分識別編目程式已關閉,您也可以使用 PutPrincipalMappingAPI 來上傳使用者和群組存取資訊以進行使用者內容篩選。

  • 秘密 Amazon 資源名稱 (ARN) — 提供包含 Slack 帳戶身份驗證登入資料的 Secrets Manager 密碼的 Amazon 資源名稱 (ARN)。密碼會以下列金鑰儲存在 JSON 結構中:

    { "slackToken": "token" }
  • IAM role — 指定RoleArn當您呼叫CreateDataSource以提供具有存取 Secrets Manager 密碼之權限的 IAM 角色,以及呼叫 Slack 連接器和所需的公用 API 的時間。 Amazon Kendra如需詳細資訊,請參閱 Slack 資料來源的IAM 角色

您還可以添加以下可選功能:

  • V@@ irtual Private Cloud (VPC) — 指定您呼叫的VpcConfiguration時間。CreateDataSource如需詳細資訊,請參閱 設定 Amazon Kendra 若要使用 Amazon VPC

  • 特定頻道:依公開或私人頻道進行篩選,並依其 ID 指定特定頻道。

  • 頻道和訊息類型 — 是否 Amazon Kendra 應為公開和私人頻道、群組和直接訊息,以及機器人和封存訊息建立索引。如果您使用機器人令牌作為 Slack 身份驗證憑據的一部分,則必須將機器人令牌添加到要索引的通道中。您無法使用機器人權杖建立直接訊息和群組訊息的索引。

  • 回顧 — 您可以選擇設定lookBack參數,讓 Slack 連接器在上次連接器同步之前的指定小時內搜索更新或刪除的內容。

  • 包含和排除篩選器:指定要包含還是排除特定 Slack 內容。如果您使用機器人令牌作為 Slack 身份驗證憑據的一部分,則必須將機器人令牌添加到要索引的通道中。您無法使用機器人權杖建立直接訊息和群組訊息的索引。

    注意

    大多數資料來源使用規則運算式模式,這些模式是稱為篩選器的包含或排除模式。如果您指定包含篩選器,則只有符合包含項目篩選器的內容會編製索引。不符合包含篩選器的任何文件都不會建立索引。如果您指定包含和排除篩選器,符合排除篩選器的文件將不會建立索引,即使它們符合包含篩選器也是如此。

  • 欄位對映 — 選擇將 Slack 資料來源欄位對映至 Amazon Kendra 索引欄位。如需詳細資訊,請參閱映射資料來源欄位

    注意

    您的文件需要文件內文欄位或文件內文對等項目,才能搜尋您的文件。 Amazon Kendra 您必須將資料來源中的文件內文欄位名稱對應至索引欄位名稱_document_body。所有其他欄位是選用的。

如需要設定的其他重要 JSON 金鑰清單,請參閱Slack範本結構定義

進一步了解

若要深入瞭解如何 Amazon Kendra 與 Slack 資料來源整合,請參閱: