Menyindir

Quip adalah perangkat lunak produktivitas kolaboratif yang menawarkan kemampuan penulisan dokumen waktu nyata. Anda dapat menggunakan Amazon Kendra untuk mengindeks folder Quip, file, komentar file, ruang obrolan, dan lampiran Quip Anda.

Anda dapat terhubung Amazon Kendra ke sumber data Quip menggunakan Amazon Kendra konsol dan QuipConfigurationAPI.

Untuk memecahkan masalah konektor sumber data Amazon Kendra Quip, lihat. Mengatasi masalah sumber data

Fitur yang didukung

Amazon Kendra Konektor sumber data Quip mendukung fitur-fitur berikut:

• Pemetaan lapangan

• Kontrol akses pengguna

• Filter inklusi/pengecualian

• Cloud privat virtual (VPC)

Prasyarat

Sebelum Anda dapat menggunakan Amazon Kendra untuk mengindeks sumber data Quip Anda, buat perubahan ini di Quip dan AWS akun Anda.

Di Quip, pastikan Anda memiliki:

• Akun Quip dengan izin administratif.

• Kredensi otentikasi Quip dibuat yang menyertakan token akses pribadi. Token digunakan sebagai kredensi otentikasi Anda yang disimpan dalam rahasia. AWS Secrets Manager Lihat dokumentasi Quip tentang otentikasi untuk informasi selengkapnya.

  catatan

  Kami menyarankan Anda secara teratur menyegarkan atau memutar kredensil dan rahasia Anda. Berikan hanya tingkat akses yang diperlukan untuk keamanan Anda sendiri. Kami tidak menyarankan Anda menggunakan kembali kredensyal dan rahasia di seluruh sumber data, dan konektor versi 1.0 dan 2.0 (jika berlaku).

• Menyalin domain situs Quip Anda. Misalnya, https://quip-company.quipdomain.com/browse di mana quipdomain adalah domain.

• Memeriksa setiap dokumen unik di Quip dan di seluruh sumber data lain yang Anda rencanakan untuk digunakan untuk indeks yang sama. Setiap sumber data yang ingin Anda gunakan untuk indeks tidak boleh berisi dokumen yang sama di seluruh sumber data. ID dokumen bersifat global untuk indeks dan harus unik per indeks.

Di dalam Anda Akun AWS, pastikan Anda memiliki:

• Membuat Amazon Kendra indeks dan, jika menggunakan API, mencatat ID indeks.

• Membuat IAM peran untuk sumber data Anda dan, jika menggunakan API, catat ARN peran tersebut IAM .

  catatan

  Jika Anda mengubah jenis otentikasi dan kredensyal, Anda harus memperbarui IAM peran Anda untuk mengakses ID rahasia yang benar AWS Secrets Manager .

• Menyimpan kredensi otentikasi Quip Anda secara AWS Secrets Manager rahasia dan, jika menggunakan API, catat ARN rahasia tersebut.

  catatan

  Kami menyarankan Anda secara teratur menyegarkan atau memutar kredensil dan rahasia Anda. Berikan hanya tingkat akses yang diperlukan untuk keamanan Anda sendiri. Kami tidak menyarankan Anda menggunakan kembali kredensyal dan rahasia di seluruh sumber data, dan konektor versi 1.0 dan 2.0 (jika berlaku).

Jika Anda tidak memiliki IAM peran atau rahasia yang ada, Anda dapat menggunakan konsol untuk membuat IAM peran dan Secrets Manager rahasia baru saat Anda menghubungkan sumber data Quip. Amazon Kendra Jika Anda menggunakan API, Anda harus memberikan ARN IAM peran dan Secrets Manager rahasia yang ada, dan ID indeks.

Instruksi koneksi

Untuk terhubung Amazon Kendra ke sumber data Quip Anda, Anda harus memberikan rincian yang diperlukan dari sumber data Quip Anda sehingga Amazon Kendra dapat mengakses data Anda. Jika Anda belum mengkonfigurasi Quip untuk Amazon Kendra, lihatPrasyarat.

Console

Untuk terhubung Amazon Kendra ke Quip

