Crie plug-ins de API de uma API existente para o Microsoft 365 Copilot

Importante

Plugins só são suportados como ações em agentes declarativos. Eles não estão habilitados no Microsoft 365 Copilot.

Os plug-ins de API conectam sua API REST existente ao Microsoft 365 Copilot. Você pode usar o Microsoft 365 Agents Toolkit para gerar um plug-in de uma API REST existente com uma especificação OpenAPI.

Pré-requisitos

Dica

Para obter os melhores resultados, certifique-se de que sua especificação OpenAPI siga as diretrizes detalhadas em Como tornar um documento OpenAPI eficaz na extensão do Copilot.

Para acompanhar este guia, baixe a API de exemplo do Controlador de Orçamento e configure-a para ser executada em seu computador de desenvolvimento local. Crie o exemplo pelo menos uma vez para gerar o arquivo BudgetTracker.json para a API.

Crie o plug-in

Observação

As capturas de tela e referências à interface do usuário do Microsoft 365 Agents Toolkit neste documento foram geradas usando a versão de lançamento mais recente, 6.0. As versões de pré-lançamento do Agents Toolkit podem ser diferentes da interface do usuário neste documento.

Os plug-ins de API são um arquivo ZIP que contém os arquivos a seguir.

  • A especificação OpenAPI para a API REST.
  • Um manifesto de plug-in que faz referência à especificação OpenAPI incluída e descreve as operações disponíveis, o método de autenticação e os formatos de resposta.

  1. Abra o Visual Studio Code. Se o Agents Toolkit ainda não estiver instalado, consulte Instalar o Agents Toolkit para obter instruções de instalação.

  2. Selecione o ícone do Microsoft 365 Agents Toolkit na Barra de Atividades à esquerda.

  3. Selecione Criar um novo agente/aplicativo no painel de tarefas Kit de ferramentas para agentes.

    Uma captura de tela da interface do Kit de Ferramentas de Agentes

  4. Selecione o Agente Declarativo.

  5. Selecione Adicionar uma Ação e, em seguida, selecione Iniciar com um Documento de Descrição da OpenAPI.

  6. Selecione Procurar e navegue até o local da especificação OpenAPI no exemplo Budget Tracker, localizado em ./openapi/BudgetTracker.json.

  7. Selecione todas as operações a serem habilitadas para o plug-in.

    A interface do usuário do Agents Toolkit para selecionar operações

  8. Escolha um local para o projeto de plug-in de API.

  9. Digite Budget Tracker como um nome para o plug-in.

Depois de concluir essas etapas, o Agents Toolkit gera os arquivos necessários para o plug-in e abre uma nova janela do Visual Studio Code com o projeto do plug-in carregado.

Observação

Se o seu servidor de identidade exigir PKCE (Chave de Prova para Troca de Código), remova o comentário da linha a seguir no m365agents.yml no projeto de plug-in da API.

# isPKCEEnabled: true

Empacotar e fazer o sideload do plug-in

  1. Abra o projeto de plug-in no Visual Studio Code.

  2. Selecione o ícone do Microsoft 365 Agents Toolkit na Barra de Atividades à esquerda.

  3. No painel Contas , selecione Entrar no Microsoft 365. (Se você já estiver conectado, continue para a próxima etapa).

  4. Confirme se o Upload de aplicativo personalizado habilitado e o Acesso ao Copilot habilitado são exibidos em sua conta do Microsoft 365. Caso contrário, marque com o administrador da sua organização. Consulte Requisitos para opções de extensibilidade do Copilot para obter detalhes.

  5. No painel Ciclo de Vida , selecione Provisionar.

  6. Quando solicitado a inserir a ID do cliente para registro OAuth..., insira a ID do cliente do plug-in.

  7. Quando solicitado a inserir o segredo do cliente para o registro OAuth..., insira o segredo do cliente do plug-in.

  8. Leia a mensagem na caixa de diálogo e selecione Confirmar para continuar.

  9. Aguarde até que o kit de ferramentas informe que o provisionamento foi concluído.

    A mensagem do Kit de Ferramentas de Agentes confirmando o provisionamento bem-sucedido

Seu plug-in agora está disponível para teste com sua conta de usuário no Microsoft 365 Copilot no Microsoft Teams.

Usar o plug-in

  1. Abra o Teams no seu navegador e entre com a conta do Microsoft 365 usada para carregar seu plug-in.

  2. Selecione Chat na Barra de Atividades à esquerda.

  3. Selecione Copilot no painel de Chat.

  4. Selecione Rastreador de Orçamento na lista Agentes à direita. Se a lista não estiver disponível, selecione o ícone Chats e mais do Copilot no canto superior direito.

    Uma captura de tela da lista de Agentes no Microsoft Teams

  5. Faça uma pergunta sobre orçamentos. Por exemplo, experimente How much is left in the Fourth Coffee lobby renovation budget?. Quando solicitado, escolha Sempre permitir ou Permitir uma vez para continuar.

  6. Quando solicitado a entrar, selecione Entrar no Rastreador de Orçamento.

  • Last updated on