Compartir a través de

Compilación de complementos de API a partir de una API existente para Microsoft 365 Copilot

Importante

Los complementos de API solo se admiten como acciones dentro de agentes declarativos. No se habilitan en Microsoft 365 Copilot.

Los complementos de API conectan la API REST existente a Microsoft 365 Copilot. Puede usar microsoft 365 Agents Toolkit (una evolución del kit de herramientas de Teams) para generar un complemento a partir de una API REST existente con una especificación de OpenAPI.

Requisitos previos

Sugerencia

Para obtener los mejores resultados, asegúrese de que la especificación de OpenAPI sigue las directrices que se detallan en How to make an OpenAPI document effective in extending Copilot (Cómo hacer que un documento de OpenAPI sea efectivo para ampliar Copilot).

Para seguir esta guía, descargue la API de ejemplo de Budget Tracker y configúrela para que se ejecute en la máquina de desarrollo local. Compile el ejemplo al menos una vez para generar el archivo BudgetTracker.json para la API.

Creación del complemento

Nota:

Las capturas de pantalla y las referencias a la interfaz de usuario del Kit de herramientas de agentes de Microsoft 365 (una evolución del kit de herramientas de Teams) de este documento se generaron con la versión más reciente, 6.0. Las versiones preliminares del kit de herramientas de agentes pueden diferir de la interfaz de usuario de este documento.

Los complementos de API son un archivo ZIP que contiene los siguientes archivos.

  • Especificación de OpenAPI para la API REST.
  • Manifiesto de complemento de API que hace referencia a la especificación openAPI incluida y describe las operaciones disponibles, el método de autenticación y los formatos de respuesta.

  1. Abrir Visual Studio Code. Si el kit de herramientas de agentes aún no está instalado, consulte Instalación del kit de herramientas de agentes para obtener instrucciones de instalación.

  2. Seleccione el icono microsoft 365 Agents Toolkit en la barra de actividad de la izquierda.

  3. Seleccione Crear un nuevo agente o aplicación en el panel de tareas Kit de herramientas de agentes.

    Captura de pantalla de la interfaz del kit de herramientas de agentes

  4. Seleccione Agente declarativo.

  5. Seleccione Agregar una acción y, a continuación, seleccione Iniciar con un documento de descripción de OpenAPI.

  6. Seleccione Examinar y vaya a la ubicación de la especificación de OpenAPI en el ejemplo seguimiento de presupuesto, que se encuentra en ./openapi/BudgetTracker.json.

  7. Seleccione todas las operaciones que desea habilitar para el complemento.

    Interfaz de usuario del kit de herramientas de agentes para seleccionar operaciones

  8. Elija una ubicación para el proyecto del complemento de API.

  9. Escriba Budget Tracker como un nombre para el complemento.

Una vez completados estos pasos, Agents Toolkit genera los archivos necesarios para el complemento y abre una nueva ventana Visual Studio Code con el proyecto del complemento cargado.

Nota:

Si el servidor de identidades requiere la clave de prueba para el intercambio de código (PKCE), quite la marca de comentario de la siguiente línea en m365agents.yml en el proyecto del complemento de API.

# isPKCEEnabled: true

Empaquetar y transferir localmente el complemento

  1. Abra el proyecto del complemento en Visual Studio Code.

  2. Seleccione el icono microsoft 365 Agents Toolkit en la barra de actividad de la izquierda.

  3. En el panel Cuentas , seleccione Iniciar sesión en Microsoft 365. (Si ya ha iniciado sesión, continúe con el paso siguiente).

  4. Confirme que tanto la carga de aplicaciones personalizadas habilitada comoel acceso de Copilot habilitado se muestran en su cuenta de Microsoft 365. Si no lo hacen, consulte con el administrador de la organización. Consulte Requisitos para las opciones de extensibilidad de Copilot para obtener más información.

  5. En el panel Ciclo de vida , seleccione Aprovisionar.

  6. Cuando se le pida que escriba el identificador de cliente para el registro de OAuth..., escriba el identificador de cliente del complemento.

  7. Cuando se le pida que escriba el secreto de cliente para el registro de OAuth..., escriba el secreto de cliente del complemento.

  8. Lea el mensaje en el cuadro de diálogo y seleccione Confirmar para continuar.

  9. Espere a que el kit de herramientas informe de que ha terminado el aprovisionamiento.

    Mensaje del kit de herramientas de agentes que confirma el aprovisionamiento correcto

El complemento ya está disponible para probar con su cuenta de usuario en Microsoft 365 Copilot en Microsoft Teams.

Uso del complemento

  1. Abra Teams en el explorador e inicie sesión con la cuenta de Microsoft 365 que usó para cargar el complemento.

  2. Seleccione Chat en la barra de actividad de la izquierda.

  3. Seleccione Copilot en el panel Chat .

  4. Seleccione Seguimiento de presupuesto en la lista Agentes en el lado derecho. Si la lista no está disponible, seleccione el icono Chats de Copilot y más en la esquina superior derecha.

    Captura de pantalla de la lista Agentes en Microsoft Teams

  5. Haga una pregunta sobre los presupuestos. Por ejemplo, pruebe How much is left in the Fourth Coffee lobby renovation budget?. Cuando se le solicite, elija Permitir siempre o Permitir una vez para continuar.

  6. Cuando se le pida que inicie sesión, seleccione Iniciar sesión en Budget Tracker.