Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
# Implementazione Amazon Kendra
**Nota**
Il supporto delle funzionalità varia in base al tipo di indice e all'API di ricerca utilizzata. Per verificare se questa funzionalità è supportata per il tipo di indice e l'API di ricerca che stai utilizzando, consulta [Tipi di indice](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index-types.html).
Quando arriva il momento di implementare la Amazon Kendra ricerca sul tuo sito web, forniamo il codice sorgente che puoi usare con React per iniziare a usare la tua applicazione con un vantaggio. Il codice sorgente viene fornito gratuitamente con una licenza MIT modificata. È possibile utilizzarlo così com'è o modificarlo in base alle proprie esigenze. L'app React fornita è un esempio per aiutarti a iniziare. Non è un'app pronta per la produzione.
Per distribuire un'applicazione di ricerca senza codice e generare un URL endpoint per la pagina di ricerca con controllo degli accessi, consulta [Amazon Kendra Experience](https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html) Builder.
Il codice di esempio seguente aggiunge la Amazon Kendra ricerca a un'applicazione web React esistente:
+ [https://kendrasamples.s3.amazonaws.com/kendrasamples-react-app.zip](https://kendrasamples.s3.amazonaws.com/kendrasamples-react-app.zip): file di esempio che gli sviluppatori possono utilizzare per creare un'esperienza di ricerca funzionale nella loro applicazione web React esistente.
Gli esempi sono modellati sulla pagina di ricerca della console. Amazon Kendra Hanno le stesse funzionalità per la ricerca e la visualizzazione dei risultati della ricerca. È possibile utilizzare l'intero esempio oppure scegliere solo una delle funzionalità per uso personale.
Per visualizzare i tre componenti della pagina di ricerca nella Amazon Kendra console, scegli l'icona del codice (****) dal menu a destra. Passa il puntatore su ogni sezione per visualizzare una breve descrizione del componente e per ottenere l'URL della fonte del componente.
**Topics**
+ [Panoramica di](#example-overview)
+ [Prerequisiti](#example-prereqs)
+ [Configurazione dell'esempio](#example-install)
+ [Pagina di ricerca principale](#main-component)
+ [Componente di ricerca](#search-component)
+ [Componente dei risultati](#results-component)
+ [Componente Facets](#facets-component)
+ [Componente di impaginazione](#pagination-component)
+ [Creazione di un'esperienza di ricerca senza codice](deploying-search-experience-no-code.md)
## Panoramica di
Aggiungi il codice di esempio a un'applicazione web React esistente per attivare la ricerca. Il codice di esempio include un file Readme con i passaggi per configurare un nuovo ambiente di sviluppo React. I dati di esempio contenuti nell'esempio di codice possono essere utilizzati per dimostrare una ricerca. I file di ricerca e i componenti nel codice di esempio sono strutturati come segue:
+ Pagina di ricerca principale (`Search.tsx`): questa è la pagina principale che contiene tutti i componenti. Qui puoi integrare la tua applicazione con l' Amazon Kendra API.
+ Barra di ricerca: questo è il componente in cui un utente inserisce un termine di ricerca e richiama la funzione di ricerca.
+ Risultati: questo è il componente da cui vengono visualizzati i risultati. Amazon Kendra Ha tre componenti: risposte suggerite, risultati delle domande frequenti e documenti consigliati.
+ Sfaccettature: questo è il componente che mostra le sfaccettature nei risultati della ricerca e consente di scegliere una sfaccettatura per restringere la ricerca.
+ Impaginazione: questo è il componente da cui viene impaginata la risposta. Amazon Kendra
## Prerequisiti
Prima di iniziare, avrai bisogno di:
+ Node.js e [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) installati. È richiesta la versione 19 o precedente di Node.js.
+ [Python 3 o Python 2 scaricato e installato.](https://www.python.org/downloads/)
+ [SDK per Java](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/setup.html)o [AWS SDK per JavaScript](https://docs.aws.amazon.com/sdk-for-javascript/latest/developer-guide/welcome.html)per effettuare chiamate API a. Amazon Kendra
+ Un'applicazione web React esistente. Il codice di esempio include un file Readme con i passaggi su come configurare un nuovo ambiente di sviluppo React, incluso l'utilizzo di framework/librerie richiesti. Puoi anche seguire le istruzioni di avvio rapido nella [documentazione di React sulla creazione di un'app web React](https://create-react-app.dev/docs/getting-started).
+ Le librerie e le dipendenze richieste configurate nel tuo ambiente di sviluppo. Il codice di esempio include un file Readme che elenca le librerie e le dipendenze dei pacchetti richieste. Nota che `sass` è obbligatorio, in quanto obsoleto`node-sass`. Se l'hai installato in precedenza`node-sass`, disinstallalo e installa. `sass`
## Configurazione dell'esempio
Una procedura completa per aggiungere la Amazon Kendra ricerca a un'applicazione React si trova nel file Readme incluso nell'esempio di codice.
**Per iniziare a usare .zip kendrasamples-react-app**
1. Assicurati di aver completato[Prerequisiti](#example-prereqs), incluso il download e l'installazione di Node.js e npm.
1. Scaricate il kendrasamples-react-app file.zip e decomprimetelo.
1. Apri il tuo terminale e vai a. `aws-kendra-example-react-app/src/services/` Apri `local-dev-credentials.json` e inserisci le tue credenziali. Non aggiungete questo file a nessun archivio pubblico.
1. Vai a `aws-kendra-example-react-app` e installa le dipendenze in. `package.json` Esegui `npm install`.
1. Avvia una versione demo della tua app sul tuo server locale. Esegui `npm start`. Puoi fermare il server locale accedendo alla tastiera`Cmd/Ctrl + C`.
1. Puoi cambiare la porta o l'host (ad esempio, l'indirizzo IP) accedendo `package.json` e aggiornando l'host e la porta:`"start": "HOST=[host] PORT=[port] react-scripts start"`. Se usi Windows:`"start": "set HOST=[host] && set PORT=[port] && react-scripts start"`.
1. Se hai un dominio del sito web registrato, puoi specificarlo `package.json` dopo il nome della tua app. Ad esempio, `"homepage": "https://mywebsite.com"`. È necessario eseguire `npm install` nuovamente l'operazione per aggiornare le nuove dipendenze, quindi eseguire`npm start`.
1. Per creare l'app, `npm build` esegui. Carica il contenuto della directory di compilazione sul tuo provider di hosting.
**avvertimento**
L'app React **non** è pronta per la produzione. È un esempio di implementazione di un'app per la Amazon Kendra ricerca.
## Pagina di ricerca principale
La pagina di ricerca principale (`Search.tsx`) contiene tutti i componenti di ricerca di esempio. Include il componente della barra di ricerca per l'output, i componenti dei risultati per visualizzare la risposta dell'API [Query](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html) e un componente di impaginazione per sfogliare la risposta.
## Componente di ricerca
Il componente di ricerca fornisce una casella di testo per inserire il testo della query. La `onSearch` funzione è un hook che richiama la funzione principale `Search.tsx` per effettuare la chiamata all'API Amazon Kendra [Query](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html).
## Componente dei risultati
Il componente dei risultati mostra la risposta dell'`Query`API. I risultati sono mostrati in tre aree separate.
+ Risposte suggerite: questi sono i migliori risultati restituiti dall'API. `Query` Contiene fino a tre risposte suggerite. Nella risposta, hanno il tipo di risultato`ANSWER`.
+ Risposte alle domande frequenti: questi sono i risultati delle domande frequenti restituiti dalla risposta. FAQs vengono aggiunti all'indice separatamente. Nella risposta, hanno il tipo`QUESTION_ANSWER`. Per ulteriori informazioni, vedere [Domande e risposte](https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html).
+ Documenti consigliati: si tratta di documenti aggiuntivi che vengono Amazon Kendra restituiti nella risposta. Nella risposta dell'`Query`API, hanno il tipo. `DOCUMENT`
I componenti dei risultati condividono un set di componenti per funzionalità come l'evidenziazione, i titoli, i collegamenti e altro ancora. I componenti condivisi devono essere presenti affinché i componenti dei risultati funzionino.
## Componente Facets
Il componente sfaccettature elenca le sfaccettature disponibili nei risultati della ricerca. Ogni sfaccettatura classifica la risposta in base a una dimensione specifica, ad esempio l'autore. Puoi affinare la ricerca a un aspetto specifico scegliendone uno dall'elenco.
Dopo aver selezionato un facet, il componente richiama un filtro `Query` di attributi che limita la ricerca ai documenti che corrispondono al facet.
## Componente di impaginazione
Il componente di impaginazione consente di visualizzare i risultati della ricerca dall'`Query`API in più pagine. Richiama l'`Query`API con i `PageNumber` parametri `PageSize` and per ottenere una pagina specifica di risultati.
# Creazione di un'esperienza di ricerca senza codice
Puoi creare e distribuire un'applicazione di Amazon Kendra ricerca senza la necessità di alcun codice front-end. Amazon Kendra *Experience Builder* ti aiuta a creare e distribuire un'applicazione di ricerca completamente funzionale in pochi clic, in modo da poter iniziare subito a cercare. Puoi personalizzare la tua pagina di ricerca e ottimizzare la ricerca per adattare l'esperienza alle esigenze degli utenti. Amazon Kendra genera un URL endpoint unico e completamente ospitato della pagina di ricerca per iniziare a cercare i documenti e. FAQs Puoi creare rapidamente una prova di fattibilità della tua esperienza di ricerca e condividerla con altri.
Per personalizzare la ricerca, utilizzi il modello di esperienza di ricerca disponibile nel generatore. Puoi invitare altre persone a collaborare alla creazione della tua esperienza di ricerca o valutare i risultati della ricerca per ottimizzarli. Una volta che l'esperienza di ricerca è pronta per consentire agli utenti di iniziare la ricerca, è sufficiente condividere l'URL sicuro dell'endpoint.
## Come funziona il Search Experience Builder
Il processo complessivo di creazione di un'esperienza di ricerca è il seguente:
1. Puoi creare la tua esperienza di ricerca assegnandole un nome, una descrizione e scegliendo le fonti di dati che desideri utilizzare per la tua esperienza di ricerca.
1. Configurate l'elenco di utenti e gruppi in AWS IAM Identity Center e poi assegnate loro i diritti di accesso alla vostra esperienza di ricerca. Includi te stesso come proprietario dell'esperienza. Per ulteriori informazioni, consulta [Fornire l'accesso alla pagina di ricerca](#access-search-experience).
1. Apri Amazon Kendra Experience Builder per progettare e ottimizzare la tua pagina di ricerca. Puoi condividere l'URL dell'endpoint della tua esperienza di ricerca con altri a cui assegnare diritti di accesso propri per la modifica o per la visualizzazione della ricerca.
Chiamate l'[CreateExperience](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateExperience.html)API per creare e configurare la vostra esperienza di ricerca. Se usi la console, seleziona il tuo indice, quindi seleziona **Esperienze** nel menu di navigazione per configurare la tua esperienza.
## Progetta e ottimizza la tua esperienza di ricerca
Dopo aver creato e configurato l'esperienza di ricerca, apri l'esperienza di ricerca utilizzando un URL dell'endpoint per iniziare a personalizzare la ricerca in qualità di proprietario con diritti di accesso all'editor. Digiti la query nella casella di ricerca, quindi personalizza la ricerca utilizzando le opzioni di modifica sul pannello laterale per vedere come si applicano alla tua pagina. Quando sei pronto per la pubblicazione, seleziona **Pubblica**. Puoi anche **passare dalla modalità Passa alla visualizzazione live, per visualizzare** l'ultima versione pubblicata della pagina di ricerca, e **Passa alla modalità di creazione**, per modificare o personalizzare la pagina di ricerca.
Di seguito sono riportati i modi in cui puoi personalizzare la tua esperienza di ricerca.
### Filtro
Aggiungi una ricerca sfaccettata o filtra in base agli attributi del documento. Ciò include attributi personalizzati. Puoi aggiungere un filtro utilizzando i tuoi campi di metadati configurati. Ad esempio, per eseguire una ricerca sfaccettata per ogni categoria di città, utilizzate un attributo di documento `_category` personalizzato che contenga tutte le categorie di città.
### Risposta consigliata
Aggiungi risposte generate dall'apprendimento automatico alle domande degli utenti. Ad esempio, *«Quanto è difficile questo corso*?» . Amazon Kendra sa recuperare il testo più pertinente in tutti i documenti che si riferiscono alla difficoltà di un corso e suggerire la risposta più pertinente.
### Domande frequenti
Aggiungi un documento di domande frequenti per fornire risposte alle domande frequenti. Ad esempio, *«Quante ore occorrono per completare questo corso?»* . Amazon Kendra può utilizzare il documento FAQ contenente la risposta a questa domanda e fornire la risposta corretta.
### Ordina
Aggiungi l'ordinamento dei risultati della ricerca in modo che gli utenti possano organizzare i risultati per pertinenza, ora di creazione, ora dell'ultimo aggiornamento e altri criteri di ordinamento.
### Documenti
Configura la modalità di visualizzazione dei documenti o dei risultati della ricerca nella pagina di ricerca. È possibile configurare il numero di risultati da visualizzare sulla pagina, includere l'impaginazione come i numeri di pagina, attivare un pulsante di feedback degli utenti e disporre la modalità di visualizzazione dei campi dei metadati dei documenti nei risultati di ricerca.
### Lingua
Seleziona una lingua per filtrare i risultati della ricerca o i documenti nella lingua selezionata.
### Casella di ricerca
Configura la dimensione e il testo segnaposto della casella di ricerca, oltre a consentire suggerimenti di query.
### Ottimizzazione della pertinenza
Aggiungi un potenziamento ai campi dei metadati dei documenti per attribuire maggiore importanza a questi campi quando gli utenti cercano documenti. Puoi aggiungere un peso che inizia da 1 e aumenta gradualmente fino a 10. Puoi potenziare i tipi di campo di testo, data e numerici. Ad esempio, per dare `_last_updated_at` a un campo `_created_at` più peso o importanza rispetto ad altri campi, attribuisci a questi campi un valore compreso tra 1 e 10, a seconda della loro importanza. Puoi applicare diverse configurazioni di ottimizzazione della pertinenza per ogni applicazione o esperienza di ricerca.
## Fornire l'accesso alla pagina di ricerca
L'accesso alla tua esperienza di ricerca avviene tramite IAM Identity Center. Quando configuri la tua esperienza di ricerca, concedi ad altre persone elencate nella directory del tuo Identity Center l'accesso alla tua pagina Amazon Kendra di ricerca. Ricevono un'e-mail che li invita ad accedere utilizzando le proprie credenziali in IAM Identity Center per accedere alla pagina di ricerca. È necessario configurare IAM Identity Center a livello di organizzazione o a livello di titolare dell'account in. AWS Organizations Per ulteriori informazioni sulla configurazione di IAM Identity Center, consulta [Guida introduttiva a IAM Identity Center](https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html).
Attivi le identità utente in IAM Identity Center con la tua esperienza di ricerca e assegni le autorizzazioni di accesso a *Viewer* o *Owner* utilizzando l'API o la console.
+ **Visualizzatore**: è autorizzato a inviare domande, ricevere risposte suggerite pertinenti alla ricerca e contribuire con il proprio feedback Amazon Kendra in modo da migliorare continuamente la ricerca.
+ **Proprietario**: è autorizzato a personalizzare il design della pagina di ricerca, ottimizzare la ricerca e utilizzare l'applicazione di ricerca come *visualizzatore*. La disabilitazione dell'accesso ai visualizzatori nella console non è attualmente supportata.
Per assegnare ad altre persone l'accesso alla tua esperienza di ricerca, devi prima attivare le identità utente in IAM Identity Center con la tua Amazon Kendra esperienza utilizzando l'oggetto. [ExperienceConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ExperienceConfiguration.html) Specifichi il nome del campo che contiene gli identificatori dei tuoi utenti, come il nome utente o l'indirizzo email. Quindi concedi al tuo elenco di utenti l'accesso alla tua esperienza di ricerca utilizzando l'[AssociateEntitiesToExperience](https://docs.aws.amazon.com/kendra/latest/APIReference/API_AssociateEntitiesToExperience.html)API e definisci le loro autorizzazioni come *Visualizzatore* o *Proprietario* utilizzando l'[AssociatePersonasToEntities](https://docs.aws.amazon.com/kendra/latest/APIReference/API_AssociatePersonasToEntities.html)API. Specificate ogni utente o gruppo che utilizza l'[EntityConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_EntityConfiguration.html)oggetto e se tale utente o gruppo è un *visualizzatore* o un *proprietario* che utilizza l'[EntityPersonaConfiguraton](https://docs.aws.amazon.com/kendra/latest/APIReference/API_EntityPersonaConfiguration.html)oggetto.
Per assegnare ad altre persone l'accesso alla tua esperienza di ricerca utilizzando la console, devi prima creare un'esperienza e confermare la tua identità e il fatto di esserne il proprietario. Quindi puoi assegnare altri utenti o gruppi come visualizzatori o proprietari. Nella console, seleziona il tuo indice, quindi seleziona **Esperienze** nel menu di navigazione. Dopo aver creato la tua esperienza, puoi selezionarla dall'elenco. Vai a **Gestione degli accessi** per assegnare utenti o gruppi come visualizzatori o proprietari.
## Configurazione di un'esperienza di ricerca
Di seguito è riportato un esempio di configurazione o creazione di un'esperienza di ricerca.
------
#### [ Console ]
**Per creare un'esperienza di Amazon Kendra ricerca**
1. Nel riquadro di navigazione a sinistra, in **Indici**, seleziona **Esperienze**, quindi seleziona **Crea** esperienza.
1. Nella pagina **Configura esperienza**, inserisci un nome e una descrizione per la tua esperienza, scegli le fonti di contenuto e scegli il ruolo IAM per la tua esperienza. Per ulteriori informazioni sui ruoli IAM, consulta [Ruoli IAM per Amazon Kendra le esperienze](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
1. Nella pagina **Conferma la tua identità da un elenco di Identity Center**, seleziona il tuo ID utente, ad esempio l'email. Se non disponi di una directory Identity Center, inserisci semplicemente il tuo nome completo e l'indirizzo email per creare una directory Identity Center. Ciò include te come utente dell'esperienza e ti assegna automaticamente i diritti di accesso del proprietario.
1. Nella pagina **Verifica l'apertura di Experience Builder**, esamina i dettagli di configurazione e seleziona **Crea esperienza e apri Experience Builder** per iniziare a modificare la pagina di ricerca.
------
#### [ CLI ]
**Per creare un'esperienza Amazon Kendra **
```
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 ]
**Per creare un' Amazon Kendra esperienza**
```
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 ]
**Per creare 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.");
}
}
```
------