Guia de início rápido para usar a API de Assistentes com a biblioteca de IA do Teams

Comece a usar a API de Assistentes OpenAI ou Azure OpenAI com a biblioteca de IA do Teams em Matemática assistente exemplo. Este guia usa a ferramenta Intérprete de Código OpenAI para ajudá-lo a criar uma assistente especializada em matemática. O bot usa o modelo gpt-3.5 turbo para conversar com usuários do Microsoft Teams e responder de maneira educada e respeitosa, mantendo-se dentro do escopo da conversa.

Pré-requisitos

Para começar, verifique se você tem as seguintes ferramentas:

Instalar	Para usar...
Visual Studio Code	Ambientes de build JavaScript, TypeScript ou C Sharp. 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 a versão mais recente.
Git	O Git é um sistema de controle de versão que ajuda você a gerenciar diferentes versões de código em um repositório.
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.
Microsoft Teams	Para colaborar com todos, você trabalha com aplicativos para chat, reuniões e chamadas em um só lugar.
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.
Conta de desenvolvedor do Microsoft 365	Acesse a conta do Teams com as permissões apropriadas para instalar um aplicativo e habilitar aplicativos personalizados do Teams e ativar o carregamento personalizado do aplicativo.

Se você já tiver executado os exemplos antes ou encontrado um erro de runtime, siga estas etapas para começar de novo:

• Verifique todos os arquivos e env/.env.*.* no exemplo e exclua todos os valores preenchidos automaticamente para garantir que o .env Teams Toolkit gere novos recursos para você.
• Se você não quiser que o Teams Toolkit gere a ID e a senha do aplicativo, atualize o MicrosoftAppId e MicrosoftAppPassword no .env arquivo com seus próprios valores.
• Remova valores ou deixe os valores em branco para SECRET_BOT_PASSWORD e TEAMS_APP_UPDATE_TIME no .env arquivo para evitar conflitos.

O Teams Toolkit provisiona MicrosoftAppId e MicrosoftAppPassword recursos automaticamente. Se você quiser usar seus próprios recursos, precisará adicioná-los manualmente ao .env arquivo. O Teams Toolkit não gera automaticamente os seguintes recursos:

• Uma chave OpenAI ou OpenAI do Azure
• Um banco de dados ou opções de armazenamento semelhantes

Compilar e executar o aplicativo de exemplo

Introdução à biblioteca de IA do Teams usando o exemplo de assistente de tutor de matemática. Ele permite que o localhost do computador execute rapidamente um exemplo baseado em biblioteca de IA do Teams.

1. Vá para o exemplo.

2. Execute o seguinte comando para clonar o repositório:

   git clone https://github.com/microsoft/teams-ai.git
   

3. Vá para Visual Studio Code.

4. Selecione Arquivo>Abrir Pasta.

5. Acesse o local em que você clonou o repositório teams-ai e selecione a pasta teams-ai .

6. Selecione Selecionar Pasta.

   

7. Selecione Exibir>Terminal. Uma janela de terminal é aberta.

8. Na janela do terminal, execute o seguinte comando para acessar a pasta js :

   cd .\js\
   

9. Execute o seguinte comando para instalar dependências:

   yarn install
   

10. Execute o seguinte comando para criar dependências:

    yarn build
    

11. Depois que as dependências forem instaladas, selecione Arquivo>Abrir Pasta.

12. Acesse teams-ai > js > samples > 04.ai-apps > d.assistants-mathBot e selecione Selecionar Pasta. Todos os arquivos do exemplo de assistente de tutor de matemática são listados na seção EXPLORER em Visual Studio Code.

13. Em EXPLORER, duplica o sample.env arquivo e atualize o arquivo duplicado para .env.

14. Atualize as etapas a seguir com base nos serviços de IA selecionados.

    Chave OpenAI

    1. Vá para pasta env e atualize o seguinte código no ./env/.env.local.user arquivo:

       SECRET_OPENAI_KEY=<your OpenAI key>
       ASSISTANT_ID=<your Assistant ID>
       

    2. Acesse a infra pasta e verifique se as seguintes linhas no azure.bicep arquivo são comentadas:

           // {
           //  name: 'AZURE_OPENAI_KEY'
           //  value: azureOpenAIKey
           // }
           // {
           //  name: 'AZURE_OPENAI_ENDPOINT'
           //  value: azureOpenAIEndpoint
           // }
       

    Azure OpenAI

    1. Vá para pasta env e atualize o seguinte código no ./env/.env.local.user arquivo:

       SECRET_AZURE_OPENAI_KEY=<your Azure OpenAI key>
       SECRET_AZURE_OPENAI_ENDPOINT=<your Azure OpenAI Endpoint>
    

    1. Vá para o teamsapp.local.yml arquivo e modifique a última etapa para usar variáveis do Azure OpenAI:

       - uses: file/createOrUpdateEnvironmentFile
       with:
          target: ./.env
          envs:
          BOT_ID: ${{BOT_ID}}
          BOT_PASSWORD: ${{SECRET_BOT_PASSWORD}}
          #OPENAI_KEY: ${{SECRET_OPENAI_KEY}}
          AZURE_OPENAI_KEY: ${{SECRET_AZURE_OPENAI_KEY}}
          AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}}
       

    2. Acesse a infra pasta e verifique se as seguintes linhas no azure.bicep arquivo são comentadas:

           // {
           //   name: 'OPENAI_KEY'
           //   value: openAIKey
           // }
       

    3. Acesse e substitua as linhas de 20 a 25 pelo seguinte código:infra>azure.parameters.json

             "azureOpenAIKey": {
             "value": "${{SECRET_AZURE_OPENAI_KEY}}"
             },
             "azureOpenAIEndpoint": {
             "value": "${{SECRET_AZURE_OPENAI_ENDPOINT}}"
             }
       

15. Copie o exemplo para um novo diretório que não seja um subdiretório de teams-ai.

16. No painel esquerdo, selecione Kit de Ferramentas do Teams.

17. Em CONTAS, entre no seguinte:

    • Conta do Microsoft 365
    • Conta do Azure

18. Para depurar seu aplicativo, selecione a chave F5 .

    Uma guia do navegador abre um cliente Web do Teams solicitando adicionar o bot ao seu locatário.

19. Selecione Adicionar.

    

    Uma janela de chat é aberta.

20. Na área de composição de mensagens, envie uma mensagem para invocar o bot.

    

Observação

Se você estiver criando um bot pela primeira vez, é recomendável usar a extensão do Teams Toolkit para Visual Studio Code criar um bot, consulte criar seu primeiro aplicativo bot usando JavaScript.

Ferramentas adicionais

Você também pode usar as seguintes ferramentas para executar e configurar um exemplo:

1. CLI do Teams Toolkit: você pode usar a CLI do Teams Toolkit para criar e gerenciar aplicativos do Microsoft Teams a partir da linha de comando. Para obter mais informações, consulte Instruções de configuração da CLI do Teams Toolkit.

2. Bot Framework Emulator: o Bot Framework Emulator é um aplicativo de área de trabalho que permite testar e depurar seu bot localmente. Você pode se conectar ao bot inserindo a URL do ponto de extremidade do bot e a ID do aplicativo microsoft e a senha. Em seguida, você pode enviar mensagens para o bot e ver suas respostas em tempo real. Para obter mais informações, consulte Bot Framework Emulator configurar instruções.

3. Configuração manual: se você preferir configurar seus recursos manualmente, poderá fazê-lo seguindo as instruções fornecidas pelos respectivos serviços. Para obter mais informações, consulte instruções de configuração manual.

Próxima etapa

API de assistentes