Erstellen von API-Plug-Ins aus einer vorhandenen API für Microsoft 365 Copilot

Wichtig

API-Plug-Ins werden nur als Aktionen in deklarativen Agents unterstützt. Sie sind in Microsoft 365 Copilot nicht aktiviert.

API-Plug-Ins verbinden Ihre vorhandene REST-API mit Microsoft 365 Copilot. Sie können das Teams-Toolkit verwenden, um ein Plug-In aus einer vorhandenen REST-API mit einer OpenAPI-Spezifikation zu generieren.

Voraussetzungen

• Unter Anforderungen für die Plug-In-Entwicklung angegebene Anforderungen
• Eine vorhandene REST-API mit einer OpenAPI-Spezifikation (in dieser exemplarischen Vorgehensweise wird die Budget Tracker-Beispiel-API verwendet)
• Visual Studio Code mit Teams Toolkit Version 5.9 oder höher
• Teams Toolkit
• Optional: Microsoft Kiota Visual Studio Code-Erweiterung

Tipp

Um optimale Ergebnisse zu erzielen, stellen Sie sicher, dass Ihre OpenAPI-Spezifikation den Unter How to make an OpenAPI effective in extending Copilot (How to make an OpenAPI document effective in extending Copilot) beschriebenen Richtlinien folgt.

Laden Sie zum Befolgen dieses Leitfadens die Budget Tracker-Beispiel-API herunter, und konfigurieren Sie sie für die Ausführung auf Ihrem lokalen Entwicklungscomputer. Erstellen Sie das Beispiel, und führen Sie es mindestens einmal aus, um die openapi.yml-Datei für die API zu generieren.

Aktivieren der Plug-In-Entwicklung im Teams-Toolkit

1. Öffnen Sie Visual Studio Code. Wenn das Teams-Toolkit noch nicht installiert ist, finden Sie unter Installieren des Teams-Toolkits Anweisungen zur Installation.

2. Wählen Sie Datei ->Einstellungen -Einstellungen aus>. Suchen Sie im Fenster Einstellungen nach copilot , um die Option Fx-extension: Develop Copilot Plug-In zu finden. Wenn noch nicht aktiviert, aktivieren Sie die Einstellung.

3. Suchen Sie im Fenster Einstellungen nach kiota , um die Option Fx-extension: Enable Microsoft Kiota (Fx-erweiterung: Microsoft Kiota aktivieren ) zu suchen. Wenn Sie Kiota aktivieren möchten, aktivieren Sie diese Option. Deaktivieren Sie sie andernfalls. Weitere Informationen finden Sie unter Vorteile der Aktivierung von Microsoft Kiota.

4. Wenn Sie Änderungen an den Einstellungen vorgenommen haben, starten Sie Visual Studio Code neu, bevor Sie fortfahren.

Vorteile der Aktivierung von Microsoft Kiota

Die Aktivierung von Microsoft Kiota im Teams-Toolkit bietet die folgenden Vorteile.

• Die Benutzeroberfläche zum Auswählen von Vorgängen aus dem OpenAPI-Dokument wird durch einen API-Explorer ersetzt, der sich besser für große OpenAPI-Dokumente eignet.
• Der Entwickler kann mithilfe des Suchbefehls von Kiota nach öffentlichen OpenAPI-Beschreibungen suchen.

Erstellen des Plug-Ins

API-Plug-Ins sind eine ZIP-Datei, die die folgenden Dateien enthält.

• Die OpenAPI-Spezifikation für die REST-API.
• Ein API-Plug-In-Manifest , das auf die enthaltene OpenAPI-Spezifikation verweist und die verfügbaren Vorgänge, Authentifizierungsmethoden und Antwortformate beschreibt.
• Ein Teams-App-Manifest (z. B manifest.json. ) mit einer copilotExtensions Eigenschaft, die auf das API-Plug-In-Manifest verweist.

1. Öffnen Sie Visual Studio Code. Wenn das Teams-Toolkit noch nicht installiert ist, finden Sie unter Installieren des Teams-Toolkits Anweisungen zur Installation.

2. Wählen Sie in der linken Aktivitätsleiste das Symbol Teams Toolkit aus.

3. Wählen Sie im Aufgabenbereich Teams Toolkit die Option Neue App erstellen aus.

   

4. Wählen Sie Copilot-Agent und dann Deklarativer Agent aus.

5. Wählen Sie Plug-In hinzufügen und dann Mit einem OpenAPI-Beschreibungsdokument beginnen aus.

