Introdução ao exemplo de bate-papo corporativo Java usando RAG

  • Artigo

Este artigo mostra como implantar e executar o exemplo de aplicativo de bate-papo corporativo para Java. Este exemplo implementa um aplicativo de bate-papo usando Java, Serviço OpenAI do Azure e Geração Aumentada de Recuperação (RAG) na Pesquisa de IA do Azure para obter respostas sobre os benefícios dos funcionários em uma empresa fictícia. O aplicativo é semeado com arquivos PDF, incluindo o manual do funcionário, um documento de benefícios e uma lista de funções e expectativas da empresa.

Comece agora

Seguindo as instruções neste artigo, você vai:

  • Implantar um aplicativo de chat no Azure.
  • Obtenha respostas sobre os benefícios dos funcionários.
  • Altere as configurações para alterar o comportamento das respostas.

Depois de concluir este artigo, você pode começar a modificar o novo projeto com seu código personalizado.

Este artigo faz parte de uma coleção de artigos que mostram como criar um aplicativo de bate-papo usando o Serviço OpenAI do Azure e a Pesquisa de IA do Azure. Outros artigos na coleção incluem:

Visão geral da arquitetura

Uma arquitetura simples do aplicativo de chat é mostrada no diagrama a seguir:

Diagrama mostrando a arquitetura do cliente para o aplicativo de back-end.

Os principais componentes da arquitetura incluem:

  • Um aplicativo Web para hospedar a experiência de chat interativa.
  • Um recurso de Pesquisa de IA do Azure para obter respostas de seus próprios dados.
  • Um Serviço OpenAI do Azure a ser fornecido:
    • Palavras-chave para aprimorar a pesquisa sobre seus próprios dados.
    • Respostas do modelo OpenAI.
    • Inserções do modelo ada

Cost

A maioria dos recursos nessa arquitetura usa um tipo de preço básico ou de consumo. O preço de consumo é baseado no uso, o que significa que você paga apenas pelo que usa. Para concluir este artigo, haverá uma cobrança, mas será mínima. Quando terminar de usar o artigo, você poderá excluir os recursos para parar de incorrer em encargos.

Saiba mais sobre o custo no repositório de amostra.

Pré-requisitos

Um ambiente de contêiner de desenvolvimento está disponível com todas as dependências necessárias para concluir este artigo. Você pode executar o contêiner de desenvolvimento em Codespaces do GitHub (em um navegador) ou localmente usando o Visual Studio Code.

Para usar este artigo, você precisa dos seguintes pré-requisitos:

  1. Uma assinatura do Azure – crie uma gratuitamente
  2. Permissões de conta do Azure – sua conta do Azure deve ter permissões Microsoft.Authorization/roleAssignments/write, como Administrador de Acesso do Usuário ou Proprietário.
  3. Acesso permitido ao OpenAI do Azure na assinatura do Azure desejada. No momento, o acesso a esse serviço é permitido somente por aplicativo. Você pode solicitar acesso ao Serviço OpenAI do Azure preenchendo o formulário em https://aka.ms/oai/access. Abra um problema neste repositório para entrar em contato conosco se você tiver algum problema.
  4. GitHub

Abrir o ambiente de desenvolvimento

Comece agora com um ambiente de desenvolvimento que tenha todas as dependências instaladas para concluir este artigo.

O GitHub Codespaces executa um contêiner de desenvolvimento gerenciado pelo GitHub com o Visual Studio Code para Web como interface do usuário. Para o ambiente de desenvolvimento mais simples, use os Codespaces do GitHub para que você tenha as ferramentas e dependências de desenvolvedor corretas pré-instaladas para concluir este artigo.

Importante

