Gmail - Amazon Kendra

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

Gmail

Gmail 是由 Google 開發的電子郵件用戶端,您可以透過它以檔案附件傳送電子郵件訊息。Gmail 訊息可以使用資料夾和標籤來排序並存放在您的電子郵件收件匣中。您可以使用 Amazon Kendra為電子郵件訊息和訊息附件編製索引。您也可以設定 Amazon Kendra來包含或排除特定電子郵件訊息、訊息附件和索引標籤。

您可以使用 Amazon Kendra主控台TemplateConfiguration API Amazon Kendra連線到 Gmail 資料來源。

如需對 Amazon KendraGmail 資料來源連接器進行故障診斷,請參閱 對資料來源進行故障診斷

支援的功能

  • 欄位對應

  • 使用者存取控制

  • 包含/排除篩選條件

  • 完整和增量內容同步

  • 虛擬私有雲端 (VPC)

先決條件

在您可以使用 Amazon Kendra為 Gmail 資料來源編製索引之前,請在 Gmail 和AWS帳戶中進行這些變更。

在 Gmail 中,請確定您有:

  • 您已建立 Google Cloud Platform 管理員帳戶及 Google Cloud 專案。

  • 已在管理員帳戶中啟用 Gmail API 和 Admin 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 中以及您計劃用於相同索引的其他資料來源中都是唯一的。您要用於索引的每個資料來源不得包含跨資料來源的相同文件。文件 IDs是索引的全域 ID,且每個索引必須是唯一的。

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

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

  • 為您的資料來源建立 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可以存取您的資料。如果您尚未為 設定 GmailAmazon Kendra,請參閱 先決條件

Console

Amazon Kendra連線至 Gmail

  1. 登入 AWS 管理主控台並開啟 Amazon Kendra主控台

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

    注意

    您可以選擇在索引設定下設定或編輯使用者存取控制設定。

  3. 入門頁面上,選擇新增資料來源

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

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

    1. 名稱和描述中,針對資料來源名稱 - 輸入資料來源的名稱。您可以包含連字號,但不能包含空格。

    2. (選用) 描述 — 輸入資料來源的選用描述。

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

    4. 標籤中,針對新增標籤 - 包含選用標籤,以搜尋和篩選您的資源或追蹤您的AWS成本。

    5. 選擇下一步

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

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

    2. AWSSecrets Manager秘密身分驗證 - 選擇現有的秘密或建立新的Secrets Manager秘密,以存放您的 Gmail 身分驗證憑證。如果您選擇建立新的秘密,則會開啟AWSSecrets Manager秘密視窗。

      1. 建立AWSSecrets Manager秘密視窗中輸入下列資訊:

        1. 秘密名稱 - 秘密的名稱。

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

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

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

        5. 儲存並新增您的秘密。

    3. Virtual Private Cloud (VPC) — 您可以選擇使用 VPC。若是如此,您必須新增子網路VPC 安全群組

    4. IAMrole - 選擇現有IAM角色或建立新的IAM角色,以存取您的儲存庫登入資料和索引內容。

      注意

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

    5. 選擇下一步

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

    1. ForEntity 類型 - 選擇同步訊息附件。

    2. (選用) 針對其他組態,輸入下列資訊:

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

      2. 電子郵件網域 - 包含或排除以 "to"、"from"、"cc" 和 "bcc" 電子郵件網域為基礎的特定電子郵件。

      3. 主題中的關鍵字 - 根據電子郵件主題中的關鍵字來包含或排除電子郵件。

        注意

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

      4. 標籤 - 新增規則表達式模式,以包含或排除特定電子郵件標籤。

      5. 附件 - 新增規則表達式模式,以包含或排除特定電子郵件附件。

    3. 同步模式 - 選擇您希望在資料來源內容變更時更新索引的方式。當您Amazon Kendra第一次使用 同步資料來源時,預設會爬取所有內容並編製索引。如果初始同步失敗,即使您未選擇完全同步做為同步模式選項,仍必須執行資料的完整同步。

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

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

      重要

      由於沒有 API 可更新永久刪除的 Gmail 訊息、新增、修改或刪除的內容同步:

      • 不會從您的索引移除從 GmailAmazon Kendra 永久刪除的訊息

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

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

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

    5. 選擇下一步

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

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

      注意

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

    2. 選擇下一步

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

API

Amazon Kendra連線至 Gmail

您必須使用 TemplateConfiguration API 指定資料來源結構描述的 JSON。您必須提供下列資訊:

  • 資料來源 - 當您使用 TemplateConfiguration JSON 結構描述GMAIL時,指定資料來源類型。當您呼叫 CreateDataSource API TEMPLATE時,也請將資料來源指定為 。

  • 同步模式 - 指定 Amazon Kendra如何在資料來源內容變更時更新索引。當您第一次使用Amazon Kendra 同步資料來源時,預設會爬取所有內容並編製索引。如果初始同步失敗,即使您未選擇完全同步做為同步模式選項,仍必須執行資料的完整同步。您可以選擇:

    • FORCED_FULL_CRAWL 以新編製所有內容的索引,每次資料來源與索引同步時都會取代現有的內容。

    • FULL_CRAWL 每次資料來源與索引同步時, 只會編製新內容、修改內容和已刪除內容的索引。Amazon Kendra 可以使用資料來源的機制來追蹤自上次同步以來變更的內容變更和索引內容。

    重要

    由於沒有 API 可更新永久刪除的 Gmail 訊息、新增、修改或刪除的內容同步:

    • 不會從您的索引移除從 GmailAmazon Kendra 永久刪除的訊息

    • 無法同步 Gmail 電子郵件標籤中的變更

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

  • Secret Amazon Resource Name (ARN) — 提供秘密的 Amazon Resource Name (ARN)Secrets Manager,其中包含 Gmail 帳戶的身分驗證憑證。秘密會以下列金鑰存放在 JSON 結構中:

    { "adminAccountEmailId": "service account email", "clientEmailId": "user account email", "privateKey": "private key" }
  • IAMrole—指定RoleArn您何時呼叫 CreateDataSource 以提供IAM角色存取Secrets Manager秘密的許可,以及呼叫 Gmail 連接器所需的公有 APIs 和 Amazon Kendra。如需詳細資訊,請參閱 IAMGmail 資料來源的角色

您也可以新增下列選用功能:

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

  • 包含和排除篩選條件 - 指定是否包含或排除特定 "to"、"from"、"cc"、"bcc" 電子郵件。

    注意

    大多數資料來源使用規則表達式模式,作為包含或排除的篩選規則,稱為篩選條件。若您設定包含篩選條件,則只有符合該條件的內容會被編列索引。任何不符合包含篩選條件的文件都不會編製索引。如果您指定包含和排除篩選條件,則符合排除篩選條件的文件不會編製索引,即使它們符合包含篩選條件。

  • 使用者內容篩選和存取控制 —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/New、修改或刪除的內容同步

    • 不會從您的Amazon Kendra索引移除從 Gmail 永久刪除的訊息

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

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

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