Depurar seu bot de chat de IA usando a Ferramenta de Teste de Aplicativo do Teams

Inicie o desenvolvimento de aplicativos do Microsoft Teams com seu aplicativo bot de chat de IA do Teams e depure com a Ferramenta de Teste de Aplicativo do Teams (Ferramenta de Teste). A Ferramenta de Teste torna a depuração de aplicativos baseados em bots sem esforço. Você não precisa de uma conta de desenvolvedor do Microsoft 365, túnel ou aplicativo do Teams e registro de bot para usar a Ferramenta de Teste.

Você pode conversar com o bot e exibir as mensagens e cartões adaptáveis à medida que elas aparecem no Teams. Você também pode simular uma atividade na Ferramenta de Teste usando gatilhos de atividade.

Observação

A Ferramenta de Teste de Aplicativo do Teams está disponível apenas no Teams Toolkit v5.4.0.
A Ferramenta de Teste de Aplicativo do Teams tem suporte apenas para clientes da área de trabalho e da Web.

Este guia passo a passo ajuda você a criar um bot de chat de IA usando o Teams Toolkit e depurar com a Ferramenta de Teste. Você verá a seguinte saída depois de concluir este guia, em que o usuário pode acessar e usar o bot de chat de IA:

Pré-requisitos

6 minutos restantes

Verifique se você instala as seguintes ferramentas para criar e implantar seus aplicativos.

Instalar	Para usar...
Visual Studio Code ou Visual Studio	Ambientes de build JavaScript, TypeScript ou C#. Use a versão mais recente.
Kit de ferramentas do Teams	A Microsoft Visual Studio Code extensão que cria um scaffolding de projeto para seu aplicativo. Use o Teams Toolkit v5.4.0. Para obter mais informações, consulte instalar o Teams Toolkit.
Node.js	Ambiente de runtime do JavaScript de back-end. Para obter mais informações, consulte Node.js tabela de compatibilidade de versão para o tipo de projeto.
OpenAI ou Azure OpenAI	Primeiro crie sua chave de API OpenAI para usar o GPT do OpenAI. Se você quiser hospedar seu aplicativo ou acessar recursos no Azure, deverá criar um serviço do Azure OpenAI.
Microsoft Edge (recomendado) ou Google Chrome	Um navegador com ferramentas de desenvolvedor.

Criar workspace de projeto para seu aplicativo de bot de chat de IA

5 minutos restantes

Vamos criar seu aplicativo de bot de chat de IA.

A funcionalidade de bot de um aplicativo do Teams cria um chatbot ou um bot de conversação. Ele se comunica com um serviço Web, facilitando o uso de seus serviços. O bot pode executar tarefas simples e automatizadas, como fornecer serviço ao cliente. Você pode obter previsão do tempo, fazer reservas ou qualquer outro serviço oferecido usando um bot de conversa.

A captura de tela mostra o aplicativo com três recursos. O bot está realçado.

Como você já se preparou para criar esses aplicativos, você pode configurar um novo projeto do Teams para criar o aplicativo de bot de chat de IA. Neste tutorial, você aprenderá:

Crie seu workspace de projeto de bot.
Faça um tour pelo código-fonte do aplicativo bot.

Criar seu workspace de projeto de bot

Se os pré-requisitos estiverem em vigor, vamos começar!

Abra o Visual Studio Code.
Selecione o ícone Kit de Ferramentas do Teams na Barra de Atividades Visual Studio Code.
Selecione Criar um novo aplicativo.
Selecione Bot.
Selecione Bot de Chat de IA. Se você precisar de uma funcionalidade diferente para o bot, selecione a opção necessária.
Selecione JavaScript.
Selecione Pasta Padrão.