Todas as contas do GitHub podem usar Codespaces por até 60 horas gratuitas por mês com 2 instâncias principais. Para saber mais, confira Armazenamento e horas por núcleo incluídos mensalmente no GitHub Codespaces.

  1. Inicie o processo para criar um GitHub Codespace no branch main do repositório GitHub Azure-Samples/azure-search-openai-demo-java.

  2. Clique com o botão direito do mouse no botão a seguir e selecione Abrir link em novas janelas para ter o ambiente de desenvolvimento e a documentação disponíveis ao mesmo tempo.

    Abra este projeto no Codespaces do GitHub

  3. Na página Criar codespace , analise as definições de configuração do codespace e selecione Criar novo codespace

    Captura de tela da tela de confirmação antes de criar um novo codespace.

  4. Aguarde até que o codespace seja iniciado. Esse processo de inicialização pode levar alguns minutos.

  5. No terminal na parte inferior da tela, entre no Azure com o Azure Developer CLI.

    azd auth login

  6. Copie o código do terminal e cole-o em um navegador. Siga as instruções para autenticar com sua conta do Azure.

  7. As tarefas restantes neste artigo ocorrem no contexto desse contêiner de desenvolvimento.

Implantar e executar

O repositório de exemplo contém todos os arquivos de código e configuração necessários para implantar um aplicativo de chat no Azure. As etapas a seguir explicam o processo de implantação do exemplo no Azure.

Implantar aplicativo de chat no Azure

Importante

Os recursos do Azure criados nesta seção geram custos imediatos, principalmente do recurso de Pesquisa de IA do Azure. Esses recursos podem acumular custos mesmo se você interromper o comando antes que ele seja totalmente executado.

  1. Execute o seguinte comando do Azure Developer CLI para provisionar os recursos do Azure e implantar o código-fonte:

    azd up

  2. Quando for solicitado que você insira um nome de ambiente, mantenha-o curto e minúsculo. Por exemplo, myenv. É usado como parte do nome do grupo de recursos.

  3. Quando solicitado, selecione uma assinatura para criar os recursos.

  4. Quando for solicitado que você selecione um local na primeira vez, selecione um local próximo a você. Esse local é usado para a maioria dos recursos, incluindo hospedagem.

  5. Se for solicitado que você solicite um local para o modelo OpenAI, selecione um local próximo a você. Se o mesmo local estiver disponível como seu primeiro local, selecione-o.

  6. Aguarde até que o aplicativo seja implantado. Pode levar de 5 a 10 minutos para que a implantação seja concluída.

  7. Depois que o aplicativo tiver sido implantado com êxito, você verá uma URL exibida no terminal.

  8. Selecione essa URL rotulada Deploying service web para abrir o aplicativo de chat em um navegador. Captura de tela do aplicativo de chat no navegador mostrando várias sugestões de entrada de chat e a caixa de texto de chat para inserir uma pergunta.

Usar o aplicativo de chat para obter respostas de arquivos PDF

O aplicativo de chat é pré-carregado com informações de benefícios dos funcionários de arquivos PDF. Você pode usar o aplicativo de chat para fazer perguntas sobre os benefícios. As etapas a seguir explicam o processo de uso do aplicativo de chat.

  1. No navegador, selecione ou digite "O que está incluído no meu plano Northwind Health Plus que não está no padrão?" na caixa de texto do bate-papo.

    Captura de tela da primeira resposta do aplicativo de chat.

  2. Na resposta, selecione uma das citações.

    Captura de tela da primeira resposta do aplicativo de chat com sua citação realçada em uma caixa vermelha.

  3. No painel direito, use as guias para entender como a resposta foi gerada.

    Tabulação Descrição
    Processo de pensamento Esse é um script das interações no chat.
    Conteúdo de suporte Isso inclui as informações para responder à sua pergunta e ao material de origem.
    Citação Isso exibe a página PDF que contém a citação.

  4. Quando terminar, selecione a guia selecionada novamente para fechar o painel.

Usar as configurações do aplicativo de chat para alterar o comportamento das respostas

A inteligência do aplicativo de bate-papo é determinada pelo modelo OpenAI e pelas configurações que são usadas para interagir com o modelo.

Captura de tela das configurações do desenvolvedor de chat.

