Zendesk - Amazon Kendra

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

Zendesk

Zendesk 是一個客戶關係管理系統,可幫助企業自動化並增強客戶支持互動。您可以用 Amazon Kendra 來為 Zendesk 支援票證、票證註解、票證附件、說明中心文章、文章註解、文章評論附件、指南社群主題、社群貼文和社群貼文註解建立索引。

如果您要索引僅在特定組織內的工單,您可以依組織名稱進行篩選。您也可以選擇設定編目日期,以便開始從 Zendesk 探索資料的時間。

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

若要疑難排解 Amazon Kendra Zendesk 資料來源連接器,請參閱疑難排解資料來

支援的功能

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

  • 欄位對映

  • 使用者存取控制

  • 包含/排除過濾器

  • 更改日誌,完整和增量內容同步

  • 虛擬私有雲端 (VPC)

必要條件

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

在 ZENDESK 中,請確保您擁有:

  • 創建了一個 Zendesk 套件(專業/企業)管理帳戶。

  • 記下您的 Zendesk 主機網址。例如:https://{sub-domain}.zendesk.com/

    注意

    (預備內部/伺服器) Amazon Kendra 會檢查中包含的端點資訊 AWS Secrets Manager 是否與資料來源組態詳細資料中指定的端點資訊相同。這有助於防止混淆的副問題,這是一個安全性問題,即使用者沒有執行動作的權限,但用 Amazon Kendra 作 Proxy 來存取設定的密碼並執行動作。如果您稍後變更端點資訊,則必須建立新密碼才能同步此資訊。

  • 設定包含用戶端 ID、用戶端密碼、使用者名稱和密碼的 OAuth 2.0 權杖。OAuth 2.0 令牌需要用作您的身份驗證憑據。有關更多信息,請參閱有關配置 OAuth 2.0 令牌的 Zendesk 文檔

    注意

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

  • 已新增下列 OAuth 2.0 範圍:

    • 讀取

  • 選用性:安裝允許連線 Amazon Kendra 的 SSL 憑證。

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

在你的 AWS 帳戶,確保你有:

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

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

    注意

    如果您變更驗證類型和認證,則必須更新 IAM 角色才能存取正確的 AWS Secrets Manager 密碼 ID。

  • 將您的 Zendesk 驗證憑證儲存在 AWS Secrets Manager 密碼中,如果使用 API,則會記下密碼的 ARN。

    注意

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

如果您沒有現有的 IAM 角色或密碼,則可以在將 Zendesk 資料來源連線至時使用主控台建立新 IAM 角色和 Secrets Manager 密碼。 Amazon Kendra如果您使用 API,則必須提供現有 IAM 角色和 Secrets Manager 密碼的 ARN,以及索引 ID。

連接說明

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

Console

若要連接 Amazon Kendra 至天台

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

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

    注意

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

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

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

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

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

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

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

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

    5. 選擇下一步

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

    1. Zendesk 網址 — 輸入您的 Zendesk 網址。例如:https://{sub-domain}.zendesk.com/

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

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

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

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

        2. 針對用戶端 ID、用戶端密碼、使用者名稱密碼 — 輸入在 Zendesk 中設定的驗證認證值。

      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. 選取內容 — 選取您要從工單編目的內容類型、說明中心文章、社群主題等。

    2. 組織名稱 — 輸入 Zendesk 組織名稱以篩選內容。

    3. 同步開始日期:輸入您要開始檢索內容的日期。

    4. 正則表達式模式-添加正則表達式模式以包含或排除某些文件。您最多可以添加 100 個圖案。

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

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

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

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

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

    7. 選擇下一步

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

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

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

    3. 選擇下一步

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

API

若要連接 Amazon Kendra 至天台

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

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

  • 主機 URL — 提供您的 Zendesk 主機 URL 作為連線組態或存放庫端點詳細資訊的一部分。例如:https://yoursubdomain.zendesk.com

  • 變更記錄 — 是否 Amazon Kendra 應使用 Zendesk 資料來源變更記錄機制來決定是否必須在索引中更新文件。

    注意

    如果您不想 Amazon Kendra 掃描所有文檔,請使用更改日誌。如果您的變更記錄很大,掃描 Zendesk 資料來源中的文件所花費的時間可能會比處理變更記錄更 Amazon Kendra 少。如果您是第一次將 Zendesk 資料來源與索引同步,則會掃描所有文件。

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

    { "hostUrl": "https://yoursubdomain.zendesk.com", "clientId": "client ID", "clientSecret": "Zendesk client secret", "userName": "Zendesk user name", "password": "Zendesk password" }
  • IAM 角色 — 指定RoleArn何時呼叫CreateDataSource以提供具有存取 Secrets Manager 密碼之權限的 IAM 角色,以及呼叫 Zendesk 連接器和所需公用 API 的時間。 Amazon Kendra如需詳細資訊,請參閱 Zendesk 資料來源的IAM 角色

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

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

  • 文件/內容類型 — 指定是否要編目:

    • Support 票,票評論和/或票評論附件

    • 說明中心文章、文章附件和文章註解

    • 引導社群主題、貼文或張貼評論

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

    注意

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

  • 使用者前後關聯篩選與存取控制 —Amazon Kendra 探索文件的存取控制清單 (ACL) (如果您有文件的 ACL)。ACL 資訊可用來根據使用者或使用者對文件的群組存取權來篩選搜尋結果。如需詳細資訊,請參閱使用者內容篩選

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

    注意

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

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

進一步了解

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