Erstellen von Nachrichtenerweiterungen mithilfe der API

Hinweis

API-basierte Nachrichtenerweiterungen unterstützen nur Suchbefehle.

Nachrichtenerweiterungen, die mit der API (API-basiert) erstellt wurden, verwenden einen Webdienst zum Verwalten von Benutzeranforderungen und -antworten und erfordern keine Botregistrierung. Sie können API-basierte Nachrichtenerweiterungen mithilfe des Entwicklerportals für Teams und des Teams-Toolkits für Visual Studio Code, der Befehlszeilenschnittstelle (CLI) oder Visual Studio konfigurieren und bereitstellen. API-basierte Nachrichtenerweiterungen helfen Ihren Apps, direkt mit Daten, Apps und Diensten von Drittanbietern zu interagieren, wodurch die Funktionen verbessert werden. Die API-basierte Nachrichtenerweiterung ermöglicht Folgendes:

• Rufen Sie Echtzeitinformationen ab, z. B. aktuelle Nachrichten zu einer Produkteinführung.
• Abrufen von wissensbasierten Informationen, z. B. die Entwurfsdateien meines Teams in Figma.

Sie können eine API-basierte Nachrichtenerweiterung mithilfe eines OAD-Dokuments (OpenAPI Description) erstellen. Nachdem Sie ein OpenAPI-Beschreibungsdokument erstellt haben, verwenden Sie das OpenAPI-Beschreibungsdokument, um den Clientcode zu generieren und in das Projekt Ihrer App zu integrieren. Create oder generieren Sie eine Antwortrenderingvorlage, um die Antworten aus der API zu verwalten.

Weitere Informationen zum Erstellen einer API-basierten Nachrichtenerweiterung mithilfe des Teams Toolkits finden Sie im Video:

Voraussetzungen

Bevor Sie beginnen, stellen Sie sicher, dass Sie die folgenden Anforderungen erfüllen:

• OpenAPI Description (OAD)
• Aktualisieren des App-Manifests

OpenAPI-Beschreibung

Die OpenAPI-Beschreibung (OAD) ist die Branchenstandardspezifikation, die die Struktur und Gliederung von OpenAPI-Dateien detailliert beschreibt. Es handelt sich um ein sprachunabhängiges, für Menschen lesbares Format zum Beschreiben von APIs. Sowohl Menschen als auch Computer können die openAPI-Beschreibung problemlos lesen und schreiben. Das Schema ist maschinenlesbar und kann entweder in YAML oder JSON dargestellt werden. Vor dem Erstellen einer API-gesteuerten Nachrichtenerweiterung ist ein OpenAPI-Beschreibungsdokument erforderlich.

Antwortrenderingvorlage

Eine Antwortrenderingvorlage ordnet JSON-Antworten einer Vorschauversion Karte und einer adaptiven Karte zu. Wenn ein Benutzer ein Suchergebnis auswählt, werden die Vorschaukarten als Ergebnisse angezeigt. Die Vorschauversion Karte wird dann im Feld zum Verfassen von Nachrichten zu einer adaptiven Karte erweitert.

Jeder Suchbefehl muss über eine entsprechende Antwortrenderingvorlage verfügen, und jeder Befehl muss einem Vorgang in der OpenAPI-Beschreibung entsprechen. Allerdings muss nicht jeder in einer OpenAPI-Beschreibung definierte Vorgang ein Befehl sein. Die Antwortrenderingvorlage besteht aus einer Vorlage für adaptive Karten, einer Vorschau Karte Vorlage und Metadaten und muss dem Schema der Antwortrenderingvorlage entsprechen, das unter gehostet wirdhttps://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.ResponseRenderingTemplate.schema.json.

Aktualisieren des App-Manifests

Aktualisieren Sie das App-Manifest (zuvor als Teams-App-Manifest bezeichnet) mit der composeExtensions -Eigenschaft. Der folgende Code ist ein Beispiel für das App-Manifest mit der composeExtensions -Eigenschaft:

{
  "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"
        }
      ]
    }
  ]
}

Nächster Schritt

Erstellen einer API-basierten Nachrichtenerweiterung