1. Masuk ke AWS Management Console dan buka Amazon Kendra konsol.

2. Dari panel navigasi kiri, pilih Indeks dan kemudian pilih indeks yang ingin Anda gunakan dari daftar indeks.

   catatan

   Anda dapat memilih untuk mengonfigurasi atau mengedit pengaturan kontrol akses Pengguna Anda di bawah Pengaturan indeks.

3. Pada halaman Memulai, pilih Tambahkan sumber data.

4. Pada halaman Tambah sumber data, pilih konektor Quip, lalu pilih Tambah konektor. Jika menggunakan versi 2 (jika ada), pilih konektor Quip dengan tag “V2.0".

5. Pada halaman Tentukan detail sumber data, masukkan informasi berikut:

   1. Di Nama dan deskripsi, untuk Nama sumber data —Masukkan nama untuk sumber data Anda. Anda dapat memasukkan tanda hubung tetapi bukan spasi.

   2. (Opsional) Deskripsi —Masukkan deskripsi opsional untuk sumber data Anda.

   3. Dalam Bahasa default —Pilih bahasa untuk memfilter dokumen Anda untuk indeks. Kecuali Anda menentukan sebaliknya, bahasa default ke bahasa Inggris. Bahasa yang ditentukan dalam metadata dokumen mengesampingkan bahasa yang dipilih.

   4. Di Tag, untuk Tambahkan tag baru —Sertakan tag opsional untuk mencari dan memfilter sumber daya Anda atau melacak AWS biaya Anda.

   5. Pilih Selanjutnya.

6. Pada halaman Tentukan akses dan keamanan, masukkan informasi berikut:

   1. Nama domain Quip —Masukkan Quip yang Anda salin dari akun Quip Anda.

   2. AWS Secrets Manager rahasia —Pilih rahasia yang ada atau buat Secrets Manager rahasia baru untuk menyimpan kredensyal otentikasi Quip Anda. Jika Anda memilih untuk membuat rahasia baru, jendela AWS Secrets Manager rahasia terbuka.

      1. Masukkan informasi berikut di jendela Buat AWS Secrets Manager rahasia:

         1. Nama rahasia —Nama untuk rahasiamu. Awalan 'AmazonKendra-Quip-' secara otomatis ditambahkan ke nama rahasia Anda.

         2. Token Quip —Masukkan Quip akses pribadi Quip yang dikonfigurasi Quip.

      2. Tambahkan dan simpan rahasia Anda.

   3. Virtual Private Cloud (VPC) —Anda dapat memilih untuk menggunakan VPC. Jika demikian, Anda harus menambahkan Subnet dan grup keamanan VPC.

   4. IAM peran —Pilih peran yang sudah ada atau buat IAM IAM peran baru untuk mengakses kredensi repositori dan mengindeks konten Anda.

      catatan

      IAM peran yang digunakan untuk indeks tidak dapat digunakan untuk sumber data. Jika Anda tidak yakin apakah peran yang ada digunakan untuk indeks atau FAQ, pilih Buat peran baru untuk menghindari kesalahan.

   5. Pilih Selanjutnya.

7. Pada halaman Konfigurasi pengaturan sinkronisasi, masukkan informasi berikut:

   1. Tambahkan ID folder Quip ke crawl —ID folder Quip yang ingin Anda jelajahi.

      catatan

      Untuk merayapi folder root, termasuk semua sub-folder dan dokumen di dalamnya, tambahkan ID folder root. Untuk merayapi sub-folder tertentu, tambahkan ID sub-folder tertentu.

   2. Konfigurasi tambahan (tipe konten) —Masukkan jenis konten yang ingin dirayapi.

   3. Pola Regex —Pola ekspresi reguler untuk menyertakan atau mengecualikan file tertentu. Anda dapat menambahkan hingga 100 pola.

   4. Di Jadwal lari Sinkronisasi, untuk Frekuensi —Pilih seberapa sering menyinkronkan konten sumber data Anda dan memperbarui indeks Anda

   5. Pilih Selanjutnya.

