Implantação de Amazon Kendra

Quando chega a hora de implantar a pesquisa do Amazon Kendra no site, fornecemos o código-fonte que pode ser usado com o React para obter uma vantagem inicial no aplicativo. O código-fonte é fornecido gratuitamente sob uma licença modificada do MIT. Você pode usá-lo como ele está ou alterá-lo de acordo com suas necessidades. O aplicativo React fornecido é um exemplo que pode ajudar você a começar. Ele não é um aplicativo pronto para produção.

Para implantar um aplicativo de pesquisa sem código e gerar uma URL de endpoint para a página de pesquisa com controle de acesso, consulte Amazon KendraExperience Builder.

O código de exemplo a seguir adiciona a pesquisa do Amazon Kendra a um aplicativo da Web React existente:

• https://kendrasamples.s3.amazonaws.com/kendrasamples-react-app.zip: arquivos de amostra que os desenvolvedores podem usar para criar uma experiência de pesquisa funcional no aplicativo da Web React existente.

Os exemplos são modelados de acordo com a página de pesquisa do console do Amazon Kendra. Eles têm os mesmos recursos para pesquisar e exibir os resultados da pesquisa. Você pode usar o exemplo completo ou escolher apenas um dos recursos para seu próprio uso.

Para ver os três componentes da página de pesquisa no console do Amazon Kendra, escolha o ícone do código (</>) no menu à direita. Passe o mouse sobre cada seção para ver uma breve descrição do componente e obter o URL da fonte do componente.

Tópicos

• Visão geral
• Pré-requisitos
• Configurar o exemplo
• Página de pesquisa principal
• Componente de pesquisa
• Componente de resultados
• Componente de facetas
• Componente de paginação
• Criando uma experiência de pesquisa sem código

Visão geral

Adicione o código de exemplo a um aplicativo da Web React existente para ativar a pesquisa. O código de exemplo inclui um arquivo Readme com etapas para configurar um novo ambiente de desenvolvimento do React. Os dados de exemplo no exemplo de código podem ser usados para demonstrar uma pesquisa. Os arquivos e os componentes de pesquisa no código de exemplo são estruturados da seguinte forma:

• Página de pesquisa principal (Search.tsx): essa é a página principal que contém todos os componentes. É nela que você integra o aplicativo com a API do Amazon Kendra.

• Barra de pesquisa: esse é o componente em que um usuário insere um termo de pesquisa e chama a função de pesquisa.

• Resultados: esse é o componente que exibe os resultados de Amazon Kendra. Ele tem três componentes: respostas sugeridas, resultados de perguntas frequentes e documentos recomendados.

• Facetas: esse é o componente que mostra as facetas nos resultados da pesquisa e permite que você escolha uma faceta para restringir a pesquisa.

• Paginação: esse é o componente que pagina a resposta do Amazon Kendra.

Pré-requisitos

Antes de começar, você precisará fazer o seguinte:

• Node.js e npm instalados. É necessária a versão 19 ou anterior do Node.js.

• Python 3 ou Python 2 baixados e instalados.

• SDK for Java ou AWS SDK for JavaScriptpara fazer chamadas de API para o Amazon Kendra.

• Uma aplicação da Web existente do React. O código de exemplo inclui um arquivo Readme com etapas para configurar um novo ambiente de desenvolvimento do React, incluindo o uso de estruturas/bibliotecas necessárias. Você também pode seguir as instruções de início rápido na documentação do React sobre a criação de um aplicativo da Web do React.

• As bibliotecas e as dependências necessárias configuradas no ambiente de desenvolvimento. O código de exemplo inclui um arquivo Readme que lista as bibliotecas e dependências de pacotes necessárias. Isso sass é obrigatório, pois node-sass está obsoleto. Se você instalou anteriormente o node-sass, desinstale-o e instale o sass.

Configurar o exemplo

Um procedimento completo para adicionar a pesquisa do Amazon Kendra a um aplicativo React está no arquivo Readme incluído no exemplo de código.

Para começar a usar o kendrasamples-react-app.zip

1. Certifique-se de ter concluído o Pré-requisitos, incluindo o download e a instalação do Node.js e do npm.

2. Baixe o kendrasamples-react-app.zip e descompacte.

3. Abra o terminal e vá para aws-kendra-example-react-app/src/services/. Forneça suas credenciais da local-dev-credentials.json. Não adicione esse arquivo a nenhum repositório público.

4. Acesse aws-kendra-example-react-app e instale as dependências em package.json. Execute npm install.

5. Iniciar uma versão de demonstração do aplicativo no servidor local. Execute npm start. Você pode parar o servidor local digitando no teclado Cmd/Ctrl + C.

6. Você pode alterar a porta ou o host (por exemplo, endereço IP) acessando package.json e atualizando o host e a porta: "start": "HOST=[host] PORT=[port] react-scripts start". Se você usa Windows: "start": "set HOST=[host] && set PORT=[port] && react-scripts start".

7. Se você tiver um domínio de site registrado, poderá especificá-lo em package.json após o nome do aplicativo. Por exemplo, "homepage": "https://mywebsite.com". Execute npm install novamente para atualizar novas dependências e, em seguida, execute npm start.

8. Para construir o aplicativo, execute npm build. Faça o upload do conteúdo do diretório de compilação para o seu provedor de host.

   Atenção

   O aplicativo React não está pronto para produção. É um exemplo de implantação de um aplicativo para pesquisa do Amazon Kendra.

Página de pesquisa principal

A página de pesquisa principal (Search.tsx) contém todos os exemplos de componentes de pesquisa. Ele inclui o componente da barra de pesquisa para saída, os componentes de resultados para exibir a resposta da API de Consulta e um componente de paginação para paginar a resposta.

Componente de pesquisa

O componente de pesquisa fornece uma caixa de texto para inserir o texto da consulta. A função do onSearch é um hook que chama a função principal Search.tsx para fazer a chamada de API Amazon Kendra Consulta.

Componente de resultados

O componente de resultados mostra a resposta da API Query. Os resultados são mostrados em três áreas distintas.

• Respostas sugeridas: esses são os principais resultados retornados pela API Query. Ela contém até três respostas sugeridas. Na resposta, elas têm o tipo de resultado ANSWER.

• Respostas de perguntas frequentes: essas são os resultados das perguntas frequentes retornados pela resposta. As perguntas frequentes são adicionadas ao índice separadamente. Na resposta, elas têm o tipo de resultado QUESTION_ANSWER. Para obter mais informações, consulte Perguntas e respostas.

• Documentos recomendados: esses são documentos adicionais que Amazon Kendra retornam na resposta. Na resposta da API Query, elas têm o tipo de DOCUMENT.

Os componentes de resultados compartilham um conjunto de componentes para recursos como destaque, títulos, links e muito mais. Os componentes compartilhados devem estar presentes para que os componentes do resultado funcionem.

Componente de facetas

O componente de facetas lista as facetas disponíveis nos resultados da pesquisa. Cada faceta classifica a resposta em uma dimensão específica, como autor. Você pode refinar a pesquisa para uma faceta específica escolhendo uma na lista.

Depois de selecionar uma faceta, o componente chama Query com um filtro de atributo que restringe a pesquisa a documentos que correspondam à faceta.

Componente de paginação

O componente de paginação permite que você exiba os resultados da pesquisa da API Query em várias páginas. Ele chama a API Query com os parâmetros PageSize e PageNumber para obter uma página específica de resultados.