Définir des commandes de recherche d’extension de message

Importante

Les exemples de code de cette section sont basés sur la version 4.6 et les versions ultérieures du Kit de développement logiciel (SDK) Bot Framework. Si vous recherchez de la documentation pour les versions antérieures, consultez la section Extensions de message - Kit de développement logiciel (SDK) v3 dans le dossier Ressources de la documentation.

Les commandes de recherche d’extension de message permettent aux utilisateurs de rechercher des systèmes externes et d’insérer les résultats de cette recherche dans un message sous la forme d’une carte. Ce document vous guide sur la sélection des emplacements d’appel de commandes de recherche et l’ajout de la commande de recherche au manifeste de votre application.

Remarque

La limite de taille de la carte de résultat est de 28 Ko. La carte n’est pas envoyée si sa taille dépasse 28 Ko.

Pour savoir comment définir des commandes de recherche d’extension de message, consultez la vidéo suivante :


Sélectionner les emplacements d’appel de commande de recherche

La commande de recherche est appelée à partir de l’un des emplacements suivants ou des deux :

  • Zone de rédaction du message : boutons situés en bas de la zone de rédaction du message.
  • Zone de commande : par @mentioning dans la zone de commande.

Lorsqu’une commande de recherche est appelée à partir de la zone de rédaction du message, l’utilisateur envoie les résultats à la conversation. Lorsqu’il est appelé à partir de la zone de commande, l’utilisateur interagit avec la carte obtenue ou la copie pour une utilisation ailleurs.

L’image suivante affiche les emplacements d’appel de la commande de recherche :

Capture d’écran montrant les emplacements d’appel d’une commande de recherche dans un canal Teams.

Ajouter la commande de recherche au manifeste de votre application

Pour ajouter la commande de recherche au manifeste de votre application, vous devez ajouter un nouvel composeExtension objet au niveau supérieur de votre manifeste d’application JSON. Vous pouvez ajouter la commande de recherche à l’aide du Portail des développeurs ou manuellement.

Créer une commande de recherche à l’aide du portail des développeurs

La condition préalable à la création d’une commande de recherche est que vous devez déjà avoir créé une extension de message. Pour plus d’informations sur la création d’une extension de message, consultez créer une extension de message.

Pour créer une commande d’action

  1. Ouvrez le Portail des développeurs à partir du client Microsoft Teams et sélectionnez l’onglet Applications. Si vous avez déjà créé votre package d’application dans le Portail des développeurs, sélectionnez dans la liste. Si vous n’avez pas créé de package d’application, importez-en un existant.

  2. Après avoir importé un package d’application, sélectionnez Extensions de message sous Fonctionnalités de l’application.

  3. Pour créer une extension de message, vous avez besoin d’un bot inscrit par Microsoft. Vous pouvez utiliser un bot existant ou en créer un. Sélectionnez l’option Créer un bot , donnez un nom au nouveau bot, puis sélectionnez Créer.

    Capture d’écran montrant les options de configuration d’un bot pour une application dans le portail des développeurs Teams.

  4. Pour utiliser un bot existant, sélectionnez Sélectionner un bot existant et choisissez les bots existants dans la liste déroulante, ou sélectionnez Entrer un ID de bot si vous avez déjà créé un ID de bot.

  5. Sélectionnez l’étendue de l’extension de messagerie, puis sélectionnez Enregistrer.

  6. Sélectionnez Ajouter une commande dans la section Commande pour inclure les commandes qui déterminent le comportement de l’extension de message. L’image suivante affiche l’ajout de commande pour l’extension de message :

    Capture d’écran montrant comment ajouter une commande dans le portail des développeurs Teams pour définir le comportement de l’extension de message.

  7. Sélectionnez Rechercher , puis entrez ID de commande, Titre de la commande et Description de la commande.

  8. Entrez tous les paramètres et sélectionnez le type d’entrée dans la liste déroulante.

    Capture d’écran montrant comment ajouter un paramètre pour définir votre commande dans le portail des développeurs Teams pour une extension de message.

  9. Sélectionnez Ajouter un domaine sous Liens de préversion.

  10. Entrez domaine valide, puis sélectionnez Ajouter.

    Capture d’écran montrant comment ajouter un domaine valide à votre extension de messagerie pour le déploiement de liens.

  11. Sélectionnez Enregistrer.

    Capture d’écran montrant comment enregistrer tous vos paramètres et paramètres pour votre extension de message.

