Definieren von Suchbefehlen für Nachrichtenerweiterungen

Der Suchbefehl wird von einem oder beiden der folgenden Speicherorte aufgerufen:

• Bereich zum Verfassen von Nachrichten: die Schaltflächen am unteren Rand des Bereichs zum Verfassen von Nachrichten.
• Befehlsfeld: Mit / im Befehlsfeld. Beispiel: /your-app-name. Wenn Sie das klassische Teams verwenden, wird der Suchbefehl von @mentioning im Befehlsfeld aufgerufen. Beispiel: @your-app-name.

Wenn ein Suchbefehl aus dem Nachrichtenbereich zum Verfassen aufgerufen wird, sendet der Benutzer die Ergebnisse an die Unterhaltung. Wenn ein Suchbefehl über das Befehlsfeld aufgerufen wird, interagiert der Benutzer mit dem resultierenden Karte oder kopiert ihn zur Verwendung an anderer Stelle.

Die folgende Abbildung zeigt die Aufrufspeicherorte des Suchbefehls:

Hinzufügen des Suchbefehls zu Ihrem App-Manifest

Um den Suchbefehl zu Ihrem App-Manifest (zuvor Teams-App-Manifest genannt) hinzuzufügen, müssen Sie der obersten Ebene Ihres App-Manifest-JSON-Codes ein neues composeExtensions -Objekt hinzufügen. Sie können den Suchbefehl entweder mithilfe des Entwicklerportals oder manuell hinzufügen.

Erstellen einer Suchnachrichtenerweiterung mithilfe von Bot Framework

Sie können eine Erweiterung für Suchnachrichten mithilfe des Teams-Toolkits und des Entwicklerportals für Teams erstellen.

Voraussetzungen

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

• Node.js. Die unterstützten Versionen sind 16, 18.
• Microsoft 365-Konto für die Entwicklung
• Richten Sie Ihre Entwicklungsumgebung für die Erweiterung von Teams-Apps auf Microsoft 365 ein. Nachdem Sie Ihren Entwicklermandanten bei Office 365 Targeted Release registriert haben, kann es einige Tage dauern, bis die Registrierung wirksam wird.
• Teams Toolkit Visual Studio Code-Erweiterung Version 5.2.0 und höher oder Teams Toolkit CLI.

Teams Toolkit

Führen Sie die folgenden Schritte aus, um mithilfe des Teams Toolkits eine suchbasierte Nachrichtenerweiterung zu erstellen:

1. Öffnen Sie Visual Studio Code.

2. Wählen Sie im linken Bereich Teams Toolkit aus.

3. Wählen Sie Neue App erstellen aus.

4. Wählen Sie Nachrichtenerweiterung aus.

5. Wählen Sie Benutzerdefinierte Suchergebnisse aus.

6. Wählen Sie eine Programmiersprache aus.

7. Wählen Sie Standardordner aus.

8. Geben Sie den Namen Ihrer App ein, und drücken Sie die EINGABETASTE.

   Teams Toolkit erstellt ein Gerüst für Ihr Projekt und erstellt eine Erweiterung für Suchnachrichten.

Führen Sie die folgenden Schritte aus, um die Nachrichtenerweiterung in Teams auszuführen:

1. Wählen Sie im linken Bereich Teams Toolkit aus.

2. Melden Sie sich unter KONTEN mit Ihrem Microsoft 365-Konto und Ihrem Azure-Konto an, sofern noch nicht geschehen.

   

3. Wählen Sie im linken Bereich Ausführen und Debuggen (STRG+UMSCHALT+D) aus.

4. Wählen Sie in der Dropdownliste Startkonfiguration oder Preview in Teams (Chrome)ausPreview in Teams (Edge). Teams Toolkit startet den Teams-Webclient in einem Browserfenster.

5. Wechseln Sie zu einer Chatnachricht, und wählen Sie das Symbol Aktionen und Apps aus. Suchen Sie im Flyoutmenü nach Ihrer App.

6. Wählen Sie ihre Nachrichtenerweiterung aus der Liste aus, und geben Sie einen Suchbefehl in das Suchfeld ein.

7. Wählen Sie ein Element aus der Liste aus. Das Element wird in eine adaptive Karte im Bereich zum Verfassen von Nachrichten entladen.

8. Wählen Sie Senden aus. Teams sendet das Suchergebnis als adaptive Karte in der Chatnachricht.

Entwicklerportal für Teams

1. Wechseln Sie zum Entwicklerportal für Teams.

2. Wechseln Sie zu Apps.

3. Wählen Sie Neue App erstellen aus.

4. Wählen Sie unter Konfigurieren die Option App-Features aus.

5. Wählen Sie Messaging-Erweiterung aus.

   

6. Wählen Sie unter Nachrichtenerweiterungstyp die Option Bot aus.

   1. Wenn Sie einen Haftungsausschluss erhalten, der besagt, dass die API-Nachrichtenerweiterung bereits von Benutzern verwendet wird. Möchten Sie den Nachrichtenerweiterungstyp in bot ändern?. Wählen Sie Ja, ändern aus.

   

7. Wenn Sie über einen vorhandenen Bot verfügen, wählen Sie Vorhandenen Bot aus, oder wenn Sie über eine Bot-ID verfügen, wählen Sie Bot-ID eingeben aus.

   1. Wenn Sie nicht über eine vorhandene Bot-ID verfügen, wählen Sie Bot erstellen aus, um einen neuen Bot zu erstellen, und geben Sie die Bot-ID des neuen Bots ein, den Sie erstellt haben.

