Uso deAmazon Kendra JavaScript biblioteca para enviar comentarios - Amazon Kendra

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Uso deAmazon Kendra JavaScript biblioteca para enviar comentarios

Amazon Kendraproporciona un JavaScript biblioteca que puedes usar para añadir comentarios de clic a tu página de resultados de búsqueda. Para utilizar la biblioteca, inserta una etiqueta de script en el código de cliente que muestra el resultado de la búsqueda y, a continuación, agrega información a cada uno de los vínculos de documento de la lista de resultados. Cuando un usuario elige un enlace para ver un documento, la información de clic se envía aAmazon Kendra.

La biblioteca funciona con navegadores compatibles JavaScript versión ES6/ES2015.

Paso 1: Inserta una etiqueta de guión en tuAmazon Kendraaplicación de búsqueda

En el código de cliente que representa elAmazon Kendraresultados de búsqueda, inserte una <script>etiqueta y agregue una referencia al JavaScript biblioteca:

<script> (function(w, d, s, c, g, n) { if(!w[n]) { w[n] = w[n] || function () { (w[n].q = w[n].q || []).push(arguments); } w[n].st = new Date().getTime(); w[n].ep = g; var e = document.createElement(s), j = document.getElementsByTagName(s)[0]; e.async = 1; e.src = c; e.type = 'module'; j.parentNode.insertBefore(e, j); } })(window, document, 'script', 'library download URL', 'feedback endpoint', 'kendraFeedback'); </script>

El script descarga asincrónicamente el JavaScript biblioteca de unAmazon KendraCDN alojada e inicializa una variable global llamadakendraFeedbackque le permite establecer parámetros opcionales.

ReemplazarURL de descarga de bibliotecaypunto final de retroalimentacióncon un identificador de la siguiente tabla basado en la región que aloja suAmazon Kendraíndice.

Región Descargar URL Punto final de retroalimentación
us-east-1 https://d2zm0lpns956f8.cloudfront.net/ksf-v1.js https://ujxwp5s92h.execute-api.us-east-1.amazonaws.com/prod/submit
us-west-2 https://d2iezfpnpcoujy.cloudfront.net/ksf-v1.js https://wg6nim909c.execute-api.us-west-2.amazonaws.com/prod/submit
eu-west-1 https://d3gptlxtulu4us.cloudfront.net/ksf-v1.js https://po2b11740b.execute-api.eu-west-1.amazonaws.com/prod/submit
ap-southeast-2 https://dopqntoe6z0ce.cloudfront.net/ksf-v1.js https://oovf4nvjj7.execute-api.ap-southeast-2.amazonaws.com/prod/submit

Por ejemplo, si su índice está en EE. UU. Este (Norte de Virginia),URL de descarga de bibliotecaeshttps://d2zm0lpns956f8.cloudfront.net/ksf-v1.jsypunto final de retroalimentacióneshttps://ujxwp5s92h.execute-api.us-east-1.amazonaws.com/prod/submit.

Hay dos ajustes opcionales que puedes hacer para elAmazon Kendra JavaScript biblioteca:

  • disableCookies— De forma predeterminada,Amazon Kendraestablece una cookie que identifica de forma exclusiva al usuario. Establezca esto entruepara deshabilitar la cookie.

    kendraFeedback('disableCookie', 'true | false');

    searchDivClassName— De forma predeterminada,Amazon Kendrasupervisa todos los enlaces de la página de resultados de búsqueda en busca de clics. Establezca esto en un<div>nombre de clase para supervisar solo los vínculos de la clase especificada.

    kendraFeedback('searchDivClassName', 'class name');

Paso 2: Añadir el token de comentarios a los resultados de búsqueda

En la página de resultados, agrega un atributo HTML denominadodata-kendra-tokena la etiqueta de anclaje o a la etiqueta div principal inmediata que contiene un enlace al documento desde la respuesta a la consulta. Por ejemplo:

<a href="document location" data-kendra-token="feedback token value"></a> OR <div data-url="document location" data-kendra-token="feedback token value"></div>

Una respuesta a una consulta contiene un token en elfeedbackToken. El token identifica de forma exclusiva la respuesta si el usuario la elige. Asigne el valor del token a ladata-kendra-tokenatributo. LaAmazon Kendra JavaScript biblioteca busca este token cuando el usuario elige el resultado y lo envía a unAmazon Kendraendpoint como retroalimentación.

LaAmazon Kendra JavaScript biblioteca solo envía el token de comentarios y otros metadatos, como la hora en que se eligió el resultado y un ID de visitante único.

Paso 3: Probar el script de comentarios

Para asegurarse de que la JavaScript la biblioteca está configurada correctamente y envía comentarios al extremo correcto, haga lo siguiente. En este ejemplo, se usa el navegador Chrome.

  1. Abra las herramientas de desarrollador web en el navegador. En Chrome, abre elMenú Chromeen la esquina superior derecha del navegador, elijaMás herramientasy luego elijaHerramientas para desarrolladores.

  2. Asegúrese de que no haya errores relacionados con laAmazon Kendra JavaScript en la pestaña de consola.

  3. Haz una búsqueda y elige cualquier resultado. En el navegadorRedde las herramientas para desarrolladores. Debería ver una solicitud enviada al punto final de valoración, el token del resultado y un estado 200 OK.