Quip - Amazon Kendra

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Quip

Quip は、リアルタイムのドキュメント作成機能を提供する共同生産性向上ソフトウェアです。 Amazon Kendra を使用して、Quip フォルダ、ファイル、ファイルコメント、チャットルーム、添付ファイルのインデックスを作成できます。

Amazon Kendra コンソールQuipConfiguration API を使用して Quip データソース Amazon Kendra に接続できます。

Amazon Kendra Quip データソースコネクタのトラブルシューティングについては、「」を参照してくださいデータソースのトラブルシューティング

サポートされている機能

Amazon Kendra Quip データソースコネクタは、次の機能をサポートしています。

  • フィールドマッピング

  • ユーザーアクセスコントロール

  • 包含/除外フィルター

  • 仮想プライベートクラウド (VPC)

前提条件

を使用して Quip データソース Amazon Kendra のインデックスを作成する前に、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 を記録しました。

    注記

    認証タイプと認証情報を変更する場合は、 IAM ロールを更新して正しい AWS Secrets Manager シークレット ID にアクセスする必要があります。

  • Quip の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。

    注記

    認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨しません

既存の IAM ロールまたはシークレットがない場合は、Quip データソースを に接続するときに、コンソールを使用して新しい IAM ロールと Secrets Manager シークレットを作成できます Amazon Kendra。API を使用している場合は、既存の IAM ロールと Secrets Manager シークレットの ARN とインデックス ID を指定する必要があります。

接続手順

Quip データソース Amazon Kendra に接続するには、 がデータ Amazon Kendra にアクセスできるように Quip データソースの必要な詳細を入力する必要があります。Quip for をまだ設定していない場合は Amazon Kendra、「」を参照してください前提条件

Console

Quip Amazon Kendra に接続するには

  1. にサインイン AWS Management Console し、Amazon Kendra コンソール を開きます。

  2. 左側のナビゲーションペインで、[インデックス] を選択し、インデックスのリストから使用するインデックスを選択します。

    注記

    [インデックスの設定] で、[ユーザーアクセスコントロール] 設定を設定または編集できます。

  3. [使用開始] ページで、[データソースを追加] を選択します。

  4. データソースの追加ページで、Quip コネクタ を選択し、コネクタの追加 を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた Quip コネクタを選択します。

  5. [データソースの詳細を指定] ページで、次の情報を入力します。

    1. [名前と説明][データソース名] に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。

    2. (オプション) [説明] - オプションで、データソースの説明を入力します。

    3. デフォルト言語 - ドキュメントをフィルタリングしてインデックスを作成する言語を選択します。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。

    4. タグ で、新しいタグを追加 — リソースを検索およびフィルタリングしたり、 AWS コストを追跡したりするためのオプションのタグを含めます。

    5. [次へ] をクリックします。

  6. [アクセスとセキュリティの定義] ページで、次の情報を入力します。

    1. Quip ドメイン名 - Quip アカウントからコピーした Quip を入力します。

    2. AWS Secrets Manager secret — 既存のシークレットを選択するか、新しいシーク Secrets Manager レットを作成して Quip 認証情報を保存します。新しいシークレットの作成を選択すると、 AWS Secrets Manager シークレットウィンドウが開きます。

      1. [ AWS Secrets Manager シークレットウィンドウを作成] に次の情報を入力します。

        1. [シークレット名] - シークレットの名前。シークレット名には、プレフィックスAmazonKendra「-Quip-」が自動的に追加されます。

        2. Quip トークン — Quip の個人アクセス設定済み Quip を入力します。

      2. シークレットを追加して保存します。

    3. [仮想プライベートクラウド (VPC)] - VPC の使用を選択できます。選択する場合は、[サブネット][VPC セキュリティグループ] を追加する必要があります。

    4. IAM ロール — 既存の IAM ロールを選択するか、リポジトリ認証情報にアクセスしてコンテンツにインデックスを付けるための新しい IAM ロールを作成します。

      注記

      IAM インデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、[新しいロールを作成] を選択してください。

    5. [次へ] をクリックします。

  7. [同期設定の構成] ページで、次の情報を入力します。

    1. クロールする Quip フォルダ ID を追加 - クロールする Quip フォルダ ID。

      注記

      すべてのサブフォルダとドキュメントを含むルートフォルダをクロールするには、ルートフォルダ ID を追加します。特定のサブフォルダをクロールするには、特定のサブフォルダ IDsを追加します。

    2. 追加設定 (コンテンツタイプ) - クロールするコンテンツタイプを入力します。

    3. [正規表現パターン] - 特定のファイルを含めるまたは除外する正規表現パターン。最大 100 のパターンを追加できます。

    4. 同期実行スケジュール 、頻度 — データソースコンテンツを同期してインデックスを更新する頻度を選択します。

    5. [次へ] をクリックします。

  8. [フィールドマッピングを設定] ページで、次の情報を入力します。

    1. Amazon Kendra インデックスにマッピングする、生成されたデフォルトのデータソースフィールドから選択します。

    2. [フィールドを追加] - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。

    3. [次へ] をクリックします。

  9. [確認と作成] ページで、入力した情報が正しいことを確認し、[データソースを追加] を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが [データソース] ページに表示されます。

API

Quip Amazon Kendra に接続するには

QuipConfiguration API を使用して以下を指定する必要があります。

  • Quip サイトドメイン - 例えば、https://quip-company.quipdomain.com/browse の場合、ドメインは quipdomain です。

  • シークレット Amazon リソースネーム (ARN) — Quip アカウントの認証情報を含む Secrets Manager シークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。

    { "accessToken": "token" }
  • IAM role — を呼び出しCreateDataSourceて、 Secrets Manager シークレットにアクセスするためのアクセス許可を IAM ロールに提供し、Quip コネクタと に必要なパブリック APIs を呼び出すRoleArnタイミングを指定します Amazon Kendra。詳細については、「Quip データソースのためのIAM ロール」を参照してください。

オプションで、次の機能を追加することもできます。

  • [仮想プライベートクラウド (VPC)] - データソース設定の一部として VpcConfiguration を指定します。「VPC を使用するための Amazon Kendra の設定」を参照してください。

  • 包含フィルターと除外フィルター - 特定のファイルを含めるか除外するかを指定します。

    注記

    ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。

  • フォルダ — インデックスを作成する Quip フォルダとサブフォルダを指定します。

    注記

    すべてのサブフォルダとドキュメントを含むルートフォルダをクロールするには、ルートフォルダ ID を入力します。特定のサブフォルダをクロールするには、特定のサブフォルダ IDsを追加します。

  • 添付ファイル、チャットルーム、ファイルコメント — 添付ファイル、チャットルームコンテンツ、ファイルコメントのクローリングを含めるかどうかを選択します。

  • ユーザーコンテキストのフィルタリングとアクセスコントロール —Amazon Kendra ドキュメントの ACL がある場合は、ドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「User context filtering」を参照してください。

  • フィールドマッピング - 選択すると、Quip データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、データソースフィールドのマッピングを参照してください。

    注記

    がドキュメント Amazon Kendra を検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 にマッピングする必要があります_document_body。その他のすべてのフィールドはオプションです。

詳細はこちら

Amazon Kendra と Quip データソースとの統合の詳細については、以下を参照してください。