Implementación de Amazon Kendra

Cuando llegue el momento de desplegarAmazon Kendrabusque en su sitio web, proporcionamos código fuente que puede utilizar con React para obtener una ventaja en su aplicación. El código fuente se proporciona sin cargo alguno en virtud de una licencia MIT modificada. Puede usarlo tal cual o cambiarlo según sus propias necesidades.

Para implementar una aplicación de búsqueda sin código y generar una URL de endpoint en la página de búsqueda con control de acceso, consulteAmazon KendraExperiencia Builder.

Hay dos ejemplos que puede utilizar con React:

• https://kendrasamples.s3.amazonaws.com/kendrasamples-react-app.zip: aplicación React de ejemplo que proporciona datos de ejemplo y una página de búsqueda.

• https://kendrasamples.s3.amazonaws.com/kendrasamples.zip: biblioteca que puede agregar a una aplicación React existente.

Los ejemplos se modelan según la página de búsqueda delAmazon Kendraconsola de . Tienen las mismas funciones para buscar y mostrar los resultados de búsqueda. Puedes usar el ejemplo completo o puedes elegir solo una de las funciones para tu propio uso.

Para ver los tres componentes de la página de búsqueda en elAmazon Kendra, elija el icono de código (</>) del menú de la derecha. Pase el puntero sobre cada sección para ver una breve descripción del componente y obtener la URL del origen del componente.

Temas

• Información general
• Requisitos previos
• Configuración del ejemplo
• Página de búsqueda principal
• Componente de búsqueda
• Componente de resultados
• Componente Facetas
• Componente de paginación
• Creación de una experiencia de búsqueda sin código

Información general

Añada el código de ejemplo a una aplicación React existente para habilitar la búsqueda. Los archivos y componentes de búsqueda están estructurados de la siguiente manera:

• Página de búsqueda principal: esta es la página principal que contiene todos los componentes. Aquí es donde integrará su aplicación con elAmazon KendraAPI.

• Barra de búsqueda: este es el componente en el que un usuario introduce un término de búsqueda y llama a la función de búsqueda.

• Resultados: este es el componente que muestra los resultados deAmazon Kendra. Tiene tres componentes: Respuestas sugeridas, resultados de preguntas frecuentes y documentos recomendados.

• Facetas: este es el componente que muestra las facetas en los resultados de búsqueda y le permite elegir una faceta para limitar la búsqueda.

• Paginación: este es el componente que pagina la respuesta deAmazon Kendra.

Requisitos previos

Antes de comenzar, necesitará lo siguiente:

• Una aplicación web React existente o la aplicación de ejemplo.

• Entorno de desarrollo configurado con las bibliotecas correctas.

• Node.js y npminstalado.

• LaSDK for JavaoAWS SDK for JavaScript.

Información sobre las bibliotecas requeridas yAWSLos SDK se encuentran en el archivo Léame de los archivos zip.

Configuración del ejemplo

Procedimiento completo para añadirAmazon Kendrala búsqueda en una aplicación React se encuentra en el archivo Léame incluido en los archivos zip de ejemplo.

Para empezar a utilizar kendra-samples-react-app.zip

1. Asegúrese de que ha completado laRequisitos previos, incluida la descarga e instalación de Node.js y npm.

2. Descargue kendra-samples-react-app.zip y descomprima.

3. Abre tu terminal y ve aaws-kendra-sample-app/src/services/. Abiertolocal-dev-credentials-template.jsony proporcione sus credenciales de. No agregue este archivo a ningún repositorio público.

4. Vaya aaws-kendra-sample-app/srce instala las dependencias. Ejecute npm install.

5. Inicie una versión de demostración de la aplicación en su servidor local. Ejecute npm start. Puede detener el servidor local introduciendo en el tecladoCmd/Ctrl + C.

6. Puede cambiar el puerto o el host (por ejemplo, dirección IP) yendo apackage.jsony actualice el host y el puerto: "start": "HOST=[host] PORT=[port] react-scripts start". Si utiliza Windows:"start": "set HOST=[host] && set PORT=[port] && react-scripts start".

7. Si tiene un dominio de sitio web registrado, puede especificarlo enpackage.jsondespués del nombre de la aplicación. Por ejemplo, "homepage": "https://mywebsite.com". Debes corrernpm installde nuevo para actualizar nuevas dependencias y, a continuación, ejecutarnpm start.

8. Para compilar la aplicación para la ejecución de producciónnpm build. Cargue el contenido del directorio de compilación en su proveedor de alojamiento.

Página de búsqueda principal

La página de búsqueda principal contiene todos los componentes de búsqueda de ejemplo. Incluye el componente de barra de búsqueda para la salida, los componentes de resultados para mostrar la respuesta delConsultaAPI y un componente de paginación para la paginación a través de la respuesta.

Componente de búsqueda

El componente de búsqueda proporciona un cuadro de texto para introducir texto de consulta. LaonSearches un gancho que llama a la función principal enSearch.tsxpara hacer que laAmazon Kendra ConsultaLlamada a la API.

Componente de resultados

El componente de resultados muestra la respuesta de laQueryAPI. Los resultados se muestran en tres áreas distintas.

• Respuestas sugeridas: estos son los principales resultados devueltos por elQueryAPI. Contiene hasta tres respuestas sugeridas. En la respuesta, tienen el tipo de resultadoANSWER.

• Respuestas de preguntas frecuentes: estos son los resultados de las preguntas más frecuentes que devuelve la respuesta. Las preguntas frecuentes se añaden al índice por separado. En la respuesta, tienen el tipoQUESTION_ANSWER. Para obtener más información, consultePreguntas y respuestas.

• Documentos recomendados: se trata de documentos adicionales queAmazon Kendradevuelve la respuesta. En la respuesta de laQueryAPI, tienen el tipoDOCUMENT.

Los componentes de resultados comparten un conjunto de componentes para funciones como resaltado, títulos, enlaces y más. Los componentes compartidos deben estar presentes para que los componentes de resultados funcionen.

Componente Facetas

El componente facetas enumera las facetas disponibles en los resultados de búsqueda. Cada faceta clasifica la respuesta en una dimensión específica, como el autor. Puede refinar la búsqueda a una faceta específica eligiendo una de la lista.

Después de seleccionar una faceta, el componente llamaQuerycon un filtro de atributos que restringe la búsqueda a los documentos que coinciden con la faceta.

Componente de paginación

El componente de paginación le permite mostrar los resultados de búsqueda desde elQueryAPI en varias páginas. Se llama aQueryAPI con elPageSizeyPageNumberparámetros para obtener una página específica de resultados.