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 alla ricerca API utilizzata. Per verificare se questa funzionalità è supportata per il tipo di indice e la ricerca API che stai utilizzando, consulta Tipi di indice.
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 MIT licenza modificata. Puoi usarlo così com'è o modificarlo in base alle tue 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 endpoint URL per la pagina di ricerca con controllo degli accessi, consulta Amazon Kendra Experience 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
: 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 vedere una breve descrizione del componente e per ottenere la fonte URL del componente.
Argomenti
Panoramica
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. 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, FAQ risultati 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
installati. È richiesta la versione 19 o precedente di Node.js. -
SDK for Javao AWS SDK for JavaScriptper effettuare API chiamate 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
. -
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 obsoletonode-sass. Se l'hai installato in precedenzanode-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
-
Assicurati di aver completatoPrerequisiti, incluso il download e l'installazione di Node.js e npm.
-
Scaricate il kendrasamples-react-app file.zip e decomprimetelo.
-
Apri il tuo terminale e vai a.
aws-kendra-example-react-app/src/services/Aprilocal-dev-credentials.jsone inserisci le tue credenziali. Non aggiungete questo file a nessun archivio pubblico. -
Vai a
aws-kendra-example-react-appe installa le dipendenze in.package.jsonEseguinpm install. -
Avvia una versione demo della tua app sul tuo server locale. Esegui
npm start. Puoi fermare il server locale accedendo alla tastieraCmd/Ctrl + C. -
Puoi cambiare la porta o l'host (ad esempio, l'indirizzo IP) accedendo
package.jsone 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". -
Se hai un dominio del sito web registrato, puoi specificarlo
package.jsondopo il nome della tua app. Ad esempio"homepage": "https://mywebsite.com". È necessario eseguirenpm installnuovamente l'operazione per aggiornare le nuove dipendenze, quindi eseguirenpm start. -
Per creare l'app,
npm buildesegui. 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 della Query API 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 API chiamata Amazon Kendra
Query.
Componente dei risultati
Il componente dei risultati mostra la risposta di QueryAPI. I risultati vengono visualizzati in tre aree separate.
-
Risposte suggerite: questi sono i migliori risultati restituiti da.
QueryAPI Contiene fino a tre risposte suggerite. Nella risposta, hanno il tipo di risultatoANSWER. -
FAQRisposte: questi sono i risultati delle domande frequenti restituiti dalla risposta. FAQsvengono aggiunti all'indice separatamente. Nella risposta, hanno il tipo
QUESTION_ANSWER. Per ulteriori informazioni, vedere Domande e risposte. -
Documenti consigliati: si tratta di documenti aggiuntivi che vengono Amazon Kendra restituiti nella risposta. Nella risposta di
QueryAPI, hanno il tipo.DOCUMENT
I componenti dei risultati condividono un set di componenti per funzionalità come l'evidenziazione, i titoli, i collegamenti e altro. 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 Query API in più pagine. Richiama i PageNumber parametri Query API with PageSize and per ottenere una pagina specifica di risultati.
