Informationen zum Erstellen von GitHub Copilot-Erweiterungen

Info zum Erstellen von Copilot-Erweiterungen

Copilot-Erweiterungen sind Integrationen, die die Funktionalität von Copilot Chat erweitern, sodass Entwickler externe Tools, Dienste und benutzerdefinierte Verhaltensweisen in die Chatumgebung integrieren können. Du kannst Copilot-Erweiterungen auf vielfältige Weise einsetzen, um die Funktionen von Copilot Chat zu erweitern, z. B.:

• Abfrage von Dokumentation: Eine Copilot-Erweiterung kann Copilot Chat erlauben, den Dokumentationsdienst eines Drittanbieters abzufragen, um Informationen zu einem bestimmten Thema zu finden.
• KI-gestützte Codierung: Eine Copilot-Erweiterung kann ein KI-Modell eines Drittanbieters verwenden, um Codevorschläge bereitzustellen.
• Datenabruf: Eine Copilot-Erweiterung kann Copilot Chat erlauben, den Datendienst eines Drittanbieters abzufragen, um Informationen zu einem bestimmten Thema abzurufen.
• Aktionsausführung: Eine Copilot-Erweiterung kann Copilot Chat erlauben, eine bestimmte Aktion auszuführen, z. B. das Posten in einem Message Board oder das Aktualisieren eines Nachverfolgungselements in einem externen System.

GitHub Copilot-Erweiterungen werden mit GitHub Apps erstellt. Sie eignen sich am besten für Programmierende, die plattformübergreifende Kompatibilität, App-Verwaltung und Unterstützung von GitHub wünschen.

Informationen zu Skillsets und Agents

Mit Skillsets und Agents können die Funktionen und der Kontext von Copilot mithilfe der Copilot Extensibility Platform erweitert werden. Damit kannst du externe Dienste und APIs mit Copilot Chat integrieren. Jede Instanz hat verschiedene Anwendungsfälle und unterschiedliche Kontrollmöglichkeiten und Komplexitätsniveaus:

• Skillsets sind einfach, optimiert und für Entwickler erstellt, die Copilot zum Durchführen bestimmter Aufgaben mit geringem Setup benötigen, z. B. Abrufen von Daten oder einfache Vorgänge. Routing, das Erstellen von Prompts, das Auswerten von Funktionen und das Generieren von Antworten wird automatisch verarbeitet. Daher eignen sich Skillsets ideal für schnelle und einfache Integrationen. Weitere Informationen zu Skillsets findest du unter Info zu Skillsets für GitHub Copilot-Erweiterungen.
• Agents sind für komplexe Integrationen vorgesehen, die vollständige Kontrolle darüber erfordern, wie Anforderungen verarbeitet und Antworten generiert werden. So kannst du benutzerdefinierte Logik implementieren, mit anderen LLMs und/oder der Copilot-API integrieren, Unterhaltungskontext verwalten und dich um alle Aspekte der Benutzerinteraktion kümmern. Während Agents mehr Engineering und Wartung erfordern, bieten sie maximale Flexibilität für anspruchsvolle Workflows. Weitere Informationen zu Agents findest du unter Info zu Agents für GitHub Copilot-Erweiterungen.

Informationen zur Kontextweitergabe

Du kannst zulassen, dass deine Copilot-Erweiterung Kontext vom Editor erhält (z. B. die aktuell geöffnete Datei), indem du die Zugriffsebene Read-only für die Berechtigung „Copilot Editor Context“ in deinen GitHub App-Einstellungen aktivierst. Weitere Informationen findest du in Schritt 10 unter Konfigurieren deiner GitHub App.

Die GitHub Copilot Extensibility Platform verwaltet das Messaging automatisch, wenn impliziter und expliziter Kontext nicht verfügbar oder nicht autorisiert ist. Um die Kontextweitergabe zu aktivieren, musst du Berechtigungen von Benutzern anfordern. Um die Kontextübergabe zu aktivieren, musst du:

• Deine APIs aktualisieren, um neue Verweistypen zu verarbeiten
• Berechtigungen von Benutzenden anfordern Befolge beim Anfordern von Berechtigungen die folgenden Best Practices:
  • Kommuniziere klar, welchen Kontext du benötigst und wofür du ihn benötigst.
  • Implementiere die entsprechende Fehlerbehandlung für nicht verfügbaren Kontext, die deine eigene Anwendungslogik und API aufruft.
  • Wenn kein Kontext verfügbar ist, gib möglichst ohne diese Daten einen Wert an.
  • Fordere nur die mindestens erforderlichen Berechtigungen für deine Erweiterung an.

Die Kontextübergabe berücksichtigt Inhaltsausschlüsse, die sich auf alle Dateien beziehen, die in deinen Kontextausschlusseinstellungen aufgeführt sind, einschließlich Dateien, die mit . beginnen.

Weitere Informationen zur Kontextweitergabe findest du unter Kontextweitergabe für deinen Agent.

Verwenden von APIs in GitHub Copilot-Erweiterungen

Für das Erstellen von GitHub Copilot-Erweiterungen ist die Verwendung der GitHub-API erforderlich. Optional kann die Copilot API für zusätzliche Funktionen verwendet werden. Ausführliche Informationen zur Anforderungs- und Antwortformatierung findest du in der OpenAI-API-Dokumentation.

Ressourcen für die Erstellung von GitHub Copilot-Erweiterungen

