本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
Quip
Quip 是一種協作生產力軟體,可提供即時文件撰寫功能。您可以使用 Amazon Kendra 為 Quip 資料夾、檔案、檔案註解、聊天室和附件編製索引。
您可以使用 Amazon Kendra 主控台和 QuipConfiguration API Amazon Kendra 連線到您的 Quip 資料來源。 QuipConfiguration
如需對 Amazon Kendra Quip 資料來源連接器進行故障診斷,請參閱 對資料來源進行故障診斷。
支援的功能
Amazon Kendra Quip 資料來源連接器支援下列功能:
-
欄位映射
-
使用者存取控制
-
包含/排除篩選條件
-
虛擬私有雲端 (VPC)
先決條件
在您可以使用 Amazon Kendra 為 Quip 資料來源編製索引之前,請在您的 Quip 和 AWS 帳戶中進行這些變更。
在 Quip 中,請確定您有:
-
具有管理許可的 Quip 帳戶。
-
建立的 Quip 身分驗證憑證,其中包含個人存取字符。權杖會用作存放在 AWS Secrets Manager 秘密中的身分驗證憑證。如需詳細資訊,請參閱身分驗證的 Quip 文件。
我們建議您定期重新整理或輪換您的登入資料和秘密。僅為您自己的安全提供必要的存取層級。我們不建議您重複使用跨資料來源以及連接器 1.0 和 2.0 版 (如適用) 的登入資料和秘密。
-
已複製您的 Quip 網站網域。例如,https://quip-company.quipdomain.com/browse
,其中 quipdomain
是網域。
-
已檢查每個文件在 Quip 中,以及您計劃用於相同索引的其他資料來源中都是唯一的。您想要用於索引的每個資料來源,在資料來源中不得包含相同的文件。文件 IDs是索引的全域 ID,且每個索引必須是唯一的。
在您的 中 AWS 帳戶,請確定您有:
-
建立 Amazon Kendra 索引,如果使用 API, 會記下索引 ID。
-
為您的資料來源建立 IAM 角色,如果使用 API, 會記下 IAM 角色的 ARN。
如果您變更身分驗證類型和登入資料,則必須更新您的 IAM 角色,才能存取正確的 AWS Secrets Manager 秘密 ID。
-
將您的 Quip 身分驗證登入資料存放在 AWS Secrets Manager 秘密中,如果使用 API, 會記下秘密的 ARN。
我們建議您定期重新整理或輪換您的登入資料和秘密。僅為您自己的安全提供必要的存取層級。我們不建議您重複使用跨資料來源以及連接器 1.0 和 2.0 版 (如適用) 的登入資料和秘密。
如果您沒有現有的 IAM 角色或秘密,則可以使用 主控台來建立新的 IAM 角色和 Secrets Manager 秘密,以連接至您的 Quip 資料來源 Amazon Kendra。如果您使用 API,則必須提供現有 IAM 角色和 Secrets Manager 秘密的 ARN,以及索引 ID。
連線指示
若要 Amazon Kendra 連線至您的 Quip 資料來源,您必須提供 Quip 資料來源的必要詳細資訊,以便 Amazon Kendra 可以存取您的資料。如果您尚未設定 的 Quip Amazon Kendra,請參閱 先決條件。
- Console
-
Amazon Kendra 連線至 Quip
-
登入 AWS Management Console 並開啟 Amazon Kendra 主控台。
-
從左側導覽窗格中,選擇索引,然後從索引清單中選擇您要使用的索引。
您可以選擇在索引設定下設定或編輯使用者存取控制設定。
-
在入門頁面上,選擇新增資料來源。
-
在新增資料來源頁面上,選擇佇列連接器,然後選擇新增連接器。如果使用第 2 版 (如適用),請選擇具有「V2.0」標籤的 Quip 連接器。
-
在指定資料來源詳細資訊頁面上,輸入下列資訊:
-
在名稱和描述中,針對資料來源名稱—輸入資料來源的名稱。您可以包含連字號,但不能包含空格。
-
(選用) 描述 — 輸入資料來源的選用描述。
-
在預設語言 - 選擇語言來篩選索引的文件。除非您另有指定,否則語言預設為英文。文件中繼資料中指定的語言會覆寫選取的語言。
-
在標籤中,新增新標籤 - 包含選用標籤,以搜尋和篩選資源或追蹤 AWS 成本。
-
選擇 Next (下一步)。
-
在定義存取和安全頁面上,輸入下列資訊:
-
Quip 網域名稱 - 輸入您從 Quip 帳戶複製的 Quip。
-
AWS Secrets Manager secret - 選擇現有的秘密或建立新的 Secrets Manager 秘密,以存放您的 Quip 身分驗證憑證。如果您選擇建立新的秘密,則會 AWS Secrets Manager 開啟秘密視窗。
-
在建立 AWS Secrets Manager 秘密視窗中輸入以下資訊:
-
秘密名稱 — 秘密的名稱。字首「AmazonKendra-Quip-」會自動新增至您的秘密名稱。
-
Quip 權杖 - 輸入 Quip 個人存取設定的 Quip。
-
新增並儲存您的秘密。
-
Virtual Private Cloud (VPC):您可以選擇使用 VPC。如果是這樣,您必須新增子網路和 VPC 安全群組。
-
IAM role—選擇現有 IAM 角色或建立新的 IAM 角色,以存取您的儲存庫登入資料和索引內容。
IAM 用於索引的 角色無法用於資料來源。如果您不確定現有角色是否用於索引或常見問答集,請選擇建立新角色以避免錯誤。
-
選擇 Next (下一步)。
-
在設定同步設定頁面上,輸入下列資訊:
-
將 Quip 資料夾 IDs 新增至爬蟲 – 您要爬蟲的 Quip 資料夾 IDs。
若要抓取根資料夾,包括其中的所有子資料夾和文件,請新增根資料夾 ID。若要爬取特定的子資料夾,請新增特定的子資料夾 IDs。
-
其他組態 (內容類型) — 輸入您要爬取的內容類型。
-
Regex 模式 - 要包含或排除特定檔案的規則表達式模式。您最多可以新增 100 個模式。
-
在同步執行排程中,針對頻率 - 選擇同步資料來源內容和更新索引的頻率
-
選擇 Next (下一步)。
-
在設定欄位映射頁面上,輸入下列資訊:
-
從您要映射到 Amazon Kendra 索引的預設資料來源欄位中選取 。
-
新增欄位 - 新增自訂資料來源欄位,以建立要映射的索引欄位名稱和欄位資料類型。
-
選擇 Next (下一步)。
-
在檢閱和建立頁面上,檢查您輸入的資訊是否正確,然後選取新增資料來源。您也可以選擇從此頁面編輯您的資訊。成功新增資料來源後,您的資料來源將顯示在資料來源頁面上。
- API
-
Amazon Kendra 連線至 Quip
您必須使用 QuipConfiguration API 指定下列項目:
-
Quip 網站網域 - 例如,https://quip-company.quipdomain.com/browse
,其中 quipdomain
是網域。
-
機密 Amazon Resource Name (ARN) — 提供機密的 Amazon Resource Name (ARN) Secrets Manager ,其中包含您 Quip 帳戶的身分驗證憑證。秘密會以下列金鑰存放在 JSON 結構中:
{
"accessToken": "token
"
}
-
IAM role - 指定RoleArn
您何時呼叫 CreateDataSource
以提供 IAM 角色存取 Secrets Manager 秘密的許可,以及呼叫 Quip 連接器所需的公有 APIs 和 Amazon Kendra。如需詳細資訊,請參閱 IAM Quip 資料來源的角色。
您也可以新增下列選用功能:
-
Virtual Private Cloud (VPC) — 指定 VpcConfiguration
做為資料來源組態的一部分。請參閱設定 Amazon Kendra 以使用 VPC。
-
包含和排除篩選條件 - 指定是否包含或排除特定檔案。
大多數資料來源都使用規則表達式模式,也就是稱為篩選條件的納入或排除模式。如果您指定包含篩選條件,則只會將符合包含篩選條件的內容編製索引。任何不符合包含篩選條件的文件都不會編製索引。如果您指定包含和排除篩選條件,則符合排除篩選條件的文件不會編製索引,即使它們符合包含篩選條件。
-
資料夾 - 指定您要編製索引的 Quip 資料夾和子資料夾
若要抓取根資料夾,包括其中的所有子資料夾和文件,請輸入根資料夾 ID。若要爬取特定的子資料夾,請新增特定的子資料夾 IDs。
-
附件、聊天室、檔案註解—選擇是否要包含附件的爬取、聊天室內容和檔案註解。
-
使用者內容篩選和存取控制 —Amazon Kendra 如果您擁有文件的 ACL, 會擷取文件的存取控制清單 (ACL)。ACL 資訊用於根據使用者或其群組對文件的存取來篩選搜尋結果。如需詳細資訊,請參閱使用者內容篩選。
-
欄位映射 - 選擇將 Quip 資料來源欄位映射至您的 Amazon Kendra 索引欄位。如需詳細資訊,請參閱映射資料來源欄位。
文件內文欄位或文件內文對等項目為必要欄位, Amazon Kendra 才能搜尋您的文件。您必須將資料來源中的文件內文欄位名稱對應至索引欄位名稱 _document_body
。所有其他欄位是選用的。
進一步了解
若要進一步了解 Amazon Kendra 如何整合您的 Quip 資料來源,請參閱: