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 de la biblioteca de JavaScript de Amazon Kendra para enviar valoraciones
Amazon Kendra proporciona una biblioteca de JavaScript que puede utilizar para añadir valoraciones mediante clics a la página de resultados de búsqueda. Para utilizar la biblioteca debe insertar una etiqueta de cadena en su código cliente que muestre el resultado de búsqueda y, a continuación, añadir información a cada uno de los enlaces de los documentos de su lista de resultados. Cuando un usuario elige un enlace para ver un documento, se envía la información sobre los clics a Amazon Kendra.
La biblioteca funciona con navegadores compatibles con la versión ES6/ES2015 de JavaScript.
Paso 1: Insertar una etiqueta de cadena en la aplicación de búsqueda de Amazon Kendra
En su código cliente que muestra los resultados de búsqueda de Amazon Kendra, inserte una etiqueta <script> y añada una referencia a la biblioteca de JavaScript:
<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>
La cadena descarga de forma asíncrona la biblioteca de JavaScript desde una CDN alojada en Amazon Kendra e inicializa una variable global llamada kendraFeedback que permite establecer parámetros opcionales.
Sustituya la URL de descarga de biblioteca y el punto de conexión de comentarios por un identificador de la siguiente tabla en función de la región que aloja su índice de Amazon Kendra.
| Región | Descargar URL | Punto de conexión de valoraciones |
|---|---|---|
| us-east-1 | https://d2zm0lpns956f8.cloudfront.net/ksf-v1.js | https://ujxwp5s92h.execute-api.us-east-1.amazonaws.com/prod/submit |
| us-east-2 | https://d2crv7fufeg244.cloudfront.net/ksf-v1.js | https://i6h76zwzf3.execute-api.us-east-2.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 |
| ca-central-1 | https://d1zbkfomowykaq.cloudfront.net/ksf-v1.js | https://budi8txevj.execute-api.ca-central-1.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-1 | https://d1vvuam7g4taoe.cloudfront.net/ksf-v1.js | https://9je5uw7t5l.execute-api.ap-southeast-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 |
| ap-south-1 | https://d1ts9ouelsmk3g.cloudfront.net/ksf-v1.js | https://k1abnmd43b.execute-api.ap-south-1.amazonaws.com/prod/submit |
| ap-northeast-1 | https://d3w0ybsa293kb4.cloudfront.net/ksf-v1.js | https://wg7rz0uzjh.execute-api.ap-northeast-1.amazonaws.com/prod/submit |
| eu-west-2 | https://d1tsrujswld1d1.cloudfront.net/ksf-v1.js | https://qi7mct3x7f.execute-api.eu-west-2.amazonaws.com/prod/submit |
Por ejemplo, si su índice está en Este de EE. UU. (Norte de Virginia), la URL de descarga de biblioteca es https://d2zm0lpns956f8.cloudfront.net/ksf-v1.js y el punto de conexión de comentarios es https://ujxwp5s92h.execute-api.us-east-1.amazonaws.com/prod/submit.
Hay dos ajustes opcionales que puede realizar para la biblioteca de JavaScript de Amazon Kendra:
-
disableCookies: de forma predeterminada, Amazon Kendra habilita una cookie que identifica de forma única al usuario. Configúrelo comotruepara deshabilitar la cookie.kendraFeedback('disableCookie', 'true|false');searchDivClassName: de forma predeterminada, Amazon Kendra supervisa los clics en todos los enlaces de su página de resultados de búsqueda. Configúrelo como un nombre de clase<div>para que los supervise solo en los enlaces de la clase especificada.kendraFeedback('searchDivClassName', 'class name');
Paso 2: Añadir el token de valoración a los resultados de búsqueda
En su página de resultados, añada un atributo HTML llamado data-kendra-token a la etiqueta delimitadora o a la etiqueta div principal inmediata que contenga 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>
La respuesta a una consulta contiene un token en el campo feedbackToken. El token identifica la respuesta de forma única si el usuario la elige. Asigne el valor del token al atributo data-kendra-token. La biblioteca de JavaScript de Amazon Kendra busca este token cuando el usuario elige el resultado y lo envía a un punto de conexión de Amazon Kendra como valoración.
La biblioteca de JavaScript de Amazon Kendra solo envía el token de valoración y otros metadatos, como la hora en que se eligió el resultado y un ID de visitante único.
Paso 3: Probar la cadena de valoración
Para asegurarse de que la biblioteca de JavaScript está configurada correctamente y que envía las valoraciones al punto de conexión correcto, haga lo siguiente. En este ejemplo, se utiliza el navegador Chrome.
-
Abra las Herramientas para desarrolladores web en el navegador. En Chrome, abra el menú de Chrome en la esquina superior derecha del navegador, seleccione Más herramientas y, a continuación, Herramientas para desarrolladores.
-
Asegúrese de que no haya errores relacionados con la biblioteca de JavaScript de Amazon Kendra en la pestaña Consola.
-
Realice una búsqueda y elija cualquier resultado. En el panel de Herramientas para desarrolladores, elija la pestaña Red. Debería ver una solicitud enviada al punto de conexión de valoración, el token del resultado y un estado 200 OK.