Zendesk - Amazon Kendra

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.

Zendesk

Zendesk ist ein Kundenbeziehungsmanagementsystem, das Unternehmen dabei unterstützt, Interaktionen mit dem Kundensupport zu automatisieren und zu verbessern. Sie können es verwenden, Amazon Kendra um Ihre Zendesk-Supporttickets, Ticketkommentare, Ticketanhänge, Help-Center-Artikel, Artikelkommentare, Anlagen zu Artikelkommentaren, Leitfadenthemen, Community-Posts und Kommentare zu Community-Posts zu indexieren.

Sie können nach dem Namen der Organisation filtern, wenn Sie Tickets indizieren möchten, die sich nur innerhalb einer bestimmten Organisation befinden. Sie können auch ein Crawldatum festlegen, an dem Sie mit dem Crawlen von Daten aus Zendesk beginnen möchten.

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

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

Unterstützte Features

Amazon Kendra Der Zendesk-Datenquellen-Connector unterstützt die folgenden Funktionen:

  • Feldzuordnungen

  • Steuerung des Benutzerzugriffs

  • Einschluss-/Ausschlussfilter

  • Änderungsprotokoll, vollständige und inkrementelle Inhaltssynchronisierung

  • Virtual Private Cloud (VPC)

Voraussetzungen

Bevor Sie Ihre Zendesk-Datenquelle Amazon Kendra zum Indizieren verwenden können, müssen Sie diese Änderungen in Ihrem Zendesk und Ihren Konten vornehmen. AWS

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

  • Sie haben ein Administratorkonto für die Zendesk Suite (Professional/Enterprise) erstellt.

  • Ich habe Ihre Zendesk-Host-URL notiert. Beispiel, https://{sub-domain}.zendesk.com/.

    Anmerkung

    (On-Premise/Server) Amazon Kendra überprüft, ob die in der Datei enthaltenen Endpunktinformationen mit den Endpunktinformationen übereinstimmen, die in AWS Secrets Manager den Konfigurationsdetails Ihrer Datenquelle angegeben sind. Dies trägt zum Schutz vor dem Problem des verwirrten Stellvertreters bei, bei dem es sich um ein Sicherheitsproblem handelt, bei dem ein Benutzer nicht berechtigt ist, eine Aktion auszuführen, sondern ihn Amazon Kendra als Proxy verwendet, um auf das konfigurierte Geheimnis zuzugreifen und die Aktion auszuführen. Wenn Sie Ihre Endpunktinformationen später ändern, müssen Sie ein neues Geheimnis erstellen, um diese Informationen zu synchronisieren.

  • Es wurde ein OAuth 2.0-Token konfiguriert, das eine Client-ID, einen geheimen Client-Schlüssel, einen Benutzernamen und ein Passwort enthält. Das OAuth 2.0-Token muss als Ihre Authentifizierungsdaten verwendet werden. Weitere Informationen finden Sie in der Zendesk-Dokumentation zur Konfiguration von OAuth 2.0-Token.

    Anmerkung

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

  • Der folgende OAuth 2.0-Bereich wurde hinzugefügt:

    • read

  • Optional: Es wurde ein SSL-Zertifikat installiert, Amazon Kendra um eine Verbindung herzustellen.

  • Aktiviert, dass jedes Dokument in Zendesk 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. Dokumente IDs gelten für einen Index global und müssen für jeden Index eindeutig sein.

Stellen Sie in Ihrem sicher AWS-Konto, dass Sie Folgendes 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.

  • Sie haben Ihre Zendesk-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 Zugriffsebene bereit, die erforderlich ist. 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 Zendesk-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 Zendesk-Datenquelle herzustellen, müssen Sie die erforderlichen Details zu Ihrer Zendesk-Datenquelle angeben, damit Sie auf Ihre Daten zugreifen Amazon Kendra können. Wenn Sie Zendesk noch nicht für Amazon Kendra konfiguriert haben, finden Sie weitere Informationen unter. Voraussetzungen

Console