Pour ajouter des paramètres supplémentaires

  1. Sélectionnez ellipse sous la section de commande, puis sélectionnez Modifier le paramètre.

    Captures d’écran montrant comment modifier les paramètres de votre extension de message.

  2. Sélectionnez Ajouter des paramètres et entrez tous les paramètres.

    Capture d’écran montrant comment ajouter des paramètres supplémentaires pour votre extension de message.

Créer une commande de recherche manuellement

Pour ajouter manuellement votre commande de recherche d’extension de message au manifeste de votre application, vous devez ajouter les paramètres suivants à votre composeExtension.commands tableau d’objets :

Nom de la propriété Objectif Obligatoire ? Version minimale du manifeste
id Cette propriété est un ID unique que vous affectez à la commande de recherche. La demande de l’utilisateur inclut cet ID. Oui 1.0
title Cette propriété est un nom de commande. Cette valeur apparaît dans l’interface utilisateur. Oui 1.0
description Cette propriété est un texte d’aide indiquant l’action de cette commande. Cette valeur apparaît dans l’interface utilisateur. Oui 1.0
type Cette propriété doit être un query. Non 1.4
initialRun Si cette propriété a la valeur true, cela indique que cette commande doit être exécutée dès que l’utilisateur sélectionne cette commande dans l’interface utilisateur. Non 1.0
context Cette propriété est un tableau facultatif de valeurs qui définit le contexte dans lequel l’action de recherche est disponible. Les valeurs possibles sont message, compose ou commandBox. La valeur par défaut est ["compose", "commandBox"]. Non 1,5

Vous devez ajouter les détails du paramètre de recherche qui définit le texte visible par votre utilisateur dans le client Teams.

Nom de la propriété Objectif Est-ce obligatoire ? Version minimale du manifeste
parameters Cette propriété définit une liste statique de paramètres pour la commande . Non 1.0
parameter.name Cette propriété décrit le nom du paramètre. est parameter.name envoyé à votre service dans la demande de l’utilisateur. Oui 1.0
parameter.description Cette propriété décrit les objectifs du paramètre ou l’exemple de la valeur qui doit être fournie. Cette valeur apparaît dans l’interface utilisateur. Oui 1.0
parameter.title Cette propriété est un titre ou une étiquette de paramètre convivial court. Oui 1.0
parameter.inputType Cette propriété est définie sur le type de l’entrée requise. Les valeurs possibles incluent text, textarea, number, date, time, toggle. La valeur par défaut est définie sur text. Non 1.4
parameters.value Valeur initiale du paramètre. Actuellement, la valeur n’est pas prise en charge Non 1,5

Exemple

La section suivante est un exemple de manifeste d’application simple de l’objet composeExtensions définissant une commande de recherche :

{
...
  "composeExtensions": [
    {
      "botId": "57a3c29f-1fc5-4d97-a142-35bb662b7b23",
      "canUpdateConfiguration": true,
      "commands": [{
          "id": "searchCmd",
          "description": "Search Bing for information on the web",
          "title": "Search",
          "initialRun": true,
          "parameters": [{
            "name": "searchKeyword",
            "description": "Enter your search keywords",
            "title": "Keywords"
          }]
        }
      ]
    }
  ],
...
}

Pour obtenir le manifeste d’application complet, consultez Schéma du manifeste d’application.

Exemple de code

Exemple de nom Description .NET Node.js
Recherche d'extension des messages Teams Décrit comment définir les commandes de recherche et répondre aux recherches. View View

Guide pas à pas

Suivez le guide pas à pas pour créer une extension de message basée sur la recherche.

Étape suivante

Voir aussi