Para alterar o local padrão, siga estas etapas:
1. Selecione Procurar.
2. Selecione o local para o workspace do projeto.
3. Selecione Selecionar Pasta.
4. Insira um nome adequado para seu aplicativo e selecione a chave Enter .
  
  Uma caixa de diálogo é exibida, em que você precisa escolher sim ou não para confiar nos autores dos arquivos nesta pasta.
  
  Agora, você criou com êxito o workspace do projeto do bot de chat de IA.

Faça um tour pelo código-fonte do aplicativo bot

Depois de concluir o scaffolding, explore os diretórios e arquivos do projeto na seção EXPLORER do Visual Studio Code.

A captura de tela mostra a estrutura da pasta de bot de exemplo do Teams Toolkit.

Nome da pasta ou do arquivo	Conteúdos
`env/.env.testtool`	O arquivo de configuração com variáveis de ambiente que podem ser comprometidas com o Git.
`env/.env.testtool.user`	O arquivo de configuração com variáveis de ambiente, incluindo credenciais, que não estão comprometidas com o Git por padrão.
`appPackage`	Arquivos de modelo de manifesto de aplicativo e ícones de aplicativo (color.png e outline.png).
`appPackage/manifest.json`	Manifesto do aplicativo para executar o aplicativo em ambiente local e remoto.
`src/app.js`	Manipula as lógicas de negócios para o bot de chat de IA.
`teamsapp.yml`	Este é o arquivo de projeto main Teams Toolkit. O arquivo de projeto define duas coisas primárias: propriedades, configuração e definições de estágio.
`teamsapp.local.yml`	Isso substitui `teamsapp.yml` as ações que permitem a execução local e a depuração.
`teamsapp.testtool.yml`	Isso se substitui por `teamsapp.yml` ações que habilitam a execução local e a depuração na Ferramenta de Teste.

Compilar e executar seu aplicativo de bot de chat de IA

4 minutos restantes

Depois de configurar o workspace do projeto com o Teams Toolkit, crie seu projeto de bot de chat de IA.

Criar chave de IA aberta e ponto de extremidade para seu bot de chat de IA

Acesse o portal do Azure.
Selecione Criar um recurso e pesquise a IA aberta do Azure.
Selecione Azure Open AI e selecione Criar.
Preencha os detalhes necessários e selecione Avançar.
Selecione Todas as redes, incluindo a Internet, podem acessar esse recurso e, em seguida, selecionar Avançar.
Preencha os detalhes necessários e selecione Avançar.
Selecione Criar.

Você criou com êxito chave e ponto de extremidade para seu bot de chat de IA.

Observação

Você também pode obter a chave da API OpenAI para depurar seu bot de chat de IA. Para obter mais informações, consulte configurar sua chave de API.

Obter chaves e ponto de extremidade do Azure Open AI

Selecione Ir para recursos.
Selecione Chaves e Ponto de Extremidade no painel esquerdo e copie o KEY e o Ponto de Extremidade. Você pode copiar KEY 1 ou KEY 2.

Salve o KEY e o Ponto de Extremidade para uso adicional.
Selecione Implantações de modelo no painel esquerdo e selecione Gerenciar Implantações.

A janela do Azure Open AI Studio é exibida.
Selecione Implantações no painel esquerdo e selecione + Criar novas implantações.
Selecione os seguintes detalhes:
1. Selecione gpt-35-turbo na lista suspensa Selecionar um modelo .
  
  Observação
  
  Há suporte apenas para o modelo gpt-35 turbo para o bot de chat de IA.
2. Selecione 0301 (Padrão) na lista suspensa versão modelo .
3. Insira o nome da implantação e selecione Criar.
Copie e salve o nome da implantação para uso adicional.

Atualizar a chave e os pontos de extremidade do Azure Open AI

Abra seu projeto em Visual Studio Code.
Em EXPLORER, acesse env.env.testtool.user> file.

Insira seu SECRET_AZURE_OPENAI_API_KEY e SECRET_AZURE_OPENAI_ENDPOINT.

...
SECRET_AZURE_OPENAI_API_KEY=<azure-openai-api-key>
SECRET_AZURE_OPENAI_ENDPOINT=<azure-openai-endpoint>

