Quip - Amazon Kendra
Unterstützte FeaturesVoraussetzungenAnweisungen zur VerbindungWeitere Informationen

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Quip

Quip ist eine kollaborative Produktivitätssoftware, die Funktionen zur Erstellung von Dokumenten in Echtzeit bietet. Sie können sie verwenden Amazon Kendra , um Ihre Quip-Ordner, Dateien, Dateikommentare, Chatrooms und Anlagen zu indizieren.

Sie können über Amazon Kendra die Amazon Kendra Konsole und die API eine Verbindung zu Ihrer Quip-Datenquelle herstellen. QuipConfiguration

Informationen zur Fehlerbehebung bei Ihrem Amazon Kendra Quip-Datenquellen-Connector finden Sie unter. Problembehandlung bei Datenquellen

Unterstützte Features

Amazon Kendra Der Quip-Datenquellenconnector unterstützt die folgenden Funktionen:

  • Feldzuordnungen

  • Steuerung des Benutzerzugriffs

  • Einschluss-/Ausschlussfilter

  • Virtual Private Cloud (VPC)

Voraussetzungen

Bevor Sie Ihre Quip-Datenquelle Amazon Kendra zum Indizieren verwenden können, nehmen Sie diese Änderungen in Ihrem Quip und Ihren Konten vor. AWS

Stellen Sie in Quip sicher, dass Sie über Folgendes verfügen:

  • Ein Quip-Konto mit Administratorrechten.

  • Es wurden Quip-Authentifizierungsdaten erstellt, die ein persönliches Zugriffstoken enthalten. Das Token wird als Ihr Authentifizierungsnachweis verwendet, der geheim gespeichert ist AWS Secrets Manager . Weitere Informationen finden Sie in der Quip-Dokumentation zur Authentifizierung.

    Anmerkung

    Wir empfehlen, dass Sie Ihre Anmeldeinformationen und Ihr Geheimnis regelmäßig aktualisieren oder austauschen. Stellen Sie zu Ihrer eigenen Sicherheit nur die erforderliche Zugriffsebene bereit. Wir raten davon ab, Anmeldeinformationen und geheime Daten für alle Datenquellen und Connector-Versionen 1.0 und 2.0 (sofern zutreffend) wiederzuverwenden.

  • Die Domain Ihrer Quip-Site wurde kopiert. Zum Beispiel https://quip-company.quipdomain.com/browse, wobei quipdomain die Domain ist.

  • Vergewissert, dass jedes Dokument in Quip und in anderen Datenquellen, die Sie für denselben Index verwenden möchten, einzigartig ist. Jede Datenquelle, die Sie für einen Index verwenden möchten, darf nicht dasselbe Dokument in allen Datenquellen enthalten. Dokument-IDs gelten für einen Index global und müssen pro Index eindeutig sein.

Stellen Sie sicher AWS-Konto, dass Sie Folgendes in Ihrem haben:

  • Hat einen Amazon Kendra Index erstellt und bei Verwendung der API die Index-ID notiert.

  • Sie haben eine IAM Rolle für Ihre Datenquelle erstellt und, falls Sie die API verwenden, den ARN der IAM Rolle notiert.

    Anmerkung

    Wenn Sie Ihren Authentifizierungstyp und Ihre Anmeldeinformationen ändern, müssen Sie Ihre IAM Rolle aktualisieren, um auf die richtige AWS Secrets Manager geheime ID zugreifen zu können.

  • Ihre Quip-Authentifizierungsdaten AWS Secrets Manager geheim gespeichert und, falls Sie die API verwenden, den ARN des Geheimnisses notiert.

    Anmerkung

    Wir empfehlen Ihnen, Ihre Anmeldeinformationen und Ihr Geheimnis regelmäßig zu aktualisieren oder zu wechseln. Stellen Sie zu Ihrer eigenen Sicherheit nur die erforderliche Zugriffsebene bereit. Wir raten davon ab, Anmeldeinformationen und geheime Daten für alle Datenquellen und Connector-Versionen 1.0 und 2.0 (sofern zutreffend) wiederzuverwenden.

Wenn Sie noch keine IAM Rolle oder keinen Schlüssel haben, können Sie die Konsole verwenden, um eine neue IAM Rolle und ein neues Secrets Manager Geheimnis zu erstellen, wenn Sie Ihre Quip-Datenquelle mit verbinden. Amazon Kendra Wenn Sie die API verwenden, müssen Sie den ARN einer vorhandenen IAM Rolle und eines Secrets Manager Geheimnisses sowie eine Index-ID angeben.

Anweisungen zur Verbindung

Um eine Verbindung Amazon Kendra zu Ihrer Quip-Datenquelle herzustellen, müssen Sie die erforderlichen Details zu Ihrer Quip-Datenquelle angeben, damit Sie auf Ihre Daten zugreifen Amazon Kendra können. Wenn Sie Quip für Amazon Kendra noch nicht konfiguriert haben, finden Sie weitere Informationen unter. Voraussetzungen