Configuração Descrição
Substituir modelo de prompt Esse é o prompt usado para gerar a resposta.
Recuperar muitos resultados da pesquisa Esse é o número de resultados da pesquisa que são usados para gerar a resposta. Você pode ver essas fontes retornadas nas guias Processo de pensamento e Conteúdo de suporte da citação.
Excluir categoria Essa é a categoria de documentos que são excluídos dos resultados da pesquisa.
Usar o classificador semântico para recuperação Esse é um recurso da Pesquisa de IA do Azure que usa o aprendizado de máquina para melhorar a relevância dos resultados da pesquisa.
Usar resumos contextuais de consulta em vez de documentos inteiros Quando ambos Use semantic ranker e Use query-contextual summaries são verificados, o LLM usa legendas extraídas de passagens-chave, em vez de todas as passagens, nos documentos mais bem classificados.
Sugerir perguntas de acompanhamento Faça com que o aplicativo de chat sugira perguntas de acompanhamento com base na resposta.
Modo de recuperação Vetores + Texto significa que os resultados da pesquisa são baseados no texto dos documentos e nas inserções dos documentos. Vetores significa que os resultados da pesquisa são baseados nas inserções dos documentos. Texto significa que os resultados da pesquisa são baseados no texto dos documentos.
Transmitir respostas de conclusão de bate-papo Transmita a resposta em vez de aguardar até que a resposta completa esteja disponível para uma resposta.

As etapas a seguir explicam o processo de alteração das configurações.

  1. No navegador, selecione a guia Configurações do desenvolvedor.

  2. Marque a caixa de seleção Sugerir perguntas de acompanhamento e faça a mesma pergunta novamente.

    What is my deductible?

    O bate-papo retornou sugestões de perguntas de acompanhamento, como as seguintes:

    1. What is the cost sharing for out-of-network services?
2. Are preventive care services subject to the deductible?
3. How does the prescription drug deductible work?

  3. Na guia Configurações, desmarque Usar classificador semântico para recuperação.

  4. Faça a mesma pergunta novamente?

    What is my deductible?

  5. Qual é a diferença nas respostas?

    Por exemplo, a resposta, que usou o ranker semântico, forneceu uma única resposta: The deductible for the Northwind Health Plus plan is $2,000 per year.

    A resposta sem classificação semântica retornou uma resposta, o que exigiu mais trabalho para obter a resposta: Based on the information provided, it is unclear what your specific deductible is. The Northwind Health Plus plan has different deductible amounts for in-network and out-of-network services, and there is also a separate prescription drug deductible. I would recommend checking with your provider or referring to the specific benefits details for your plan to determine your deductible amount.

Limpar os recursos

Limpar recursos do Azure

Os recursos do Azure criados neste artigo são cobrados para sua assinatura do Azure. Se você não espera precisar desses recursos no futuro, exclua-os para evitar incorrer em mais encargos.

Execute o seguinte comando do Azure Developer CLI para excluir os recursos do Azure e remover o código-fonte:

azd down --purge

Limpar GitHub Codespaces

A exclusão do ambiente GitHub Codespaces garante que você possa maximizar a quantidade de horas gratuitas por núcleo que você tem direito na sua conta.

Importante

Para saber mais sobre os direitos da sua conta do GitHub, confira O GitHub Codespaces inclui mensalmente armazenamento e horas de núcleo.

  1. Entre no painel do GitHub Codespaces (https://github.com/codespaces).
  2. Localize os codespaces atualmente em execução provenientes do repositório GitHub Azure-Samples/azure-search-openai-demo-java. Captura de tela de todos os codespaces em execução, incluindo seu status e modelos.
  3. Abra o menu de contexto do codespace e selecione Excluir. Captura de tela do menu de contexto de um único codespace com a opção de exclusão destacada.

Como a pergunta é respondida?

O aplicativo é separado em 2 aplicativos:

  • Um aplicativo JavaScript front-end usando a estrutura React com a ferramenta de compilação Vite.
  • Um aplicativo Java back-end responde à pergunta.

A API de back-end /chat percorre o processo de obtenção da resposta:

  • Construir opções RAG: Crie um conjunto de opções que serão usadas para gerar uma resposta.
  • Criar abordagem usando opções RAG: use uma combinação de modelos baseados em recuperação e generativos para criar uma abordagem para gerar uma resposta precisa e natural.
  • Execute a abordagem com as opções RAG e conversação anterior: use as opções approach e RAG para gerar uma resposta com base na conversa anterior. A resposta inclui informações sobre quais documentos foram usados para gerar a resposta.

Obter ajuda

Este repositório de exemplo oferece informações de solução de problemas.

Se o problema não for resolvido, registre o problema nos Problemas do repositório.

Próximas etapas