Vá para o arquivo src>app.js .
Comente o OpenAI código e descompacte o Azure OpenAI código.

Insira seu nome de implantação de IA aberta do Azure em azureDefaultDeployment.

...
// Use OpenAI
// apiKey: config.openAIKey,
// defaultModel: "gpt-3.5-turbo",

azureApiKey: config.azureOpenAIKey,
azureDefaultDeployment: "gpt-35-turbo",
azureEndpoint: config.azureOpenAIEndpoint,
...

Depurar e executar seu aplicativo de bot de chat de IA

No painel esquerdo, selecione EXECUTAR e DEBUG (Ctrl+Shift+D) e selecione Depurar na Ferramenta de Teste (Versão Prévia) na lista suspensa.
A Ferramenta de Teste abre seu bot de chat de IA em uma página da Web.

Gatilhos de atividade

3 minutos restantes

Você pode simular uma atividade na Ferramenta de Teste usando gatilhos de atividade. Há dois tipos de gatilhos de atividade:

Gatilhos de atividade predefinidos
Gatilhos de atividade personalizados

Gatilhos de atividade predefinidos

A Ferramenta de Teste fornece gatilhos de atividade predefinidos para testar as funcionalidades do bot.

Categoria	Atividade	Manipulador
Atividade de atualização de instalação do gatilho	Instalar bot Desinstalar bot	`onInstallationUpdate` `onInstallationUpdateAdded` `onInstallationUpdate` `onInstallationUpdateRemove`
Atividade de atualização de conversa de gatilho	Adicionar usuário Adicionar bot Adicionar canal	`onMembersAdded` `onTeamsMembersAddedEvent` `onMembersAdded` `onTeamsMembersAddedEvent` `onTeamsChannelCreatedEvent`
	Remover usuário Remover bot Remover canal Remover equipe	`onMembersRemoved` `onTeamsMembersRemovedEvent` `onMembersRemoved` `onTeamsMembersRemovedEvent` `onTeamsChannelDeletedEvent` `onTeamsTeamDeletedEvent`
	Renomear canal Renomear equipe	`onTeamsChannelRenamedEvent` `onTeamsTeamRenamedEvent`

Observação

Todos os tipos de atividades não estão disponíveis em todos os escopos. Por exemplo, você não pode adicionar ou remover um canal em um chat pessoal ou um chat em grupo.

Os gatilhos de atividade predefinidos estão disponíveis no menu Simular uma Atividade na Ferramenta de Teste.

Para simular uma atividade Adicionar usuário , siga estas etapas:

Em Ferramenta de Teste, vá para Simular umusuário de Adicionar Atividades>.

Uma caixa de diálogo aparece para visualizar o manipulador de atividades.
Selecione Enviar atividade.

O bot envia a seguinte resposta:

Gatilhos de atividade personalizados

Você pode usar a atividade personalizada para personalizar gatilhos de atividade, por exemplo, reactionsAdded para atender aos requisitos do seu aplicativo bot. A Ferramenta de Teste preenche automaticamente as propriedades necessárias da atividade. Você também pode modificar o tipo de atividade e adicionar mais propriedades.

Selecione Simular uma atividadepersonalizada de atividade.>

Adicione messageReaction para personalizar a atividade na type propriedade:

{
  "type": "messageReaction",
  "reactionsAdded": [
    {
      "type": "like"
    }
  ],
  "replyToId": "d60fd1cb-3e8f-44ef-849c-404806ba1b47"
}

Selecione Enviar atividade.

O bot envia um onReactionsAdded manipulador em resposta.

Desafio completo

2 minutos restantes

Você veio com uma saída como esta?

Parabéns!

100% concluído!

Você criou com êxito um aplicativo de bot de chat de IA. Agora, você aprendeu a depurar seu aplicativo de bot de chat de IA na Ferramenta de Teste de Aplicativo do Teams.