Die nächsten Schritte unterscheiden sich je nachdem, ob Sie Microsoft Kiota aktiviert haben oder nicht.

Teams Toolkit ohne Kiota

1. Wählen Sie Durchsuchen aus, und navigieren Sie im Budget Tracker-Beispiel unter ./openapi/openapi.yml zum Speicherort der OpenAPI-Spezifikation.

2. Wählen Sie alle Vorgänge aus, die für das Plug-In aktiviert werden sollen.

   

3. Wählen Sie einen Speicherort für das API-Plug-In-Projekt aus.

4. Geben Sie Budget Tracker als Namen für das Plug-In ein.

Teams Toolkit mit Kiota

1. Wählen Sie Pfad durchsuchen aus, und navigieren Sie zum Speicherort der OpenAPI-Spezifikation aus dem Budget Tracker-Beispiel unter ./openapi/openapi.yml.

2. Die Seitenleistenansicht wird in den Kiota-API-Explorer geändert. Verwenden Sie die Schaltfläche Alle hinzufügen , um alle Vorgänge auszuwählen, die für das Plug-In aktiviert werden sollen.

   

3. Wählen Sie im Kiota-API-Explorer die Schaltfläche Generieren aus.

   

4. Wählen Sie einen Speicherort für das API-Plug-In-Projekt aus.

5. Geben Sie Budget Tracker als Namen für das Plug-In ein.

Nachdem Sie diese Schritte ausgeführt haben, generiert Teams Toolkit die erforderlichen Dateien für das Plug-In und öffnet ein neues Visual Studio Code-Fenster, in dem das Plug-In-Projekt geladen wurde.

Hinweis

Wenn Ihr Identitätsserver Proof Key for Code Exchange (PKCE) erfordert, heben Sie die Auskommentierung der folgenden Zeile in teamsapp.yml im API-Plug-In-Projekt auf.

# isPKCEEnabled: true

Packen und Querladen des Plug-Ins

1. Öffnen Sie das Plug-In-Projekt in Visual Studio Code.

2. Wählen Sie in der linken Aktivitätsleiste das Symbol Teams Toolkit aus.

3. Wählen Sie im Bereich Konten die Option Bei Microsoft 365 anmelden aus. (Wenn Sie bereits angemeldet sind, fahren Sie mit dem nächsten Schritt fort.

4. Vergewissern Sie sich, dass sowohl benutzerdefinierter App-Upload aktiviert als auch Copilot-Zugriff aktiviert unter Ihrem Microsoft 365-Konto angezeigt werden. Wenn dies nicht der Fall ist, wenden Sie sich an Ihren organization Administrator. Weitere Informationen finden Sie unter Anforderungen für die Plug-In-Entwicklung.

5. Wählen Sie im Bereich Lebenszyklus die Option Bereitstellen aus.

6. Wenn Sie zur Eingabe der Client-ID für die OAuth-Registrierung aufgefordert werden, geben Sie Ihre Plug-In-Client-ID ein.

7. Wenn Sie zur Eingabe des geheimen Clientschlüssels für die OAuth-Registrierung aufgefordert werden, geben Sie Ihren geheimen Plug-In-Clientschlüssel ein.

8. Lesen Sie die Nachricht im Dialogfeld, und wählen Sie Bestätigen aus, um den Vorgang fortzusetzen.

9. Warten Sie, bis das Toolkit meldet, dass die Bereitstellung abgeschlossen ist.

   

Ihr Plug-In kann jetzt mit Ihrem Benutzerkonto in Microsoft 365 Copilot in Microsoft Teams getestet werden.

Verwenden des Plug-Ins

1. Öffnen Sie Teams in Ihrem Browser, und melden Sie sich mit dem Microsoft 365-Konto an, das Sie zum Hochladen Ihres Plug-Ins verwendet haben.

2. Wählen Sie auf der linken Aktivitätsleiste Chat aus.

3. Wählen Sie im Bereich Chatdie Option Copilot aus.

4. Wählen Sie in der Liste der Copilot-Agents auf der rechten Seite Budget Tracker aus. Wenn die Liste nicht verfügbar ist, wählen Sie in der oberen rechten Ecke das Symbol Copilot-Chats und mehr aus.

   

5. Stellen Sie eine Frage zu Budgets. Probieren Sie z. B. aus How much is left in the Fourth Coffee lobby renovation budget?. Wenn Sie dazu aufgefordert werden, wählen Sie Immer zulassen oder Einmal zulassen aus, um fortzufahren.

6. Wenn Sie aufgefordert werden, sich anzumelden, wählen Sie Bei Budget Tracker anmelden aus.