Générer des extensions de message à l’aide de l’API

Remarque

Les extensions de message basées sur l’API prennent uniquement en charge les commandes de recherche.

Les extensions de message générées à l’aide de l’API (basées sur l’API) utilisent un service web pour gérer les demandes et les réponses des utilisateurs et ne nécessitent pas d’inscription de bot. Vous pouvez configurer et déployer des extensions de message basées sur l’API à l’aide du Portail des développeurs pour Teams et du Kit de ressources Teams pour Visual Studio Code, de l’interface de ligne de commande (CLI) ou de Visual Studio. Les extensions de message basées sur l’API aident vos applications à interagir directement avec des données, des applications et des services tiers, ce qui améliore leurs fonctionnalités. Avec l’extension de message basée sur l’API, vous pouvez :

• Récupérer des informations en temps réel, telles que la couverture des dernières actualités sur le lancement d’un produit.
• Récupérez des informations basées sur les connaissances, par exemple, les fichiers de conception de mon équipe dans Figma.

Vous pouvez créer une extension de message basée sur l’API à l’aide d’un document OAD (OpenAPI Description). Une fois que vous avez créé un document de description OpenAPI, utilisez le document Description OpenAPI pour générer et intégrer le code client dans le projet de votre application. Create ou générer un modèle de rendu de réponse pour gérer les réponses de l’API.

Regardez la vidéo pour en savoir plus sur la création d’une extension de message basée sur l’API à l’aide de Teams Toolkit :

Configuration requise

Avant de commencer, veillez à respecter les exigences suivantes :

• Description OpenAPI (OAD)
• Mettre à jour le manifeste de l’application

OpenAPI Description

La description OpenAPI (OAD) est la spécification standard qui détaille la structure et la structure des fichiers OpenAPI. Il s’agit d’un format indépendant du langage et lisible par l’homme pour décrire les API. Les humains et les machines peuvent facilement lire et écrire la description openAPI. Le schéma est lisible par l’ordinateur et peut être représenté en YAML ou JSON. Un document De description OpenAPI est requis avant de créer une extension de message pilotée par l’API.

Modèle de rendu de réponse

Un modèle de rendu de réponse mappe les réponses JSON à un aperçu carte et à une carte adaptative. Lorsqu’un utilisateur sélectionne un résultat de recherche, les cartes d’aperçu apparaissent sous forme de résultats. L’aperçu carte développe ensuite une carte adaptative dans la zone de composition de message.

Chaque commande de recherche doit avoir un modèle de rendu de réponse correspondant, et chaque commande doit correspondre à une opération dans la description OpenAPI. Toutefois, toutes les opérations définies dans une description OpenAPI ne doivent pas être une commande. Le modèle de rendu de réponse se compose d’un modèle de carte adaptative, d’un aperçu carte modèle et de métadonnées et doit être conforme au schéma du modèle de rendu de réponse hébergé sur https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.ResponseRenderingTemplate.schema.json.

Mettre à jour le manifeste de l’application

Mettez à jour le manifeste d’application (précédemment appelé manifeste d’application Teams) avec la composeExtensions propriété . Le code suivant est un exemple de manifeste d’application avec la composeExtensions propriété :

{
  "composeExtensions": [
    {
      "composeExtensionType": "apiBased",
      "apiSpecificationFile": "aitools-openapi.yml",
      "commands": [
        {
          "id": "searchTools",
          "type": "query",
          "context": [
            "compose",
            "commandBox"
          ],
          "title": "search for AI tools",
          "description": "search for AI tools",
          "parameters": [
            {
              "name": "search",
              "title": "search query",
              "description": "e.g. search='tool to create music'"
            }
          ],
          "apiResponseRenderingTemplateFile": "response-template.json"
        }
      ]
    }
  ]
}

Étape suivante

Générer une extension de message basée sur l’API