8. Klicken Sie auf Speichern.

9. Wählen Sie die erforderlichen Bereiche aus.

10. Wählen Sie unter Befehldie Option + Befehl hinzufügen aus.

    Eine Befehlsdetailseite wird angezeigt.

11. Wählen Sie auf der Seite Befehlsdetails die Option Suchen als Befehlstyp aus, und aktualisieren Sie die folgenden Felder:

    • Befehls-ID
    • Befehlstitel
    • Befehlsbeschreibung
    • Kontext, in dem der Befehl funktioniert
    • Parametername
    • Parametertitel
    • Parameterbeschreibung
    • Auswählen des Eingabetyps

12. Klicken Sie auf Speichern. Eine Suchnachrichtenerweiterung mit bot framework erstellt.

13. Wählen Sie in der oberen rechten Ecke Vorschau in Teams aus. Die App wird im Teams-Desktop oder Webclient geöffnet.

Erweitern der botbasierten Nachrichtenerweiterung als Plug-In

Wichtig

Plug-Ins für Microsoft Copilot für Microsoft 365 befinden sich in der Vorschauphase und funktionieren nur in Microsoft 365 Chat in Teams.

Microsoft 365-Plug-Ins ermöglichen die Integration in verschiedene Microsoft 365-Produkte wie Teams und Outlook. Die Integration hilft Benutzern, Inhalte in externen Systemen zu suchen oder zu erstellen. Nachrichtenerweiterungs-Plug-Ins ermöglichen Microsoft Copilot für Microsoft 365 die Interaktion mit APIs anderer Software und Dienste über einen Bot. Es wird empfohlen, dass Sie Ihre vorhandenen Nachrichtenerweiterungen erstellen oder aktualisieren, um deren Nützlichkeit und Benutzerfreundlichkeit in Copilot für Microsoft 365 zu maximieren. Weitere Informationen finden Sie unter Erweitern der botbasierten Nachrichtenerweiterung als Plug-In für Copilot für Microsoft 365.

Codeausschnitte

Der folgende Code enthält ein Beispiel für suchbasierte Nachrichtenerweiterungen:

C#

• SDK-Referenz
• Beispielcodereferenz

protected override async Task<MessagingExtensionResponse> OnTeamsMessagingExtensionQueryAsync(ITurnContext<IInvokeActivity> turnContext, MessagingExtensionQuery query, CancellationToken cancellationToken)
        {
            var text = query?.Parameters?[0]?.Value as string ?? string.Empty;

            var packages = new[] {
            new { title = "A very extensive set of extension methods", value = "FluentAssertions" },
            new { title = "Fluent UI Library", value = "FluentUI" }};

            // We take every row of the results and wrap them in cards wrapped in MessagingExtensionAttachment objects.
            // The Preview is optional, if it includes a Tap, that will trigger the OnTeamsMessagingExtensionSelectItemAsync event back on this bot.
            var attachments = packages.Select(package =>
            {
                var previewCard = new ThumbnailCard { Title = package.title, Tap = new CardAction { Type = "invoke", Value = package } };
                if (!string.IsNullOrEmpty(package.title))
                {
                    previewCard.Images = new List<CardImage>() { new CardImage(package.title, "Icon") };
                }

                var attachment = new MessagingExtensionAttachment
                {
                    ContentType = HeroCard.ContentType,
                    Content = new HeroCard { Title = package.title },
                    Preview = previewCard.ToAttachment()
                };

                return attachment;
            }).ToList();

            // The list of MessagingExtensionAttachments must we wrapped in a MessagingExtensionResult wrapped in a MessagingExtensionResponse.
            return new MessagingExtensionResponse
            {
                ComposeExtension = new MessagingExtensionResult
                {
                    Type = "result",
                    AttachmentLayout = "list",
                    Attachments = attachments
                }
            };
        }

Node.js

• Beispielcodereferenz

async handleTeamsMessagingExtensionQuery(context, query) {
        const searchQuery = query.parameters[0].value;     
        const attachments = [];
                const response = await axios.get(`http://registry.npmjs.com/-/v1/search?${ querystring.stringify({ text: searchQuery, size: 8 }) }`);
                
                response.data.objects.forEach(obj => {
                        const heroCard = CardFactory.heroCard(obj.package.name);
                        const preview = CardFactory.heroCard(obj.package.name);
                        preview.content.tap = { type: 'invoke', value: { description: obj.package.description } };
                        const attachment = { ...heroCard, preview };
                        attachments.push(attachment);
                });
    
                return {
                    composeExtension:  {
                           type: 'result',
                           attachmentLayout: 'list',
                           attachments: attachments
                    }
                };
            }       
        }

Codebeispiel

Beispielname	Beschreibung	.NET	Node.js	Manifest
Teams Nachrichtenerweiterungen – Suche	In diesem Beispiel wird gezeigt, wie Sie eine suchbasierte Nachrichtenerweiterung erstellen. Es durchsucht NuGet-Pakete und zeigt die Ergebnisse in der suchbasierten Messagingerweiterung an.	View	View	View

Schrittweise Anleitung

Befolgen Sie die Schritt-für-Schritt-Anleitung , um eine suchbasierte Nachrichtenerweiterung zu erstellen.

Nächster Schritt

Reagieren auf Suchbefehle.

Siehe auch

• Entwicklerportal für Teams
• Nachrichtenerweiterungen