Console

So stellen Sie eine Verbindung Amazon Kendra zu Quip her

  1. Melden Sie sich bei der an AWS Management Console und öffnen Sie die Amazon Kendra Konsole.

  2. Wählen Sie im linken Navigationsbereich Indizes und dann den Index, den Sie verwenden möchten, aus der Indexliste aus.

    Anmerkung

    Sie können Ihre Einstellungen für die Benutzerzugriffskontrolle unter Indexeinstellungen konfigurieren oder bearbeiten.

  3. Wählen Sie auf der Seite Erste Schritte die Option Datenquelle hinzufügen aus.

  4. Wählen Sie auf der Seite Datenquelle hinzufügen die Option Quip-Connector und dann Connector hinzufügen aus. Wenn Sie Version 2 verwenden (falls zutreffend), wählen Sie den Quip-Connector mit dem Tag „V2.0".

  5. Geben Sie auf der Seite „Datenquellendetails angeben“ die folgenden Informationen ein:

    1. Geben Sie im Feld Name und Beschreibung für Datenquellenname einen Namen für Ihre Datenquelle ein. Sie können Bindestriche, aber keine Leerzeichen verwenden.

    2. (Optional) Beschreibung — Geben Sie eine optionale Beschreibung für Ihre Datenquelle ein.

    3. In Standardsprache — Wählen Sie eine Sprache aus, um Ihre Dokumente nach dem Index zu filtern. Sofern Sie nichts anderes angeben, ist die Standardsprache Englisch. Die in den Metadaten des Dokuments angegebene Sprache hat Vorrang vor der ausgewählten Sprache.

    4. Unter Tags für Neues Tag hinzufügen — Fügen Sie optionale Tags hinzu, um Ihre Ressourcen zu durchsuchen und zu filtern oder Ihre Kosten nachzuverfolgen. AWS

    5. Wählen Sie Weiter aus.

  6. Geben Sie auf der Seite Zugriff und Sicherheit definieren die folgenden Informationen ein:

    1. Quip-Domainname — Geben Sie den Quip ein, den Sie aus Ihrem Quip-Konto kopiert haben.

    2. AWS Secrets Manager geheim — Wählen Sie ein vorhandenes Geheimnis oder erstellen Sie ein neues Secrets Manager Geheimnis, um Ihre Quip-Authentifizierungsdaten zu speichern. Wenn Sie sich dafür entscheiden, ein neues Geheimnis zu erstellen, wird ein AWS Secrets Manager geheimes Fenster geöffnet.

      1. Geben Sie die folgenden Informationen in das Fenster Create an AWS Secrets Manager Secret ein:

        1. Geheimer Name — Ein Name für Ihr Geheimnis. Das Präfix 'AmazonKendra-Quip-' wird Ihrem geheimen Namen automatisch hinzugefügt.

        2. Quip-Token — Geben Sie das für Quip Personal Access konfigurierte Quip ein.

      2. Fügen Sie Ihr Geheimnis hinzu und speichern Sie es.

    3. Virtual Private Cloud (VPC) — Sie können wählen, ob Sie eine VPC verwenden möchten. In diesem Fall müssen Sie Subnetze und VPC-Sicherheitsgruppen hinzufügen.

    4. IAM Rolle — Wählen Sie eine bestehende IAM Rolle oder erstellen Sie eine neue IAM Rolle, um auf Ihre Repository-Anmeldeinformationen und Indexinhalte zuzugreifen.

      Anmerkung

      IAM Rollen, die für Indizes verwendet werden, können nicht für Datenquellen verwendet werden. Wenn Sie sich nicht sicher sind, ob eine vorhandene Rolle für einen Index oder eine häufig gestellte Frage verwendet wird, wählen Sie Neue Rolle erstellen, um Fehler zu vermeiden.

    5. Wählen Sie Weiter aus.

  7. Geben Sie auf der Seite „Synchronisierungseinstellungen konfigurieren“ die folgenden Informationen ein:

    1. Quip-Ordner-IDs zum Crawlen hinzufügen — Die Quip-Ordner-IDs, die Sie crawlen möchten.

      Anmerkung

      Um einen Stammordner einschließlich aller darin enthaltenen Unterordner und Dokumente zu crawlen, fügen Sie die Stammordner-ID hinzu. Um bestimmte Unterordner zu crawlen, fügen Sie die spezifischen Unterordner-IDs hinzu.

    2. Zusätzliche Konfiguration (Inhaltstypen) — Geben Sie die Inhaltstypen ein, die Sie crawlen möchten.

    3. Regex-Muster — Reguläre Ausdrucksmuster zum Ein- oder Ausschließen bestimmter Dateien. Sie können bis zu 100 Muster hinzufügen.

    4. Wählen Sie im Zeitplan für die Synchronisierungsausführung für Häufigkeit aus, wie oft der Inhalt Ihrer Datenquelle synchronisiert und Ihr Index aktualisiert werden soll

    5. Wählen Sie Weiter aus.

  8. Geben Sie auf der Seite Feldzuordnungen festlegen die folgenden Informationen ein:

    1. Wählen Sie aus den generierten Standard-Datenquellenfeldern aus, die Sie dem Index zuordnen möchten Amazon Kendra .

    2. Feld hinzufügen — Um benutzerdefinierte Datenquellenfelder hinzuzufügen, um einen Indexfeldnamen für die Zuordnung und den Felddatentyp zu erstellen.

    3. Wählen Sie Weiter aus.

  9. Überprüfen Sie auf der Seite Überprüfen und erstellen, ob die von Ihnen eingegebenen Informationen korrekt sind, und wählen Sie dann Datenquelle hinzufügen aus. Sie können Ihre Informationen auch auf dieser Seite bearbeiten. Ihre Datenquelle wird auf der Seite Datenquellen angezeigt, nachdem die Datenquelle erfolgreich hinzugefügt wurde.

