Gmail - Amazon Kendra

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

Gmail

Gmail 是由 Google 開發的電子郵件客戶端,您可以通過它發送帶有文件附件的電子郵件。Gmail 郵件可以使用文件夾和標籤對您的電子郵件收件箱進行排序和存儲。您可以用 Amazon Kendra 來編製電子郵件訊息和郵件附件的索引。您也可以設定 Amazon Kendra 為包含或排除特定的電子郵件訊息、郵件附件和索引標籤。

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

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

支援的功能

  • 欄位對映

  • 使用者存取控制

  • 包含/排除過濾器

  • 完整和增量內容同步

  • 虛擬私有雲端 (VPC)

必要條件

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

在 Gmail 中,請確定您擁有以下功能:

  • 創建了一個谷歌雲平台管理員帳戶,並創建了一個谷歌雲項目。

  • 在您的管理員帳戶中激活了 Gmail API 和管理員 SDK API。

  • 創建了一個服務帳戶並為您的 Gmail 下載了一個 JSON 私鑰。如需如何建立和存取私密金鑰的詳細資訊,請參閱 Google Cloud 說明文件,瞭解如何建立服務帳戶金鑰服務帳戶憑證

  • 複製您的管理員帳戶電子郵件,您的服務帳戶電子郵件和私鑰以用作身份驗證憑據。

    注意

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

  • 為您的使用者和要建立索引的共用目錄新增下列 Oauth 範圍 (使用管理員角色):

    • https://www.googleapis.com/auth/admin.directory.user.readonly

    • https://www.googleapis.com/auth/gmail.readonly

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

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

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

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

    注意

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

  • 將您的 Gmail 身份驗證憑據存儲在一個 AWS Secrets Manager 秘密中,如果使用 API,則註明秘密的 ARN。

    注意

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

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

連接說明

要連接 Amazon Kendra 到 Gmail 數據源,您必須提供 Gmail 憑據的詳細信息, Amazon Kendra 以便可以訪問您的數據。如果您尚未為 Gmail 設定 Amazon Kendra,請參閱必要條件

Console

若要連線 Amazon Kendra 至 Gmail

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

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

    注意

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

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

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

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

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

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

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

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

    5. 選擇下一步

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

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

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

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

        1. 秘密名稱 — 您秘密的名稱。

        2. 用戶端電子郵件:您從 Google 服務帳戶複製的用戶端電子郵件。

        3. 管理員帳戶電子郵件 — 您要使用的管理員帳戶電子郵件。

        4. 私密金鑰 — 您從 Google 服務帳戶複製的私密金鑰。

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

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

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

      注意

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

    5. 選擇下一步

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

    1. 對於實體類型 — 選擇同步郵件附件。

    2. (選擇性) 對於其他組態,請輸入下列資訊:

      1. 日期範圍 — 輸入日期範圍,以指定您要編目的電子郵件的開始和結束日期。

      2. 電子郵件網域:包含或排除以「收件者」、「寄件者」、「副本」和「密件副本」電子郵件網域為基礎的某些電子郵件。

      3. 主旨中的關鍵字:根據電子郵件主題中的關鍵字加入或排除電子郵件。

        注意

        您也可以選擇包含符合您輸入之所有主題關鍵字的任何文件。

      4. 標籤 — 新增規則運算式模式以包含或排除某些電子郵件標籤。

      5. 附件 — 新增規則運算式模式以包含或排除特定電子郵件附件。

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

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

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

      重要

      由於沒有 API 可以更新永久刪除的 Gmail 郵件,因此新的,修改或刪除的內容同步:

      • 不會從 Amazon Kendra 索引中移除已從 Gmail 永久刪除的郵件

      • 不會同步 Gmail 電子郵件標籤中的變更

      若要將 Gmail 資料來源標籤變更和永久刪除的電子郵件訊息同步至 Amazon Kendra 索引,您必須定期執行完整檢索。

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

    5. 選擇下一步

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

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

      注意

      Amazon Kendra 由於 API 限制,Gmail 資料來源連接器不支援建立自訂索引欄位。

    2. 選擇下一步

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

API

若要連線 Amazon Kendra 至 Gmail

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

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

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

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

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

    重要

    由於沒有 API 可以更新永久刪除的 Gmail 郵件,因此新的,修改或刪除的內容同步:

    • 不會從 Amazon Kendra 索引中移除已從 Gmail 永久刪除的郵件

    • 不會同步 Gmail 電子郵件標籤中的變更

    若要將 Gmail 資料來源標籤變更和永久刪除的電子郵件訊息同步至 Amazon Kendra 索引,您必須定期執行完整檢索。

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

    { "adminAccountEmailId": "service account email", "clientEmailId": "user account email", "privateKey": "private key" }
  • IAM role — 指定您撥打電話的RoleArn時間,CreateDataSource以提供具有存取 Secrets Manager 密碼權限的 IAM 角色,以及呼叫 Gmail 連接器和 Amazon Kendra所需的公用 API 的時間。如需詳細資訊,請參閱 Gmail 資料來源的IAM 角色

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

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

  • 包含和排除篩選器 — 指定是否要包含或排除某些「收件人」、「寄件者」、「副本」、「密件副本」電子郵件。

    注意

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

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

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

    注意

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

    注意

    Amazon Kendra 由於 API 限制,Gmail 資料來源連接器不支援建立自訂索引欄位。

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

進一步了解

若要進一步瞭解如何整 Amazon Kendra 合 Gmail 資料來源,請參閱:

備註

  • 由於沒有 API 可以更新永久刪除的 Gmail 郵件,因此可以進行FULL_CRAWL/新增、修改或刪除的內容同步

    • 不會從 Amazon Kendra 索引中移除已從 Gmail 永久刪除的郵件

    • 不會同步 Gmail 電子郵件標籤中的變更

    若要將 Gmail 資料來源標籤變更和永久刪除的電子郵件訊息同步至 Amazon Kendra 索引,您必須定期執行完整檢索。

  • Amazon Kendra 由於 API 限制,Gmail 資料來源連接器不支援建立自訂索引欄位。