Compartilhar via

Criar plug-ins de API a partir de uma API existente para o Microsoft 365 Copilot

Importante

Os plug-ins de API só são suportados como ações dentro de agentes declarativos. Não estão ativados no Microsoft 365 Copilot.

Os plug-ins de API ligam a API REST existente ao Microsoft 365 Copilot. Pode utilizar o Toolkit de Agentes do Microsoft 365 para gerar um plug-in a partir de uma API REST existente com uma especificação OpenAPI.

Pré-requisitos

Dica

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

Para acompanhar este guia, transfira a API de exemplo Budget Tracker e configure-a para ser executada no seu computador de desenvolvimento local. Crie o exemplo pelo menos uma vez para gerar o ficheiro de BudgetTracker.json para a API.

Criar o plug-in

Observação

As capturas de ecrã e as referências à interface de utilizador do Toolkit de Agentes do Microsoft 365 neste documento foram geradas com a versão mais recente da Versão 6.0. As versões de Pré-lançamento do Toolkit de Agentes podem diferir da interface de utilizador neste documento.

Os plug-ins de API são um ficheiro ZIP que contém os seguintes ficheiros.

  • A especificação OpenAPI para a API REST.
  • Um manifesto de plug-in da API que referencia a 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 Toolkit de Agentes ainda não estiver instalado, veja Install Agents Toolkit (Instalar Agentes toolkit ) para obter instruções de instalação.

  2. Selecione o ícone Toolkit de Agentes do Microsoft 365 na Barra de Atividade do lado esquerdo.

  3. Selecione Criar um Novo Agente/Aplicação no painel de tarefas Toolkit agentes.

    Uma captura de ecrã da interface do Toolkit de Agentes

  4. Selecione Agente Declarativo.

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

  6. Selecione Procurar e navegue para a localização da especificação OpenAPI no exemplo Budget Tracker, localizado em ./openapi/BudgetTracker.json.

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

    IU do Toolkit de Agentes para selecionar operações

  8. Escolha uma localização para o projeto de plug-in da API.

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

Depois de concluir estes passos, o Toolkit de Agentes gera os ficheiros necessários para o plug-in e abre uma nova janela de Visual Studio Code com o projeto de plug-in carregado.

Observação

Se o servidor de identidades precisar da Chave de Prova para o Code Exchange (PKCE), anule o comentário da seguinte linha no m365agents.yml no projeto de plug-in da API.

# isPKCEEnabled: true

Empacotar e carregar o plug-in em sideload

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

  2. Selecione o ícone Toolkit de Agentes do Microsoft 365 na Barra de Atividade do lado esquerdo.

  3. No painel Contas , selecione Iniciar sessão no Microsoft 365. (Se já tiver sessão iniciada, avance para o passo seguinte).

  4. Confirme que o Carregamento de Aplicações Personalizadas Ativado e o Acesso Copilot Ativado são apresentados na sua conta do Microsoft 365. Caso contrário, marcar junto do administrador da sua organização. Veja Requisitos para opções de extensibilidade do Copilot para obter detalhes.

  5. No painel Ciclo de Vida , selecione Aprovisionar.

  6. Quando lhe for pedido para Introduzir o ID de cliente para o registo OAuth..., introduza o ID de cliente do Plug-in.

  7. Quando lhe for pedido para Introduzir o segredo do cliente para o registo OAuth..., introduza o segredo do cliente do Plug-in.

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

  9. Aguarde que o toolkit comunique o aprovisionamento concluído.

    A mensagem Do Toolkit de Agentes a confirmar o aprovisionamento com êxito

O plug-in está agora disponível para teste com a sua conta de utilizador no Microsoft 365 Copilot no Microsoft Teams.

Utilizar o plug-in

  1. Abra o Teams no seu browser e inicie sessão com a conta do Microsoft 365 que utilizou para carregar o plug-in.

  2. Selecione Conversar na Barra de Atividade do lado esquerdo.

  3. Selecione Copilot no painel Chat .

  4. Selecione Budget Tracker (Controlador de Orçamento ) na lista Agents (Agentes), no lado direito. Se a lista não estiver disponível, selecione o ícone Conversas copiais e muito mais no canto superior direito.

    Uma captura de ecrã da lista 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 lhe for pedido, selecione Permitir sempre ou Permitir uma vez para continuar.

  6. Quando lhe for pedido para iniciar sessão, selecione Iniciar sessão no Budget Tracker.

  • Last updated on