Usar a biblioteca de JavaScript do Amazon Kendra para enviar feedback - Amazon Kendra

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Usar a biblioteca de JavaScript do Amazon Kendra para enviar feedback

O Amazon Kendra fornece uma biblioteca de JavaScript que você poderá usar para adicionar feedback de cliques à sua página de resultados de pesquisa. Para usar a biblioteca, você insere uma tag de script no código do cliente que exibe o resultado da pesquisa e, em seguida, adiciona informações a cada um dos links do documento na sua lista de resultados. Quando um usuário escolhe um link para visualizar um documento, as informações de clique são enviadas para o Amazon Kendra.

A biblioteca funciona com navegadores que dão suporte a versão ES6/ES2015 do JavaScript.

Etapa 1: inserir uma tag de script no aplicativo de pesquisa do Amazon Kendra

No código do cliente que renderiza os resultados da pesquisa Amazon Kendra, insira uma <script>tag e adicione uma referência à 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>

O script baixa de forma assíncrona a biblioteca de JavaScript de uma CDN hospedada do Amazon Kendra e inicializa uma variável global chamada kendraFeedback que permite definir parâmetros opcionais.

Substitua o URL de download da biblioteca e o endpoint de feedback por um identificador da tabela a seguir com base na região que hospeda seu índice do Amazon Kendra.

Região Faça download do URL Endpoint de feedback
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 exemplo, se seu índice estiver no Leste dos EUA (Norte da Virgínia), o URL de download da biblioteca é https://d2zm0lpns956f8.cloudfront.net/ksf-v1.js e o endpoint de feedback é https://ujxwp5s92h.execute-api.us-east-1.amazonaws.com/prod/submit.

Há duas configurações opcionais que poderá fazer para a biblioteca de JavaScript do Amazon Kendra :

  • disableCookies – Por padrão, o Amazon Kendra define um cookie que identifica o usuário de forma exclusiva. Defina isso como true para desativar o cookie.

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

    searchDivClassName – Por padrão, o Amazon Kendra monitora todos os links na página de resultados de pesquisa em busca de cliques. Defina isso como um nome de classe <div> para monitorar somente os links na classe especificada.

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

Etapa 2: adicionar o token de comentários aos resultados da pesquisa

Na sua página de resultados, adicione um atributo do HTML chamado data-kendra-token à tag âncora ou à tag div primária imediata que contém um link para o documento a partir da resposta da consulta. Por exemplo:

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

Uma resposta de consulta contém um token no campo de feedbackToken. O token identifica a resposta de forma exclusiva se o usuário a escolher. Atribua o valor do token ao atributo de data-kendra-token. A biblioteca de JavaScript do Amazon Kendra procura esse token quando o usuário escolhe o resultado e o envia para um endpoint do Amazon Kendra como comentário.

A biblioteca de JavaScript do Amazon Kendra envia apenas o token de comentários e outros metadados, como a hora em que o resultado foi escolhido e um ID de visitante exclusivo.

Etapa 3: testar o script de comentários

Para garantir que a biblioteca de JavaScript esteja configurada corretamente e enviando comentários para o endpoint correto, faça o seguinte: Este exemplo usa o navegador do Chrome.

  1. Abra as ferramentas para desenvolvedores da Web no navegador. No Chrome, abra o menu do Chrome no canto superior direito do navegador, escolha Mais ferramentas e escolha Ferramentas para desenvolvedores.

  2. Garanta que não haja erros relacionados à biblioteca de JavaScript do Amazon Kendra na guia do console.

  3. Faça uma pesquisa e escolha qualquer resultado. Na guia Rede das ferramentas do desenvolvedor. Visualize uma solicitação enviada ao endpoint de comentários, o token do resultado e um status de 200 OK.