So stellen Sie eine Verbindung Amazon Kendra zu Zendesk 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 Zendesk-Connector und dann Connector hinzufügen aus. Wenn Sie Version 2 verwenden (falls zutreffend), wählen Sie Zendesk 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.

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

    1. Zendesk-URL — Geben Sie Ihre Zendesk-URL ein. Beispiel, https://{sub-domain}.zendesk.com/.

    2. Autorisierung — Aktivieren oder deaktivieren Sie die Informationen der Zugriffskontrollliste (ACL) für Ihre Dokumente, wenn Sie über eine ACL verfügen und diese für die Zugriffskontrolle verwenden möchten. Die ACL gibt an, auf welche Dokumente Benutzer und Gruppen zugreifen können. Die ACL-Informationen werden verwendet, um Suchergebnisse nach dem Benutzer- oder Gruppenzugriff auf Dokumente zu filtern. Weitere Informationen finden Sie unter Benutzerkontextfilterung.

    3. AWS Secrets Manager geheim — Wählen Sie ein vorhandenes Geheimnis oder erstellen Sie ein neues Secrets Manager Geheimnis, um Ihre Zendesk-Authentifizierungsdaten zu speichern. Wenn Sie ein neues Geheimnis erstellen möchten, 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-Zendesk' wird Ihrem geheimen Namen automatisch hinzugefügt.

        2. Für Kunden-ID, Kundengeheimnis, Benutzername und Passwort — Geben Sie die in Zendesk konfigurierten Werte für die Authentifizierungsdaten ein.

      2. Speichern Sie Ihr Geheimnis und fügen Sie es hinzu.

    4. 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.

    5. Identity Crawler — Geben Sie an, ob der Identity Crawler aktiviert Amazon Kendra werden soll. Der Identity Crawler verwendet die Informationen der Zugriffskontrollliste (ACL) für Ihre Dokumente, um Suchergebnisse nach dem Benutzer- oder Gruppenzugriff auf Dokumente zu filtern. Wenn Sie über eine ACL für Ihre Dokumente verfügen und Ihre ACL verwenden möchten, können Sie auch den Identity Crawler aktivieren, um die Benutzerkontextfilterung von Suchergebnissen zu konfigurieren. Amazon Kendra Andernfalls können alle Dokumente öffentlich durchsucht werden, wenn Identity Crawler ausgeschaltet ist. Wenn Sie die Zugriffskontrolle für Ihre Dokumente verwenden möchten und Identity Crawler ausgeschaltet ist, können Sie alternativ die PutPrincipalMappingAPI verwenden, um Benutzer- und Gruppenzugriffsinformationen für die Benutzerkontextfilterung hochzuladen.

    6. 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.

    7. Wählen Sie Weiter.

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

    1. Inhalt auswählen — Wählen Sie die Inhaltstypen aus, die Sie crawlen möchten, von Tickets bis hin zu Help-Center-Artikeln, Community-Themen und mehr.

    2. Name der Organisation — Geben Sie die Namen der Zendesk-Organisation ein, um Inhalte zu filtern.

    3. Startdatum der Synchronisierung — Geben Sie das Datum ein, ab dem Sie mit dem Crawlen Ihrer Inhalte beginnen möchten.

    4. Regex-Muster — Fügen Sie Muster für reguläre Ausdrücke hinzu, um bestimmte Dateien ein- oder auszuschließen. Sie können bis zu 100 Muster hinzufügen.

    5. Synchronisierungsmodus — Wählen Sie aus, wie Sie Ihren Index aktualisieren möchten, wenn sich der Inhalt Ihrer Datenquelle ändert. Wenn Sie Ihre Datenquelle Amazon Kendra zum ersten Mal synchronisieren, werden alle Inhalte standardmäßig gecrawlt und indexiert. Sie müssen eine vollständige Synchronisierung Ihrer Daten durchführen, falls Ihre erste Synchronisierung fehlgeschlagen ist, auch wenn Sie die Option Vollsynchronisierung nicht als Synchronisierungsmodusoption wählen.

      • Vollständige Synchronisierung: Indizieren Sie den gesamten Inhalt neu und ersetzen die vorhandenen Inhalte jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

      • Neue, geänderte Synchronisierung: Indizieren Sie jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen nachzuverfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

      • Neue, geänderte, gelöschte Synchronisierung: Indizieren Sie bei jeder Synchronisierung Ihrer Datenquelle mit Ihrem Index nur neue, geänderte und gelöschte Inhalte. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen nachzuverfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

    6. Zeitplan für In-Sync-Ausführung für Häufigkeit — Wählen Sie aus, wie oft Ihre Datenquelleninhalte synchronisiert und Ihr Index aktualisiert werden soll.

    7. Wählen Sie Weiter.

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

    1. Standard-Datenquellenfelder — Wählen Sie eines der Amazon Kendra generierten Standard-Datenquellenfelder aus, die Sie Ihrem Index zuordnen möchten.

    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.

  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 Zendesk herzustellen

