Guia de introdução para utilizar a API de Assistentes com a biblioteca de IA do Teams

Comece a utilizar a OpenAI ou a API de Assistentes OpenAI do Azure com a biblioteca de IA do Teams no tutor de Matemática assistente exemplo. Este guia utiliza a ferramenta Intérprete de Código OpenAI para o ajudar a criar uma assistente especializada em matemática. O bot utiliza o modelo gpt-3.5-turbo para conversar com os utilizadores do Microsoft Teams e responder de forma educada e respeitosa, mantendo-se dentro do âmbito da conversação.

Pré-requisitos

Para começar, certifique-se de que tem as seguintes ferramentas:

Instalar	Para usar...
Visual Studio Code	Ambientes de compilação JavaScript, TypeScript ou C Sharp. Utilize a versão mais recente.
Kit de ferramentas do Teams	O Microsoft Visual Studio Code extensão que cria um projeto estruturado para a sua aplicação. Utilize a versão mais recente.
Git	O Git é um sistema de controlo de versões que o ajuda a gerir diferentes versões de código num repositório.
Node.js	Ambiente de runtime do JavaScript de back-end. Para obter mais informações, veja Node.js tabela de compatibilidade de versões para o tipo de projeto.
Microsoft Teams	Para colaborar com todas as pessoas, pode trabalhar com o através de aplicações para conversas, reuniões e chamadas num único local.
OpenAI ou Azure OpenAI	Primeiro, crie a chave da API OpenAI para utilizar o GPT da OpenAI. Se quiser alojar a sua aplicação ou aceder a recursos no Azure, tem de criar um serviço Azure OpenAI.
Microsoft Edge (recomendado) ou Google Chrome	Um navegador com ferramentas de desenvolvedor.
Conta de programador do Microsoft 365	Acesso à conta do Teams com as permissões adequadas para instalar uma aplicação, ativar aplicações personalizadas do Teams e ativar o carregamento de aplicações personalizadas.

Se já executou os exemplos antes ou encontrou um erro de runtime, siga estes passos para começar de novo:

• Verifique todos os .env ficheiros e env/.env.*.* no exemplo e elimine quaisquer valores preenchidos automaticamente para garantir que o Teams Toolkit gera novos recursos automaticamente.
• Se não quiser que o Teams Toolkit gere o ID e a palavra-passe da aplicação, atualize o MicrosoftAppId e MicrosoftAppPassword no ficheiro com os .env seus próprios valores.
• Remova valores ou deixe os valores em branco para SECRET_BOT_PASSWORD e TEAMS_APP_UPDATE_TIME no .env ficheiro para evitar conflitos.

O Teams Toolkit aprovisiona MicrosoftAppId e recursos MicrosoftAppPassword automaticamente. Se quiser utilizar os seus próprios recursos, tem de os adicionar manualmente ao .env ficheiro. O Teams Toolkit não gera automaticamente os seguintes recursos:

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

Criar e executar a aplicação de exemplo

Introdução à biblioteca de IA do Teams com o exemplo de assistente tutor de Matemática. Permite que o localhost do seu computador execute rapidamente um exemplo baseado na biblioteca de IA do Teams.

1. Aceda ao exemplo.

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

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

3. Aceda a Visual Studio Code.

4. SelecioneAbrir Pasta de Ficheiros>.

5. Aceda à localização onde clonou o repositório teams-ai e selecione a pasta teams-ai .

6. Selecione Selecionar Pasta.

   

7. Selecione Ver>Terminal. É aberta uma janela de terminal.

8. Na janela do terminal, execute o seguinte comando para aceder à 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. Após a instalação das dependências, selecioneAbrir Pasta de Ficheiros>.

12. Aceda a teams-ai > js > samples > 04.ai-apps > d.assistants-mathBot e selecione Selecionar Pasta. Todos os ficheiros do tutor de Matemática assistente exemplo estão listados na secção EXPLORADOR no Visual Studio Code.

13. Em EXPLORADOR, duplique o sample.env ficheiro e atualize o ficheiro duplicado para .env.

14. Atualize os seguintes passos com base nos serviços de IA que selecionar.

    Tecla OpenAI

    1. Aceda à env pasta e atualize o seguinte código no ./env/.env.local.user ficheiro:

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

    2. Aceda à infra pasta e certifique-se de que as seguintes linhas no azure.bicep ficheiro são comentadas:

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

    Azure OpenAI

    1. Aceda à env pasta e atualize o seguinte código no ./env/.env.local.user ficheiro:

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

    1. Aceda ao teamsapp.local.yml ficheiro e modifique o último passo para utilizar as 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. Aceda à infra pasta e certifique-se de que as seguintes linhas no azure.bicep ficheiro são comentadas:

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

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

             "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 Teams Toolkit.

17. Em CONTAS, inicie sessão no seguinte:

    • Conta do Microsoft 365
    • Conta do Azure

18. Para depurar a sua aplicação, selecione a chave F5 .

    Um separador do browser abre um cliente Web do Teams a pedir para adicionar o bot ao seu inquilino.

19. Selecione Adicionar.

    

    É aberta uma janela de chat.

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

    

Observação

Se estiver a criar um bot pela primeira vez, recomenda-se que utilize a extensão do Teams Toolkit para Visual Studio Code criar um bot. Consulte Criar a sua primeira aplicação de bot com JavaScript.

Ferramentas adicionais

Também pode utilizar as seguintes ferramentas para executar e configurar um exemplo:

1. CLI do Teams Toolkit: pode utilizar a CLI do Teams Toolkit para criar e gerir aplicações do Microsoft Teams a partir da linha de comandos. Para obter mais informações, veja Instruções de configuração da CLI do Teams Toolkit.

2. Bot Framework Emulator: a Bot Framework Emulator é uma aplicação de ambiente de trabalho que lhe permite testar e depurar o bot localmente. Pode ligar ao bot ao introduzir o URL do ponto final do bot e o ID e a palavra-passe da aplicação Microsoft. Em seguida, pode enviar mensagens para o bot e ver as respetivas respostas em tempo real. Para obter mais informações, veja Bot Framework Emulator instruções de configuração.

3. Configuração manual: se preferir configurar os seus recursos manualmente, pode fazê-lo seguindo as instruções fornecidas pelos respetivos serviços. Para obter mais informações, veja manual set up instructions (Instruções de configuração manual).

Próxima etapa

API de Assistentes