API

Um eine Verbindung Amazon Kendra zu Quip herzustellen

Mithilfe der QuipConfiguration API müssen Sie Folgendes angeben:

  • Quip-Site-Domain — Zum Beispiel https://quip-company.quipdomain.com/browse, wobei quipdomain die Domain ist.

  • Geheimer Amazon-Ressourcenname (ARN) — Geben Sie den Amazon-Ressourcennamen (ARN) eines Secrets Manager Geheimnisses ein, das die Authentifizierungsdaten für Ihr Quip-Konto enthält. Das Geheimnis wird in einer JSON-Struktur mit den folgenden Schlüsseln gespeichert:

    {
    "accessToken": "token"
}

  • IAM role — Geben Sie anRoleArn, wann Sie anrufenCreateDataSource, um einer IAM Rolle Berechtigungen für den Zugriff auf Ihr Secrets Manager Geheimnis und den Aufruf der erforderlichen öffentlichen APIs für den Quip-Connector und zu erteilen. Amazon Kendra Weitere Informationen finden Sie unter IAM Rollen für Quip-Datenquellen.

Sie können auch die folgenden optionalen Funktionen hinzufügen:

  • Virtual Private Cloud (VPC) — Geben Sie dies VpcConfiguration als Teil der Datenquellenkonfiguration an. Siehe Konfiguration Amazon Kendra für die Verwendung einer VPC.

  • Inklusions- und Ausschlussfilter — Geben Sie an, ob bestimmte Dateien ein- oder ausgeschlossen werden sollen.

    Anmerkung

    Die meisten Datenquellen verwenden Muster mit regulären Ausdrücken, bei denen es sich um Ein- oder Ausschlussmuster handelt, die als Filter bezeichnet werden. Wenn Sie einen Einschlussfilter angeben, werden nur Inhalte indexiert, die dem Einschlussfilter entsprechen. Jedes Dokument, das nicht dem Einschlussfilter entspricht, wird nicht indexiert. Wenn Sie einen Ein- und Ausschlussfilter angeben, werden Dokumente, die dem Ausschlussfilter entsprechen, nicht indexiert, auch wenn sie dem Einschlussfilter entsprechen.

  • Ordner — Geben Sie die Quip-Ordner und Unterordner an, die Sie indizieren möchten

    Anmerkung

    Um einen Stammordner einschließlich aller darin enthaltenen Unterordner und Dokumente zu crawlen, geben Sie die Stammordner-ID ein. Um bestimmte Unterordner zu crawlen, fügen Sie die spezifischen Unterordner-IDs hinzu.

  • Anlagen, Chatrooms, Dateikommentare — Wählen Sie aus, ob das Crawlen von Anhängen, Inhalten von Chatrooms und Dateikommentaren einbezogen werden soll.

  • Benutzerkontextfilterung und Zugriffskontrolle —Amazon Kendra durchsucht die Zugriffskontrollliste (ACL) für Ihre Dokumente, sofern Sie über eine ACL für Ihre Dokumente verfügen. Die ACL-Informationen werden verwendet, um Suchergebnisse nach dem Benutzer- oder Gruppenzugriff auf Dokumente zu filtern. Weitere Informationen finden Sie unter Benutzerkontextfilterung.

  • Feldzuordnungen — Wählen Sie diese Option, um Ihre Quip-Datenquellenfelder Ihren Indexfeldern zuzuordnen. Amazon Kendra Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.

    Anmerkung

    Das Textfeld oder das entsprechende Textfeld für Ihre Dokumente ist erforderlich, um Ihre Dokumente durchsuchen Amazon Kendra zu können. Sie müssen den Feldnamen Ihres Dokumenthauptteils in Ihrer Datenquelle dem Namen des Indexfeldes zuordnen_document_body. Alle anderen Felder sind optional.

Weitere Informationen

Weitere Informationen zur Integration Amazon Kendra mit Ihrer Quip-Datenquelle finden Sie unter: