Partager via

Créer des plug-ins d’API à partir d’une API existante pour Microsoft 365 Copilot

Importante

Les plug-ins d’API sont uniquement pris en charge en tant qu’actions au sein d’agents déclaratifs. Ils ne sont pas activés dans Microsoft 365 Copilot.

Les plug-ins d’API connectent votre API REST existante à Microsoft 365 Copilot. Vous pouvez utiliser microsoft 365 Agents Toolkit pour générer un plug-in à partir d’une API REST existante avec une spécification OpenAPI.

Configuration requise

Conseil

Pour obtenir de meilleurs résultats, assurez-vous que votre spécification OpenAPI suit les instructions détaillées dans Comment rendre un document OpenAPI efficace dans l’extension de Copilot.

Pour suivre ce guide, téléchargez l’exemple d’API Budget Tracker et configurez-le pour qu’il s’exécute sur votre ordinateur de développement local. Générez l’exemple au moins une fois pour générer le fichier BudgetTracker.json pour l’API.

Créer le plug-in

Remarque

Les captures d’écran et les références à l’interface utilisateur de Microsoft 365 Agents Toolkit dans ce document ont été générées à l’aide de la dernière version de la version 6.0. Les versions préliminaires d’Agents Toolkit peuvent différer de l’interface utilisateur dans ce document.

Les plug-ins d’API sont un fichier ZIP qui contient les fichiers suivants.

  • Spécification OpenAPI pour l’API REST.
  • Manifeste de plug-in d’API qui fait référence à la spécification OpenAPI incluse et décrit les opérations disponibles, la méthode d’authentification et les formats de réponse.

  1. Ouvrez Visual Studio Code. Si Agents Toolkit n’est pas déjà installé, consultez Installer agents Toolkit pour obtenir des instructions d’installation.

  2. Sélectionnez l’icône Microsoft 365 Agents Toolkit dans la barre d’activités de gauche.

  3. Sélectionnez Créer un agent/une application dans le volet Office Agents Toolkit.

    Capture d’écran de l’interface agents Toolkit

  4. Sélectionnez Agent déclaratif.

  5. Sélectionnez Ajouter une action, puis Démarrer avec un document de description OpenAPI.

  6. Sélectionnez Parcourir et accédez à l’emplacement de la spécification OpenAPI à partir de l’exemple Budget Tracker, situé à l’adresse ./openapi/BudgetTracker.json.

  7. Sélectionnez toutes les opérations à activer pour le plug-in.

    L’interface utilisateur du Kit de ressources Agents pour sélectionner les opérations

  8. Choisissez un emplacement pour le projet de plug-in d’API.

  9. Entrez Budget Tracker comme nom pour le plug-in.

Une fois ces étapes terminées, Agents Toolkit génère les fichiers requis pour le plug-in et ouvre une nouvelle fenêtre Visual Studio Code avec le projet de plug-in chargé.

Remarque

Si votre serveur d’identité nécessite une clé de preuve pour l’échange de code (PKCE), supprimez les marques de commentaire de la ligne suivante dans m365agents.yml dans le projet de plug-in d’API.

# isPKCEEnabled: true

Empaqueter et charger une version test du plug-in

  1. Ouvrez le projet de plug-in dans Visual Studio Code.

  2. Sélectionnez l’icône Microsoft 365 Agents Toolkit dans la barre d’activités de gauche.

  3. Dans le volet Comptes , sélectionnez Se connecter à Microsoft 365. (Si vous êtes déjà connecté, passez à l’étape suivante).

  4. Vérifiez que le chargement d’application personnalisé activé et l’accès Copilot activé s’affichent sous votre compte Microsoft 365. Si ce n’est pas le cas, case activée avec votre administrateur organization. Pour plus d’informations, consultez Configuration requise pour les options d’extensibilité Copilot.

  5. Dans le volet Cycle de vie , sélectionnez Provisionner.

  6. Quand vous êtes invité à entrer l’ID client pour l’inscription OAuth... , entrez votre ID client de plug-in.

  7. Quand vous êtes invité à entrer la clé secrète client pour l’inscription OAuth..., entrez la clé secrète client de votre plug-in.

  8. Lisez le message dans la boîte de dialogue et sélectionnez Confirmer pour continuer.

  9. Attendez que le kit de ressources signale que l’approvisionnement est terminé.

    Message du Kit de ressources Agents confirmant la réussite de l’approvisionnement

Votre plug-in peut désormais être testé avec votre compte d’utilisateur dans Microsoft 365 Copilot dans Microsoft Teams.

Utiliser le plug-in

  1. Ouvrez Teams dans votre navigateur et connectez-vous avec le compte Microsoft 365 que vous avez utilisé pour charger votre plug-in.

  2. Sélectionnez Conversation dans la barre d’activité de gauche.

  3. Sélectionnez Copilot dans le volet Conversation .

  4. Sélectionnez Suivi du budget dans la liste Agents sur le côté droit. Si la liste n’est pas disponible, sélectionnez l’icône Conversations Copilot et plus dans le coin supérieur droit.

    Capture d’écran de la liste des agents dans Microsoft Teams

  5. Posez une question sur les budgets. Par exemple, essayez How much is left in the Fourth Coffee lobby renovation budget?. Lorsque vous y êtes invité, choisissez Toujours autoriser ou Autoriser une seule fois pour continuer.

  6. Lorsque vous êtes invité à vous connecter, sélectionnez Se connecter à Budget Tracker.

  • Last updated on