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](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index-types.html).
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](https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).
L'exemple de code suivant ajoute une Amazon Kendra recherche à une application Web React existante :
+ [https://kendrasamples.s3.amazonaws.com/kendrasamples-react-app.zip](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.
**Topics**
+ [Présentation de](#example-overview)
+ [Conditions préalables](#example-prereqs)
+ [Configuration de l'exemple](#example-install)
+ [Page de recherche principale](#main-component)
+ [Composant de recherche](#search-component)
+ [Composante des résultats](#results-component)
+ [Composant Facettes](#facets-component)
+ [Composant de pagination](#pagination-component)
+ [Création d'une expérience de recherche sans code](deploying-search-experience-no-code.md)
## Présentation de
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
## Conditions préalables
Avant de commencer, vous avez besoin de ce qui suit :
+ Node.js et npm [installés.](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) La version 19 ou antérieure de Node.js est requise.
+ Python 3 ou Python 2 [téléchargé et installé](https://www.python.org/downloads/).
+ [SDK pour Java](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/setup.html)ou [AWS SDK pour JavaScript](https://docs.aws.amazon.com/sdk-for-javascript/latest/developer-guide/welcome.html)pour 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](https://create-react-app.dev/docs/getting-started).
+ 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 `sass` est obligatoire, car cela `node-sass` est obsolète. Si vous l'avez déjà installé`node-sass`, désinstallez-le et installez-le`sass`.
## 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**
1. Assurez-vous d'avoir terminé le[Conditions préalables](#example-prereqs), y compris le téléchargement et l'installation de Node.js et de npm.
1. Téléchargez le kendrasamples-react-app fichier .zip et décompressez-le.
1. Ouvrez votre terminal et accédez à`aws-kendra-example-react-app/src/services/`. Ouvrez `local-dev-credentials.json` et saisissez vos informations d'identification. N'ajoutez ce fichier à aucun dépôt public.
1. Accédez à `aws-kendra-example-react-app` et installez les dépendances dans`package.json`. Exécutez `npm install`.
1. 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 clavier`Cmd/Ctrl + C`.
1. Vous pouvez modifier le port ou l'hôte (par exemple, l'adresse IP) en accédant à `package.json` et 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"`.
1. Si vous avez un domaine de site Web enregistré, vous pouvez le spécifier `package.json` après le nom de votre application. Par exemple, `"homepage": "https://mywebsite.com"`. Vous devez exécuter à `npm install` nouveau pour mettre à jour les nouvelles dépendances, puis exécuter`npm start`.
1. 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 pour Amazon Kendra la 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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html) 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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html).
## Composante des résultats
Le composant de résultats affiche la réponse de l'`Query`API. 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'`Query`API. Il contient jusqu'à trois suggestions de réponses. Dans la réponse, ils ont le type de résultat`ANSWER`.
+ 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](https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html).
+ Documents recommandés : il s'agit de documents supplémentaires Amazon Kendra renvoyés dans la réponse. Dans la réponse de l'`Query`API, ils ont le type`DOCUMENT`.
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 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'`Query`API sur plusieurs pages. Il appelle l'`Query`API avec les `PageNumber` paramètres `PageSize` et pour obtenir une page de résultats spécifique.
# Création d'une expérience de recherche sans code
Vous pouvez créer et déployer une application Amazon Kendra de recherche sans avoir besoin de code frontal. Amazon Kendra *Experience Builder* vous aide à créer et à déployer une application de recherche entièrement fonctionnelle en quelques clics afin que vous puissiez commencer à rechercher immédiatement. Vous pouvez personnaliser votre page de recherche et ajuster votre recherche pour adapter l'expérience aux besoins de vos utilisateurs. Amazon Kendra génère une URL de point de terminaison unique et entièrement hébergée de votre page de recherche pour commencer à rechercher vos documents et FAQs. Vous pouvez rapidement établir une preuve de concept de votre expérience de recherche et la partager avec d'autres personnes.
Vous utilisez le modèle d'expérience de recherche disponible dans le générateur pour personnaliser votre recherche. Vous pouvez inviter d'autres personnes à collaborer au développement de votre expérience de recherche ou à évaluer les résultats de recherche à des fins d'optimisation. Une fois que votre expérience de recherche est prête pour que vos utilisateurs puissent commencer à effectuer des recherches, il vous suffit de partager l'URL sécurisée du point de terminaison.
## Fonctionnement du moteur de recherche Experience Builder
Le processus global de création d'une expérience de recherche est le suivant :
1. Vous créez votre expérience de recherche en lui attribuant un nom, une description et en choisissant les sources de données que vous souhaitez utiliser pour votre expérience de recherche.
1. Vous configurez votre liste d'utilisateurs et de groupes, AWS IAM Identity Center puis vous leur attribuez des droits d'accès à votre expérience de recherche. Vous vous incluez en tant que propriétaire de l'expérience. Pour de plus amples informations, veuillez consulter [Fournir un accès à votre page de recherche](#access-search-experience).
1. Vous ouvrez l' Amazon Kendra Experience Builder pour concevoir et ajuster votre page de recherche. Vous pouvez partager l'URL de votre point de terminaison correspondant à votre expérience de recherche avec d'autres personnes à qui vous attribuez des droits d'accès de modification ou des droits d'accès de consultation et de recherche.
Vous appelez l'[CreateExperience](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateExperience.html)API pour créer et configurer votre expérience de recherche. Si vous utilisez la console, vous sélectionnez votre index, puis **Experiences** dans le menu de navigation pour configurer votre expérience.
## Concevez et optimisez votre expérience de recherche
Une fois que vous avez créé et configuré votre expérience de recherche, vous l'ouvrez à l'aide d'une URL de point de terminaison pour commencer à personnaliser votre recherche en tant que propriétaire disposant de droits d'accès aux éditeurs. Vous tapez votre requête dans le champ de recherche, puis vous personnalisez votre recherche à l'aide des options d'édition du panneau latéral pour voir comment elles s'appliquent à votre page. Lorsque vous êtes prêt à publier, sélectionnez **Publier**. Vous pouvez également basculer entre le mode **Live View**, pour afficher la dernière version publiée de votre page de recherche, et le **Basculer en mode build**, pour modifier ou personnaliser votre page de recherche.
Les méthodes suivantes vous permettent de personnaliser votre expérience de recherche.
### Filtre
Ajoutez une recherche à facettes ou filtrez par attributs de document. Cela inclut les attributs personnalisés. Vous pouvez ajouter un filtre à l'aide de vos propres champs de métadonnées configurés. Par exemple, pour effectuer une recherche par facettes par catégorie de ville, utilisez un attribut de document `_category` personnalisé qui contient toutes les catégories de villes.
### Réponse suggérée
Ajoutez des réponses générées par le machine learning aux requêtes de vos utilisateurs. Par exemple, *« Quelle est la difficulté de ce cours ? »* . Amazon Kendra peut récupérer le texte le plus pertinent parmi tous les documents faisant référence à la difficulté d'un cours et suggérer la réponse la plus pertinente.
### FAQ
Ajoutez un document FAQ pour répondre aux questions fréquemment posées. Par exemple, *« Combien d'heures pour suivre ce cours ? »* . Amazon Kendra peut utiliser le document FAQ contenant la réponse à cette question et donner la bonne réponse.
### Tri
Ajoutez le tri des résultats de recherche afin que vos utilisateurs puissent organiser les résultats par pertinence, date de création, date de dernière mise à jour et autres critères de tri.
### Documents
Configurez le mode d'affichage des documents ou des résultats de recherche sur votre page de recherche. Vous pouvez configurer le nombre de résultats affichés sur la page, inclure une pagination telle que les numéros de page, activer un bouton de commentaires utilisateur et organiser la manière dont les champs de métadonnées des documents sont affichés dans un résultat de recherche.
### Language
Sélectionnez une langue pour filtrer les résultats de recherche ou les documents dans la langue sélectionnée.
### Boîte de recherche
Configurez la taille et le texte de remplacement de votre champ de recherche, et autorisez les suggestions de requêtes.
### Réglage de la pertinence
Renforcez les champs de métadonnées des documents pour donner plus de poids à ces champs lorsque vos utilisateurs recherchent des documents. Vous pouvez ajouter un poids qui commence à 1 et augmente progressivement jusqu'à 10. Vous pouvez améliorer les types de champs texte, de date et numériques. Par exemple, pour donner `_created_at` plus `_last_updated_at` de poids ou d'importance qu'aux autres champs, attribuez-leur une pondération de 1 à 10, en fonction de leur importance. Vous pouvez appliquer différentes configurations de réglage de la pertinence pour chaque application ou expérience de recherche.
## Fournir un accès à votre page de recherche
L'accès à votre expérience de recherche se fait via IAM Identity Center. Lorsque vous configurez votre expérience de recherche, vous autorisez les autres personnes répertoriées dans votre répertoire Identity Center à accéder à votre page Amazon Kendra de recherche. Ils reçoivent un e-mail leur demandant de se connecter à l'aide de leurs informations d'identification dans IAM Identity Center pour accéder à la page de recherche. Vous devez configurer IAM Identity Center au niveau de l'organisation ou du titulaire du compte dans AWS Organizations. Pour plus d'informations sur la configuration d'IAM Identity Center, consultez [Getting started with IAM Identity](https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html) Center.
Vous activez les identités des utilisateurs dans IAM Identity Center en fonction de votre expérience de recherche et vous attribuez des autorisations d'accès au *Viewer* ou au *Owner* à l'aide de l'API ou de la console.
+ **Afficheur** : autorisé à émettre des requêtes, à recevoir des suggestions de réponses pertinentes pour sa recherche et à apporter ses commentaires Amazon Kendra afin d'améliorer continuellement la recherche.
+ **Propriétaire** : autorisé à personnaliser le design de la page de recherche, à ajuster la recherche et à utiliser l'application de recherche en tant que *visualiseur*. La désactivation de l'accès aux spectateurs dans la console n'est actuellement pas prise en charge.
Pour autoriser d'autres personnes à accéder à votre expérience de recherche, vous devez d'abord activer les identités des utilisateurs dans IAM Identity Center en fonction de votre Amazon Kendra expérience en utilisant l'[ExperienceConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ExperienceConfiguration.html)objet. Vous spécifiez le nom du champ qui contient les identifiants de vos utilisateurs, tels que le nom d'utilisateur ou l'adresse e-mail. Vous autorisez ensuite votre liste d'utilisateurs à accéder à votre expérience de recherche à l'aide de l'[AssociateEntitiesToExperience](https://docs.aws.amazon.com/kendra/latest/APIReference/API_AssociateEntitiesToExperience.html)API et définissez leurs autorisations en tant que *Viewer* ou *Owner* à l'aide de l'[AssociatePersonasToEntities](https://docs.aws.amazon.com/kendra/latest/APIReference/API_AssociatePersonasToEntities.html)API. Vous spécifiez chaque utilisateur ou groupe utilisant l'[EntityConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_EntityConfiguration.html)objet et indiquez si cet utilisateur ou ce groupe est un *visualiseur* ou un *propriétaire* utilisant l'[EntityPersonaConfiguraton](https://docs.aws.amazon.com/kendra/latest/APIReference/API_EntityPersonaConfiguration.html)objet.
Pour autoriser d'autres personnes à accéder à votre expérience de recherche à l'aide de la console, vous devez d'abord créer une expérience, confirmer votre identité et confirmer que vous êtes propriétaire. Vous pouvez ensuite désigner d'autres utilisateurs ou groupes en tant que spectateurs ou propriétaires. Dans la console, sélectionnez votre index, puis sélectionnez **Expériences** dans le menu de navigation. Après avoir créé votre expérience, vous pouvez la sélectionner dans la liste. Accédez à **Gestion des accès** pour attribuer des utilisateurs ou des groupes en tant que spectateurs ou propriétaires.
## Configuration d'une expérience de recherche
Voici un exemple de configuration ou de création d'une expérience de recherche.
------
#### [ Console ]
**Pour créer une expérience Amazon Kendra de recherche**
1. Dans le volet de navigation de gauche, sous **Indexes**, sélectionnez **Expériences**, puis sélectionnez **Créer une expérience**.
1. Sur la page **Configurer l'expérience**, entrez le nom et la description de votre expérience, choisissez vos sources de contenu et choisissez le rôle IAM pour votre expérience. Pour plus d'informations sur les rôles IAM, consultez la section Rôles [IAM pour Amazon Kendra les expériences](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
1. Sur la page **Confirmez votre identité à partir d'un annuaire Identity Center**, sélectionnez votre nom d'utilisateur tel que votre adresse e-mail. Si vous n'avez pas de répertoire Identity Center, entrez simplement votre nom complet et votre adresse e-mail pour créer un annuaire Identity Center. Cela vous inclut en tant qu'utilisateur de l'expérience et vous attribue automatiquement les droits d'accès de propriétaire.
1. Sur la page **Vérifier pour ouvrir Experience Builder**, passez en revue les détails de votre configuration, sélectionnez **Créer une expérience et ouvrez Experience Builder** pour commencer à modifier votre page de recherche.
------
#### [ CLI ]
**Pour créer une Amazon Kendra expérience**
```
aws kendra create-experience \
--name experience-name \
--description "experience description" \
--index-id index-id \
--role-arn arn:aws:iam::account-id:role/role-name \
--configuration '{"ExperienceConfiguration":[{"ContentSourceConfiguration":{"DataSourceIds":["data-source-1","data-source-2"]}, "UserIdentityConfiguration":"identity attribute name"}]}'
aws kendra describe-experience \
--endpoints experience-endpoint-URL(s)
```
------
#### [ Python ]
**Pour créer une Amazon Kendra expérience**
```
import boto3
from botocore.exceptions import ClientError
import pprint
import time
kendra = boto3.client("kendra")
print("Create an experience.")
# Provide a name for the experience
name = "experience-name"
# Provide an optional description for the experience
description = "experience description"
# Provide the index ID for the experience
index_id = "index-id"
# Provide the IAM role ARN required for Amazon Kendra experiences
role_arn = "arn:aws:iam::${account-id}:role/${role-name}"
# Configure the experience
configuration = {"ExperienceConfiguration":
[{
"ContentSourceConfiguration":{"DataSourceIds":["data-source-1","data-source-2"]},
"UserIdentityConfiguration":"identity attribute name"
}]
}
try:
experience_response = kendra.create_experience(
Name = name,
Description = description,
IndexId = index_id,
RoleArn = role_arn,
Configuration = configuration
)
pprint.pprint(experience_response)
experience_endpoints = experience_response["Endpoints"]
print("Wait for Amazon Kendra to create the experience.")
while True:
# Get the details of the experience, such as the status
experience_description = kendra.describe_experience(
Endpoints = experience_endpoints
)
status = experience_description["Status"]
print(" Creating experience. Status: "+status)
time.sleep(60)
if status != "CREATING":
break
except ClientError as e:
print("%s" % e)
print("Program ends.")
```
------
#### [ Java ]
**Pour créer un Amazon Kendra**
```
package com.amazonaws.kendra;
import java.util.concurrent.TimeUnit;
import software.amazon.awssdk.services.kendra.KendraClient;
import software.amazon.awssdk.services.kendra.model.CreateExperienceRequest;
import software.amazon.awssdk.services.kendra.model.CreateExperienceResponse;
import software.amazon.awssdk.services.kendra.model.DescribeExperienceRequest;
import software.amazon.awssdk.services.kendra.model.DescribeExperienceResponse;
import software.amazon.awssdk.services.kendra.model.ExperienceStatus;
public class CreateExperienceExample {
public static void main(String[] args) throws InterruptedException {
System.out.println("Create an experience");
String experienceName = "experience-name";
String experienceDescription = "experience description";
String indexId = "index-id";
String experienceRoleArn = "arn:aws:iam::account-id:role/role-name";
KendraClient kendra = KendraClient.builder().build();
CreateExperienceRequest createExperienceRequest = CreateExperienceRequest
.builder()
.name(experienceName)
.description(experienceDescription)
.roleArn(experienceRoleArn)
.configuration(
ExperienceConfiguration
.builder()
.contentSourceConfiguration(
ContentSourceConfiguration(
.builder()
.dataSourceIds("data-source-1","data-source-2")
.build()
)
)
.userIdentityConfiguration(
UserIdentityConfiguration(
.builder()
.identityAttributeName("identity-attribute-name")
.build()
)
).build()
).build();
CreateExperienceResponse createExperienceResponse = kendra.createExperience(createExperienceRequest);
System.out.println(String.format("Experience response %s", createExperienceResponse));
String experienceEndpoints = createExperienceResponse.endpoints();
System.out.println(String.format("Wait for Kendra to create the experience.", experienceEndpoints));
while (true) {
DescribeExperienceRequest describeExperienceRequest = DescribeExperienceRequest.builder().endpoints(experienceEndpoints).build();
DescribeExperienceResponse describeEpxerienceResponse = kendra.describeExperience(describeExperienceRequest);
ExperienceStatus status = describeExperienceResponse.status();
TimeUnit.SECONDS.sleep(60);
if (status != ExperienceStatus.CREATING) {
break;
}
}
System.out.println("Experience creation is complete.");
}
}
```
------