Quip
Quip コネクタは、2026 年 5 月 31 日まで既存のお客様を対象に引き続き完全にサポートされます。新規ユーザーがこのコネクタを使用することはできなくなりましたが、現在のユーザーは中断なく引き続きご使用いただけます。コネクタポートフォリオは、よりスケーラブルでカスタマイズ可能なソリューションを提供するために継続的に進化しています。今後の統合のために、柔軟性を高めながら、より広範なエンタープライズユースケースをサポートするように設計された、Amazon Kendra Custom Connector Framework[1] を検討いただくことをお勧めします。
Quip は、リアルタイムのドキュメント作成機能を提供する共同生産性向上ソフトウェアです。Amazon Kendra を使用して Quip のフォルダ、ファイル、ファイルコメント、チャットルーム、添付ファイルのインデックスを作成できます。
Amazon Kendra コンソールと QuipConfiguration API を使用して、Quip データソースに接続できます。
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 および同じインデックスを使用予定の他のデータソース間で一意であることを確認しました。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。
AWS アカウント で以下を確認してください。
-
Amazon Kendra インデックスが作成済みで、API を使用している場合はインデックス ID を記録済み。
-
データソース用の IAM ロールが作成済みで、API を使用している場合は IAM ロールの ARN を記録済み。
認証タイプと認証情報を変更した場合、正しい AWS Secrets Manager シークレット ID にアクセスできるように IAM ロールを更新する必要があります。
-
Quip の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。
認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨しません。
既存の IAM ロールやシークレットがない場合は、Quip データソースを Amazon Kendra に接続するときに、コンソールを使用して新しい IAM ロールと Secrets Manager シークレットを作成できます。API を使用している場合は、既存の IAM ロールと Secrets Manager シークレットの ARN、およびインデックス ID を指定する必要があります。
接続手順
Amazon Kendra を Quip データソースに接続するには、Amazon Kendra がデータにアクセスできるように Quip データソースの必要な詳細情報を入力する必要があります。Amazon Kendra で Quip をまだ設定していない場合は、「前提条件」を参照してください。
- Console
-
Amazon Kendra を Quip に接続するには
-
AWS マネジメントコンソール にサインインして、Amazon Kendra コンソール を開きます。
-
左側のナビゲーションペインで、[インデックス] を選択し、インデックスのリストから使用するインデックスを選択します。
[インデックスの設定] で、[ユーザーアクセスコントロール] 設定を設定または編集できます。
-
[使用開始] ページで、[データソースを追加] を選択します。
-
[データソースを追加] ページで [Quip コネクタ] を選択し、[コネクタを追加] を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた [Quip コネクタ] を選択します。
-
[データソースの詳細を指定] ページで、次の情報を入力します。
-
[名前と説明] の [データソース名] に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。
-
(オプション) [説明] - オプションで、データソースの説明を入力します。
-
[デフォルト言語] - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。
-
[タグ] の [新しいタグを追加] - リソースの検索とフィルタリングや、AWS コストの追跡を行うためのオプションのタグを含めることができます。
-
[Next] (次へ) を選択します。
-
[アクセスとセキュリティの定義] ページで、次の情報を入力します。
-
Quip ドメイン名 - Quip アカウントからコピーした Quip を入力します。
-
[AWS Secrets Manager シークレット] - Quip の認証情報を保存する既存のシークレットを選択するか、新しい Secrets Manager シークレットを作成します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。
-
[AWS Secrets Manager シークレットウィンドウを作成] に次の情報を入力します。
-
[シークレット名] - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Quip-」が自動的に追加されます。
-
[Quip トークン] — Quip で設定した Quip の個人用アクセスを入力します。
-
シークレットを追加して保存します。
-
[仮想プライベートクラウド (VPC)] - VPC の使用を選択できます。選択する場合は、[サブネット] と [VPC セキュリティグループ] を追加する必要があります。
-
[IAM ロール] - 既存の IAM ロールを選択するか、新しい IAM ロールを作成して、リポジトリの認証情報とインデックスコンテンツにアクセスします。
インデックスに使用される IAM ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、[新しいロールを作成] を選択してください。
-
[Next] (次へ) を選択します。
-
[同期設定の構成] ページで、次の情報を入力します。
-
クロールする Quip フォルダ ID を追加 - クロールする Quip フォルダ ID。
すべてのサブフォルダとその中のドキュメントを含むルートフォルダをクロールするには、ルートフォルダ ID を追加します。特定のサブフォルダをクロールするには、特定のサブフォルダ ID を追加します。
-
追加設定 (コンテンツタイプ) - クロールするコンテンツタイプを入力します。
-
[正規表現パターン] - 特定のファイルを含めるまたは除外する正規表現パターン。最大 100 のパターンを追加できます。
-
[同期実行スケジュール] の [頻度] - データソースコンテンツを同期してインデックスを更新する頻度を選択します。
-
[Next] (次へ) を選択します。
-
[フィールドマッピングを設定] ページで、次の情報を入力します。
-
Amazon Kendra インデックスにマッピングする、生成されたデフォルトのデータソースフィールドから選択します。
-
[フィールドを追加] - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。
-
[Next] (次へ) を選択します。
-
[確認と作成] ページで、入力した情報が正しいことを確認し、[データソースを追加] を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが [データソース] ページに表示されます。
- API
-
Amazon Kendra を Quip に接続するには
QuipConfiguration API を使用して以下を指定する必要があります。
-
Quip サイトドメイン - 例えば、https://quip-company.quipdomain.com/browse の場合、ドメインは quipdomain です。
-
[シークレット Amazon リソースネーム (ARN)] - Quip アカウントの認証情報が保存されている Secrets Manager シークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。
{
"accessToken": "token"
}
-
[IAM ロール] - CreateDataSource を呼び出す際に RoleArn を指定して、Secrets Manager シークレットへのアクセス許可を IAM ロールに提供し、Quip コネクタと Amazon Kendra に必要なパブリック API を呼び出します。詳細については、「Quip データソースのための IAM ロール」を参照してください。
オプションで、次の機能を追加することもできます。
-
[仮想プライベートクラウド (VPC)] - データソース設定の一部として VpcConfiguration を指定します。「VPC を使用するための Amazon Kendra の設定」を参照してください。
-
包含フィルターと除外フィルター - 特定のファイルを含めるか除外するかを指定します。
ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。
-
[フォルダ] - インデックスを作成する Quip フォルダとサブフォルダを指定します。
すべてのサブフォルダとその中のドキュメントを含むルートフォルダをクロールするには、ルートフォルダ ID を入力します。特定のサブフォルダをクロールするには、特定のサブフォルダ ID を追加します。
-
[添付ファイル、チャットルーム、ファイルのコメント] — 添付ファイル、チャットルームのコンテンツ、ファイルのコメントのクローリングを含めるかどうかを選択します。
-
[ユーザーコンテキストのフィルタリングとアクセスコントロール] — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「User context filtering」を参照してください。
-
フィールドマッピング - 選択すると、Quip データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「データソースフィールドのマッピング」を参照してください。
Amazon Kendra がドキュメントを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 _document_body にマッピングする必要があります。その他のすべてのフィールドはオプションです。
詳細
Amazon Kendra と Quip データソースとの統合について詳しくは、以下を参照してください。