Sie müssen mithilfe der TemplateConfigurationAPI ein JSON des Datenquellenschemas angeben. Sie müssen die folgenden Informationen angeben:

  • Datenquelle — Geben Sie den Datenquellentyp an, wie ZENDESK bei der Verwendung von TemplateConfigurationJSON-Schema. Geben Sie auch die Datenquelle anTEMPLATE, wie beim Aufrufen von CreateDataSourceAPI.

  • Host-URL — Geben Sie Ihre Zendesk-Host-URL als Teil der Verbindungskonfiguration oder der Repository-Endpunktdetails an. Beispiel, https://yoursubdomain.zendesk.com.

  • Änderungsprotokoll — Gibt an, ob der Änderungsprotokollmechanismus der Zendesk-Datenquelle verwendet werden Amazon Kendra soll, um festzustellen, ob ein Dokument im Index aktualisiert werden muss.

    Anmerkung

    Verwenden Sie das Änderungsprotokoll, wenn Sie nicht alle Dokumente scannen Amazon Kendra möchten. Wenn Ihr Änderungsprotokoll umfangreich ist, dauert das Scannen der Dokumente in der Zendesk-Datenquelle möglicherweise Amazon Kendra weniger Zeit als das Verarbeiten des Änderungsprotokolls. Wenn Sie Ihre Zendesk-Datenquelle zum ersten Mal mit Ihrem Index synchronisieren, werden alle Dokumente gescannt.

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

    { "hostUrl": "https://yoursubdomain.zendesk.com", "clientId": "client ID", "clientSecret": "Zendesk client secret", "userName": "Zendesk user name", "password": "Zendesk password" }
  • IAM Rolle — Geben Sie anRoleArn, wann Sie anrufenCreateDataSource, um einer IAM Rolle Berechtigungen für den Zugriff auf Ihr Secrets Manager Geheimnis und für das Anrufen der erforderlichen Öffentlichkeit APIs für den Zendesk-Connector und zuzuweisen. Amazon Kendra Weitere Informationen finden Sie unter IAM Rollen für Zendesk-Datenquellen.

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

  • Virtual Private Cloud (VPC) — Geben Sie an, VpcConfiguration wann Sie anrufen. CreateDataSource Weitere Informationen finden Sie unter Konfiguration für Amazon Kendra die Verwendung eines Amazon VPC.

  • Dokument-/Inhaltstypen — Geben Sie an, ob gecrawlt werden soll:

    • Supporttickets, Ticketkommentare und/oder Ticketkommentaranhänge

    • Help-Center-Artikel, Artikelanhänge und Artikelkommentare

    • Leitfäden für Community-Themen, Beiträge oder Kommentare

  • Inklusions- und Ausschlussfilter — Gib an, ob bestimmte Slack-Inhalte ein- oder ausgeschlossen werden sollen. Wenn du ein Bot-Token als Teil deiner Slack-Authentifizierungsdaten verwendest, musst du das Bot-Token zu dem Channel hinzufügen, den du indexieren möchtest. Du kannst Direktnachrichten und Gruppennachrichten nicht mit einem Bot-Token indizieren.

    Anmerkung

    Die meisten Datenquellen verwenden Muster für reguläre Ausdrücke, 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.

  • 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 Zendesk-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.

Eine Liste weiterer wichtiger JSON-Schlüssel, die konfiguriert werden müssen, finden Sie unter Zendesk-Vorlagenschema.

Weitere Informationen

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