8. Pada halaman Setel pemetaan bidang, masukkan informasi berikut:

   1. Pilih dari bidang sumber data default yang dihasilkan yang ingin Anda petakan untuk Amazon Kendra diindeks.

   2. Tambahkan bidang —Untuk menambahkan bidang sumber data kustom untuk membuat nama bidang indeks untuk dipetakan dan tipe data bidang.

   3. Pilih Selanjutnya.

9. Pada halaman Tinjau dan buat, periksa apakah informasi yang Anda masukkan sudah benar dan kemudian pilih Tambahkan sumber data. Anda juga dapat memilih untuk mengedit informasi Anda dari halaman ini. Sumber data Anda akan muncul di halaman Sumber data setelah sumber data berhasil ditambahkan.

API

Untuk terhubung Amazon Kendra ke Quip

Anda harus menentukan yang berikut menggunakan QuipConfiguration API:

• Domain situs Quip —Misalnya, https://quip-company.quipdomain.com/browse di mana quipdomain adalah domain.

• Rahasia Nama Sumber Daya Amazon (ARN) —Berikan Nama Sumber Daya Amazon (ARN) Secrets Manager rahasia yang berisi kredensyal otentikasi untuk akun Quip Anda. Rahasianya disimpan dalam struktur JSON dengan kunci berikut:

  {
      "accessToken": "token"
  }

• IAM role —Tentukan RoleArn kapan Anda menelepon CreateDataSource untuk memberikan IAM peran dengan izin untuk mengakses Secrets Manager rahasia Anda dan memanggil API publik yang diperlukan untuk konektor Quip dan. Amazon Kendra Untuk informasi selengkapnya, lihat IAM peran untuk sumber data Quip.

Anda juga dapat menambahkan fitur opsional berikut:

• Virtual Private Cloud (VPC) —Tentukan VpcConfiguration sebagai bagian dari konfigurasi sumber data. Lihat Mengkonfigurasi Amazon Kendra untuk menggunakan VPC.

• Filter inklusi dan pengecualian —Tentukan apakah akan menyertakan atau mengecualikan file tertentu.

  catatan

  Sebagian besar sumber data menggunakan pola ekspresi reguler, yang merupakan pola inklusi atau pengecualian yang disebut sebagai filter. Jika Anda menentukan filter inklusi, hanya konten yang cocok dengan filter inklusi yang diindeks. Dokumen apa pun yang tidak cocok dengan filter inklusi tidak diindeks. Jika Anda menentukan filter inklusi dan pengecualian, dokumen yang cocok dengan filter pengecualian tidak akan diindeks, meskipun sesuai dengan filter inklusi.

• Folder —Tentukan folder Quip dan subfolder yang ingin Anda indeks

  catatan

  Untuk merayapi folder root, termasuk semua sub-folder dan dokumen di dalamnya, masukkan ID folder root. Untuk merayapi sub-folder tertentu, tambahkan ID sub-folder tertentu.

• Lampiran, ruang obrolan, komentar file —Pilih apakah akan menyertakan crawling lampiran, konten ruang obrolan, dan komentar file.

• Pemfilteran konteks pengguna dan kontrol akses —Amazon Kendra meng-crawl daftar kontrol akses (ACL) untuk dokumen Anda, jika Anda memiliki ACL untuk dokumen Anda. Informasi ACL digunakan untuk memfilter hasil pencarian berdasarkan pengguna atau akses grup mereka ke dokumen. Untuk informasi selengkapnya, lihat Pemfilteran konteks pengguna.

• Pemetaan bidang —Pilih untuk memetakan bidang sumber data Quip Anda ke bidang indeks Anda. Amazon Kendra Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data.

  catatan

  Bidang badan dokumen atau badan dokumen yang setara untuk dokumen Anda diperlukan Amazon Kendra untuk mencari dokumen Anda. Anda harus memetakan nama bidang badan dokumen Anda di sumber data Anda ke nama bidang indeks_document_body. Semua kolom lain bersifat opsional.

Pelajari selengkapnya

Untuk mempelajari lebih lanjut tentang mengintegrasikan Amazon Kendra dengan sumber data Quip, lihat:

• Cari pengetahuan dalam dokumen Quip dengan pencarian cerdas menggunakan konektor Quip untuk Amazon Kendra