Bereitstellen Amazon Kendra - Amazon Kendra
ÜbersichtVoraussetzungenDas Beispiel einrichtenHaupt-SuchseiteSuchkomponenteKomponente „Ergebnisse“Facetten-KomponenteKomponente „Paginierung“

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.

Bereitstellen Amazon Kendra

Anmerkung

Die Funktionsunterstützung variiert je nach Indextyp und verwendeter Such-API. Informationen darüber, ob diese Funktion für den von Ihnen verwendeten Indextyp und die Such-API unterstützt wird, finden Sie unter Indextypen.

Wenn es an der Zeit ist, die Amazon Kendra Suche auf Ihrer Website bereitzustellen, stellen wir Quellcode zur Verfügung, den Sie mit React verwenden können, um Ihrer Anwendung einen Vorsprung zu verschaffen. Der Quellcode wird kostenlos unter einer modifizierten MIT-Lizenz bereitgestellt. Sie können ihn unverändert verwenden oder für Ihre eigenen Bedürfnisse ändern. Die mitgelieferte React-App ist ein Beispiel, das Ihnen den Einstieg erleichtern soll. Es ist keine produktionsreife App.

Informationen zum Bereitstellen einer Suchanwendung ohne Code und zum Generieren einer Endpunkt-URL zu Ihrer Suchseite mit Zugriffskontrolle finden Sie unter Amazon Kendra Experience Builder.

Der folgende Beispielcode fügt einer vorhandenen React-Webanwendung eine Amazon Kendra Suche hinzu:

Die Beispiele sind der Suchseite der Konsole nachempfunden. Amazon Kendra Sie haben dieselben Funktionen für die Suche und Anzeige von Suchergebnissen. Sie können das gesamte Beispiel verwenden oder nur eine der Funktionen für Ihren eigenen Gebrauch auswählen.

Um die drei Komponenten der Suchseite in der Amazon Kendra Konsole zu sehen, wählen Sie im rechten Menü das Codesymbol (</>). Bewegen Sie den Mauszeiger über die einzelnen Abschnitte, um eine kurze Beschreibung der Komponente und die URL der Quelle der Komponente anzuzeigen.

Themen

Übersicht

Sie fügen den Beispielcode zu einer vorhandenen React-Webanwendung hinzu, um die Suche zu aktivieren. Der Beispielcode enthält eine Readme-Datei mit Schritten zum Einrichten einer neuen React-Entwicklungsumgebung. Die Beispieldaten im Codebeispiel können verwendet werden, um eine Suche zu demonstrieren. Die Suchdateien und Komponenten im Beispielcode sind wie folgt strukturiert:

  • Hauptsuchseite (Search.tsx) — Dies ist die Hauptseite, die alle Komponenten enthält. Hier integrieren Sie Ihre Anwendung in die Amazon Kendra API.

  • Suchleiste — Dies ist die Komponente, in der ein Benutzer einen Suchbegriff eingibt und die Suchfunktion aufruft.

  • Ergebnisse — Dies ist die Komponente, von der die Ergebnisse angezeigt werden. Amazon Kendra Sie besteht aus drei Komponenten: Antwortvorschläge, FAQ-Ergebnisse und empfohlene Dokumente.

  • Facetten — Dies ist die Komponente, die die Facetten in den Suchergebnissen anzeigt und es Ihnen ermöglicht, eine Facette auszuwählen, um die Suche einzugrenzen.

  • Paginierung — Dies ist die Komponente, die die Antwort paginiert. Amazon Kendra

Voraussetzungen

Bevor Sie beginnen, muss Folgendes sichergestellt sein:

  • Node.js und npm sind installiert. Node.js Version 19 oder älter ist erforderlich.

  • Python 3 oder Python 2 heruntergeladen und installiert.

  • SDK for Javaoder AWS SDK for JavaScriptum API-Aufrufe zu tätigen Amazon Kendra.

  • Eine bestehende React-Webanwendung. Der Beispielcode enthält eine Readme-Datei mit Schritten zum Einrichten einer neuen React-Entwicklungsumgebung, einschließlich der Verwendung der erforderlichen Frameworks/Bibliotheken. Sie können auch den Schnellstartanweisungen in der React-Dokumentation zur Erstellung einer React-Web-App folgen.

  • Die erforderlichen Bibliotheken und Abhängigkeiten sind in Ihrer Entwicklungsumgebung konfiguriert. Der Beispielcode enthält eine Readme-Datei, in der die erforderlichen Bibliotheken und Paketabhängigkeiten aufgeführt sind. Beachten Sie, dass dies erforderlich sass ist, da node-sass es veraltet ist. Wenn Sie es zuvor installiert habennode-sass, deinstallieren Sie es und installieren Sie es. sass

Das Beispiel einrichten

