Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Déploiement Amazon Kendra
Note
La prise en charge des fonctionnalités varie en fonction du type d'index et de l'API de recherche utilisés. Pour savoir si cette fonctionnalité est prise en charge pour le type d'index et l'API de recherche que vous utilisez, consultez la section Types d'index.
Lorsque vient le temps de déployer Amazon Kendra la recherche sur votre site Web, nous fournissons le code source que vous pouvez utiliser avec React pour prendre une longueur d'avance sur votre application. Le code source est fourni gratuitement dans le cadre d'une licence MIT modifiée. Vous pouvez l'utiliser tel quel ou le modifier selon vos propres besoins. L'application React fournie est un exemple pour vous aider à démarrer. Il ne s'agit pas d'une application prête pour la production.
Pour déployer une application de recherche sans code et générer une URL de point de terminaison vers votre page de recherche avec contrôle d'accès, consultez Amazon Kendra Experience Builder.
L'exemple de code suivant ajoute une Amazon Kendra recherche à une application Web React existante :
-
https://kendrasamples.s3.amazonaws.com/kendrasamples-react-app.zip
—Exemples de fichiers que les développeurs peuvent utiliser pour créer une expérience de recherche fonctionnelle dans leur application Web React existante.
Les exemples sont calqués sur la page de recherche de la Amazon Kendra console. Ils ont les mêmes fonctionnalités de recherche et d'affichage des résultats de recherche. Vous pouvez utiliser l'exemple dans son intégralité ou choisir une seule des fonctionnalités pour votre usage personnel.
Pour afficher les trois composants de la page de recherche dans la Amazon Kendra console, choisissez l'icône du code (</>) dans le menu de droite. Passez le pointeur sur chaque section pour voir une brève description du composant et pour obtenir l'URL de la source du composant.
Rubriques
Présentation
Vous ajoutez l'exemple de code à une application Web React existante pour activer la recherche. L'exemple de code inclut un fichier Readme avec les étapes à suivre pour configurer un nouvel environnement de développement React. Les données d'exemple contenues dans l'exemple de code peuvent être utilisées pour illustrer une recherche. Les fichiers et composants de recherche de l'exemple de code sont structurés comme suit :
-
Page de recherche principale (
Search.tsx) : il s'agit de la page principale qui contient tous les composants. C'est ici que vous intégrez votre application à l' Amazon Kendra API. -
Barre de recherche : il s'agit du composant dans lequel un utilisateur saisit un terme de recherche et appelle la fonction de recherche.
-
Résultats : il s'agit du composant qui affiche les résultats de. Amazon Kendra Il comporte trois éléments : les réponses suggérées, les résultats des FAQ et les documents recommandés.
-
Facettes : il s'agit du composant qui affiche les facettes dans les résultats de recherche et vous permet de choisir une facette pour affiner la recherche.
-
Pagination : il s'agit du composant à partir duquel la réponse est paginée. Amazon Kendra
Prérequis
Avant de commencer, vous avez besoin de ce qui suit :
-
Node.js et npm installés.
La version 19 ou antérieure de Node.js est requise. -
Python 3 ou Python 2 téléchargé et installé
. -
SDK for Javaou AWS SDK for JavaScriptpour effectuer des appels d'API à Amazon Kendra.
-
Une application Web React existante. L'exemple de code inclut un fichier Readme avec les étapes à suivre pour configurer un nouvel environnement de développement React, notamment en utilisant les frameworks/bibliothèques requis. Vous pouvez également suivre les instructions de démarrage rapide de la documentation React sur la création d'une application Web React
. -
Les bibliothèques et dépendances requises sont configurées dans votre environnement de développement. L'exemple de code inclut un fichier Readme qui répertorie les bibliothèques requises et les dépendances des packages. Notez que cela
sassest obligatoire, car celanode-sassest obsolète. Si vous l'avez déjà installénode-sass, désinstallez-le et installez-lesass.
Configuration de l'exemple
Une procédure complète pour ajouter une Amazon Kendra recherche à une application React se trouve dans le fichier Readme inclus dans l'exemple de code.
Pour commencer à utiliser le kendrasamples-react-app fichier .zip
-
Assurez-vous d'avoir terminé lePrérequis, y compris le téléchargement et l'installation de Node.js et de npm.
-
Téléchargez le kendrasamples-react-app fichier .zip et décompressez-le.
-
Ouvrez votre terminal et accédez à
aws-kendra-example-react-app/src/services/. Ouvrezlocal-dev-credentials.jsonet saisissez vos informations d'identification. N'ajoutez ce fichier à aucun dépôt public. -
Accédez à
aws-kendra-example-react-appet installez les dépendances danspackage.json. Exécuteznpm install. -
Lancez une version de démonstration de votre application sur votre serveur local. Exécutez
npm start. Vous pouvez arrêter le serveur local en tapant sur votre clavierCmd/Ctrl + C. -
Vous pouvez modifier le port ou l'hôte (par exemple, l'adresse IP) en accédant à
package.jsonet en mettant à jour l'hôte et le port :"start": "HOST=[host] PORT=[port] react-scripts start". Si vous utilisez Windows :"start": "set HOST=[host] && set PORT=[port] && react-scripts start". -
Si vous avez un domaine de site Web enregistré, vous pouvez le spécifier
package.jsonaprès le nom de votre application. Par exemple,"homepage": "https://mywebsite.com". Vous devez exécuter ànpm installnouveau pour mettre à jour les nouvelles dépendances, puis exécuternpm start. -
Pour créer l'application, exécutez
npm build. Téléchargez le contenu du répertoire de construction sur votre fournisseur d'hébergement.Avertissement
L'application React n'est pas prête pour la production. Il s'agit d'un exemple de déploiement d'une application à des fins Amazon Kendra de recherche.
Page de recherche principale
La page de recherche principale (Search.tsx) contient tous les exemples de composants de recherche. Il inclut le composant de barre de recherche pour la sortie, les composants de résultats pour afficher la réponse de l'API Query et un composant de pagination pour parcourir la réponse.
Composant de recherche
Le composant de recherche fournit une zone de texte pour saisir le texte de la requête. La onSearch fonction est un hook qui appelle la fonction principale Search.tsx pour effectuer l'appel de l'API Amazon Kendra
Query.
Composante des résultats
Le composant de résultats affiche la réponse de l'QueryAPI. Les résultats sont présentés dans trois zones distinctes.
-
Réponses suggérées : il s'agit des meilleurs résultats renvoyés par l'
QueryAPI. Il contient jusqu'à trois suggestions de réponses. Dans la réponse, ils ont le type de résultatANSWER. -
Réponses aux FAQ : il s'agit des réponses aux questions fréquemment posées renvoyées par la réponse. FAQs sont ajoutés à l'index séparément. Dans la réponse, ils ont le type
QUESTION_ANSWER. Pour plus d'informations, consultez la section Questions et réponses. -
Documents recommandés : il s'agit de documents supplémentaires Amazon Kendra renvoyés dans la réponse. Dans la réponse de l'
QueryAPI, ils ont le typeDOCUMENT.
Les composants des résultats partagent un ensemble de composants pour des fonctionnalités telles que le surlignage, les titres, les liens, etc. Les composants partagés doivent être présents pour que les composants du résultat fonctionnent.
Composant Facettes
Le composant facettes répertorie les facettes disponibles dans les résultats de recherche. Chaque facette classe la réponse selon une dimension spécifique, telle que l'auteur. Vous pouvez affiner la recherche sur une facette spécifique en en choisissant une option dans la liste.
Une fois que vous avez sélectionné une facette, le composant appelle Query avec un filtre d'attributs qui limite la recherche aux documents correspondant à cette facette.
Composant de pagination
Le composant de pagination vous permet d'afficher les résultats de recherche de l'QueryAPI sur plusieurs pages. Il appelle l'QueryAPI avec les PageNumber paramètres PageSize et pour obtenir une page de résultats spécifique.
