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 Microsoft 365 Agents Toolkit (eine Weiterentwicklung des Teams-Toolkits) verwenden, um ein Plug-In aus einer vorhandenen REST-API mit einer OpenAPI-Spezifikation zu generieren.

Voraussetzungen

• Unter Anforderungen für Copilot-Erweiterbarkeitsoptionen angegebene Anforderungen
• Eine vorhandene REST-API mit einer OpenAPI-Spezifikation (in dieser exemplarischen Vorgehensweise wird die Budget Tracker-Beispiel-API verwendet)
• Visual Studio Code
• Microsoft 365 Agents Toolkit

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 mindestens einmal, um die BudgetTracker.json-Datei für die API zu generieren.

Erstellen des Plug-Ins

Hinweis

Die Screenshots und Verweise auf die Benutzeroberfläche des Microsoft 365 Agents Toolkit (eine Weiterentwicklung des Teams Toolkits) in diesem Dokument wurden mit der neuesten Version 6.0 generiert. Vorabversionen des Agents Toolkits können sich von der Benutzeroberfläche in diesem Dokument unterscheiden.

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.

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

2. Wählen Sie in der linken Aktivitätsleiste das Symbol Microsoft 365 Agents Toolkit aus.

3. Wählen Sie im Aufgabenbereich Agents Toolkit die Option Create a New Agent/App (Neuen Agent/Neue App erstellen) aus.

   

4. Wählen Sie Deklarativer Agent aus.

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

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

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

   

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

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

Nachdem Sie diese Schritte ausgeführt haben, generiert agents 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 m365agents.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 Microsoft 365 Agents 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. Ausführliche Informationen finden Sie unter Anforderungen für Copilot-Erweiterbarkeitsoptionen.

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 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.