Ein vollständiges Verfahren zum Hinzufügen einer Amazon Kendra Suche zu einer React-Anwendung finden Sie in der Readme-Datei, die im Codebeispiel enthalten ist.

Um mit der Verwendung kendrasamples-react-app von .zip zu beginnen

  1. Stellen Sie sicher, dass Sie den Vorgang abgeschlossen habenVoraussetzungen, einschließlich des Herunterladens und der Installation von Node.js und npm.

  2. Laden Sie kendrasamples-react-app .zip herunter und entpacken Sie es.

  3. Öffne dein Terminal und gehe zu. aws-kendra-example-react-app/src/services/ Öffnen Sie local-dev-credentials.json und geben Sie Ihre Anmeldeinformationen ein. Fügen Sie diese Datei keinem öffentlichen Repository hinzu.

  4. Gehen Sie zu aws-kendra-example-react-app und installieren Sie die Abhängigkeiten inpackage.json. Führen Sie npm install.

  5. Starten Sie eine Demoversion Ihrer App auf Ihrem lokalen Server. Führen Sie npm start. Sie können den lokalen Server beenden, indem Sie die Eingabe auf Ihrer Tastatur vornehmenCmd/Ctrl + C.

  6. Sie können den Port oder den Host (z. B. die IP-Adresse) ändern, indem Sie zu Host package.json und Port: gehen und dort aktualisieren"start": "HOST=[host] PORT=[port] react-scripts start". Wenn Sie Windows verwenden:"start": "set HOST=[host] && set PORT=[port] && react-scripts start".

  7. Wenn Sie eine registrierte Website-Domain haben, können Sie diese package.json hinter Ihrem App-Namen angeben. Beispiel, "homepage": "https://mywebsite.com". Sie müssen npm install erneut ausführen, um neue Abhängigkeiten zu aktualisieren, und dann ausführennpm start.

  8. Führen Sie den Befehl aus, um die App zu erstellennpm build. Laden Sie den Inhalt des Build-Verzeichnisses auf Ihren Hosting-Anbieter hoch.

    Warnung

    Die React-App ist nicht produktionsbereit. Es ist ein Beispiel für die Bereitstellung einer App für die Amazon Kendra Suche.

Haupt-Suchseite

Die Hauptsuchseite (Search.tsx) enthält alle Beispiel-Suchkomponenten. Sie umfasst die Suchleistenkomponente für die Ausgabe, die Ergebniskomponenten zur Anzeige der Antwort aus der Abfrage-API und eine Seitennummerierungskomponente zum Durchblättern der Antwort.

Suchkomponente

Die Suchkomponente bietet ein Textfeld zur Eingabe von Abfragetext. Die onSearch Funktion ist ein Hook, der die Hauptfunktion aufruftSearch.tsx, um den Amazon Kendra Abfrage-API-Aufruf durchzuführen.

Komponente „Ergebnisse“

Die Ergebniskomponente zeigt die Antwort der Query API. Die Ergebnisse werden in drei separaten Bereichen angezeigt.

  • Vorgeschlagene Antworten — Dies sind die besten Ergebnisse, die von der API zurückgegeben wurden. Query Sie enthält bis zu drei Antwortvorschläge. In der Antwort haben sie den ErgebnistypANSWER.

  • Antworten auf häufig gestellte Fragen — Dies sind die Ergebnisse mit häufig gestellten Fragen, die in der Antwort zurückgegeben wurden. FAQs werden dem Index separat hinzugefügt. In der Antwort haben sie den TypQUESTION_ANSWER. Weitere Informationen finden Sie unter Fragen und Antworten.

  • Empfohlene Dokumente — Dies sind zusätzliche Dokumente, die in der Amazon Kendra Antwort zurückgegeben werden. In der Antwort von der Query API haben sie den Typ. DOCUMENT

Die Ergebniskomponenten teilen sich eine Reihe von Komponenten für Funktionen wie Hervorhebungen, Titel, Links und mehr. Die gemeinsam genutzten Komponenten müssen vorhanden sein, damit die Ergebniskomponenten funktionieren.

Facetten-Komponente

Die Facettenkomponente listet die in den Suchergebnissen verfügbaren Facetten auf. Jede Facette klassifiziert die Antwort nach einer bestimmten Dimension, z. B. nach dem Autor. Sie können die Suche auf eine bestimmte Facette eingrenzen, indem Sie eine Facette aus der Liste auswählen.

Nachdem Sie eine Facette ausgewählt haben, wird die Komponente Query mit einem Attributfilter aufgerufen, der die Suche auf Dokumente beschränkt, die der Facette entsprechen.

Komponente „Paginierung“

Mit der Paginierungskomponente können Sie die Suchergebnisse der Query API auf mehreren Seiten anzeigen. Sie ruft die Query API mit den PageNumber Parametern PageSize und auf, um eine bestimmte Ergebnisseite abzurufen.