GitHub verfügt über ein umfassendes Toolkit für Erweiterungsentwickler mit Codebeispielen, einem CLI-Debuggingtool, Schnellstart-SDKs und einem Benutzerfeedback-Repository. Weitere Informationen finden Sie in der Organisation der Copilot-Erweiterungen auf GitHub.

Bevor du deine eigene GitHub Copilot-Erweiterung von Grund auf neu erstellst, solltest du einen Copilot-Agent erkunden und ihn dann mit einer GitHub App integrieren, um zu sehen, wie er funktioniert. GitHub stellt einige Copilot-Agents als Beispiel bereit, die du klonen und als Grundlage für deine eigene GitHub Copilot-Erweiterung verwenden kannst:

• Blackbeard: Ein einfacher Copilot-Agent, der Anforderungen beantwortet wie ein Pirat unter Verwendung der LLM-API von Copilot und spezieller Systemansagen. Er ist ein guter Ausgangspunkt zum Lernen, wie eine GitHub Copilot-Erweiterung erstellt wird. Weitere Informationen findest du unter Blackbeard Copilot-Erweiterung.

• GitHub Models: Ein komplexerer Copilot-Agent, mit dem du über den Copilot Chat bei verschiedenen auf dem GitHub Marketplace gelisteten LLMs anfragen und damit interagieren kannst. Weitere Informationen findest du unter GitHub Models Copilot-Erweiterung.

  Hinweis

  GitHub Models befinden sich in der public preview und können noch geändert werden.

• Funktionsaufrufe: Ein In Go geschriebener Beispiel-Agent, der Funktionsaufrufe und Bestätigungsdialoge veranschaulicht. Weitere Informationen finden Sie unter Erweiterung für Funktionsaufrufe.

• RAG-Erweiterung: Ein In Go geschriebener Beispiel-Agent, der eine einfache Implementierung der erweiterten Abrufgenerierung veranschaulicht. Weitere Informationen finden Sie unter RAG-Erweiterung.

• Preview SDK: Ein SDK, das den Prozess der Erstellung von GitHub Copilot-Erweiterungen durch Überprüfen der Anforderungen, Formatieren der Antworten und API-Interaktionen vereinfacht. Es ermöglicht den Entwicklern, sich auf die Kernfunktionen ihrer Erweiterung statt auf Bausteine zu konzentrieren, weil es die Integration von Tools, APIs und Datenquellen in Copilot Chat optimiert. Weitere Informationen finden Sie unter Preview SDK.

Informationen zum Erstellen von Copilot-basierte VS Code-Chatteilnehmer

Du kannst eine Copilot-Erweiterung erstellen, die exklusiv und nativ für Visual Studio Code ist und Copilot-basierter VS Code-Chatteilnehmer genannt wird.

GitHub Copilot-Erweiterungen-Instanzen und Copilot-basierte VS Code-Chatteilnehmer verwenden dieselbe Back-End-Plattform, um Anforderungen an Erweiterungen weiterzuleiten. Beide bieten ähnliche Benutzerumgebungen, werden mit Copilot Chat integriert und können die Copilot-API oder andere LLMs nutzen.

Sie weisen zwar Ähnlichkeiten auf, unterscheiden sich jedoch in den folgenden Punkten:

• GitHub Copilot-Erweiterungen-Instanzen können in jedem Editor verwendet werden, in dem Erweiterungen unterstützt werden, während Copilot-basierte VS Code-Chatteilnehmer nur in Visual Studio Code verfügbar sind.
• GitHub Copilot-Erweiterungen-Instanzen sind serverseitige Erweiterungen, die eine Serverinfrastruktur zum Erstellen erfordern. Diese Erweiterungen bieten, je nach Konfiguration durch Organisationsadministrierende, eine integrierte Verbindung mit deinen GitHub-Arbeitsbereichen.
• Copilot-basierte VS Code-Chatteilnehmer sind clientseitige Chaterweiterungen, die mehr Zugriff auf Features und APIs von VS Code haben. Dies ermöglicht mehr editorspezifische Interaktionen wie den Zugriff auf lokale Arbeitsbereichsdaten, das Bearbeiten der Schnittstelle von Visual Studio Code sowie Lese-/Schreibzugriff auf lokale Dateien. Sie erfordern keine Serverinfrastruktur.
• Da Copilot-basierte VS Code-Chatteilnehmer lokal auf dem Computer der Benutzenden gespeichert sind, können sie nicht durch die Copilot-Richtlinien einer Organisation oder eines Unternehmens auf GitHub.com gesteuert werden.
• Copilot-basierte VS Code-Chatteilnehmer werden im VS Code Marketplace veröffentlicht, nicht im GitHub Marketplace.

Copilot-basierte VS Code-Chatteilnehmer eignen sich am besten für Programmierende, die Erweiterungen erstellen möchten, die VS Code-spezifische APIs und Funktionen verwenden oder bestehende VS Code-Erweiterungen ausbauen.

Weitere Informationen zu Copilot-basierte VS Code-Chatteilnehmer findest du unter Chat extensions in der Dokumentation zu Visual Studio Code.

Entschädigung für Copilot-Erweiterungen

Die Entschädigungsrichtlinie für GitHub Copilot deckt Copilot-Erweiterungen nicht ab. Dieser Ausschluss gilt jedoch nur für Probleme, die in Erweiterungschatthreads auftreten.

Die Installation und Verwendung von Erweiterungen wirkt sich nicht auf die Entschädigungsabdeckung für Probleme aus, die während der Verwendung anderer Copilot-Features wie Codevervollständigungen und Chats auftreten.

Weiterführende Themen

• Glossar der GitHub Copilot-Erweiterungen