Erstellen von Copilot-Skillsets

Einführung

Github Copilot skillsets sind eine optimierte Möglichkeit, die Funktionen von GitHub Copilot zu erweitern, indem API-Endpunkte definiert werden, die Copilot aufrufen kann. Wenn du ein Skillset erstellst, verarbeitet Copilot alle KI-Interaktionen, während deine Endpunkte die Daten oder Funktionen bereitstellen. Dieser Leitfaden führt dich durch das Konfigurieren und Bereitstellen eines Skillsets in deiner GitHub App.

Voraussetzungen

Bevor Sie beginnen, sollten Sie sicherstellen, dass Folgendes vorhanden ist:

1. Eine konfigurierte GitHub App: Du benötigst eine GitHub App, die als Container für dein Skillset fungiert. Wenn du noch keine eingerichtet hast, findest du unter Erstellen einer GitHub-App für Ihre Copilot-Erweiterung und Konfigurieren deiner GitHub-App für deine Copilot-Erweiterung weitere Informationen.
2. API-Endpunkte: Du benötigst einen Endpunkt pro Skill. Jeder Endpunkt muss:
   • POST-Anforderungen mit dem MIME-Typ application/json akzeptieren
   • In der Lage sein, die Signatur von Anforderungen von GitHub zu verifizieren, um ihren Ursprung zu authentifizieren und unbefugten Zugriff zu verhindern
   • Öffentlich über HTTPS zugänglich sein

Weitere Informationen zur Signaturüberprüfung findest du unter Überprüfen, ob Payloads von GitHub stammen.

Konfigurationsanforderungen

Jedes Skillset wird in einer GitHub App definiert. Jede GitHub App kann bis zu fünf Skills enthalten. Jeder Skill benötigt:

• Name: Ein eindeutiger und beschreibender Name (z. B. „Issues abrufen“)
• Rückschlussbeschreibung: Eine detaillierte Erläuterung der Skills und deren Verwendung (z. B. „Sucht nach externen Issues, die bestimmten Kriterien entsprechen, z. B. Status und Bezeichnungen“)
• API-Endpunkt: Ein POST-Endpunkt, der JSON-Anforderungen akzeptiert
• JSON-Schema: Die Struktur der Daten, die dein Endpunkt erwartet

Beispiel für das JSON-Schema

In diesem Beispiel wird ein Skill veranschaulicht, die zwei Parameter erfordert: eine Statuszeichenfolge und eine Bezeichnungszeichenfolge. Wenn keine Parameter angegeben werden, muss ein leeres Objekt mit dem Typ „object“ als Anforderungstext übergeben werden.

{
 "type": "object",
 "properties": {
   "status": {
     "type": "string",
     "description": "filter issues by status (open, closed)",
     "enum": ["open", "closed"]
   },
   "label": {
     "type": "string",
     "description": "filter issues by label"
   }
 }
}

Mit diesem Format können Benutzer Anforderungen in natürlicher Sprache wie find open security issues vornehmen, und Copilot strukturiert den entsprechenden API-Aufruf.

Verwenden deines Skillsets

So verwendest du dein Skillset:

1. Gib @ gefolgt vom Namen der Erweiterung ein.

2. Gib deinen Prompt in natürlicher Sprache ein.

   Zum Beispiel:

   • @skillset-example generate a lorem ipsum
   • @skillset-example give me sample data with 100 words

Copilot interpretiert deine Anfrage und ruft die entsprechende Fähigkeit mit den richtigen Parametern auf. Es ist nicht erforderlich, anzugeben, welcher Skill verwendet werden soll. Copilot bestimmt dies aus deiner Anforderung in natürlicher Sprache und den bereitgestellten Rückschlussbeschreibungen.

Einrichten eines Skillsets

1. Klicke auf GitHub in der oberen rechten Ecke einer beliebigen Seite auf dein Profilfoto.
2. Navigieren Sie zu den Einstellungen für Ihr Konto.
   • Klicken Sie bei einer App, die zu einem persönlichen Konto gehört, auf Einstellungen.
   • Für eine App im Besitz einer Organisation:
     1. Klicke Sie auf Ihre Organisationen.
     2. Klicke dann rechts neben der Organisation auf Einstellungen.
3. Klicke auf der linken Seitenleiste auf Entwicklereinstellungen.
4. Klicke auf der linken Randleiste auf GitHub Apps .
5. Klicke in der Liste der GitHub Apps auf die GitHub App, die du für dein Skillset konfigurieren möchtest.
6. Wähle im Navigationsmenü auf der linken Seite Copilot aus.
7. Wähle unter App Type die Option Skillset aus dem Dropdownmenü aus.
8. Gib optional im Feld Pre-authorization URL die URL ein, an die Benutzer umgeleitet werden, um den Authentifizierungsprozess zu starten. Dieser Schritt ist erforderlich, wenn deine API erfordert, dass Benutzer ihr GitHub-Konto verknüpfen, um auf bestimmte Features oder Daten zuzugreifen.
9. Für jeden Skill, den du hinzufügen möchtest (maximal 5):
   1. Klicke auf Add new skill.
   2. Gib einen verständlichen Name für den Skill ein, z. B. „Generate Lorem Ipsum Data“.
   3. Schreibe eine detaillierte Inference description, damit Copilot weiß, wann dieser Skill angewendet werden soll.
   4. Füge deine API-Endpunkt-URL hinzu, die die POST-Anforderungen empfängt.
   5. Füge im Feld Parameter das JSON-Schema hinzu, das das erwartete Anforderungsformat definiert.
   6. Klicke auf Add Definition, um den Skill zu speichern.
10. Klicke auf Save, um das Skillset zu speichern.