Architektur auf einen Blick
Jede Copilot SDK-Integration folgt demselben Kernmuster: Ihre Anwendung kommuniziert mit dem SDK, das mit der Copilot CLI über JSON-RPC kommuniziert. Was sich bei setupsübergreifend ändert , ist, wo die CLI ausgeführt wird, wie Benutzer authentifiziert****werden und wie Sitzungen verwaltet werden.
Die nachstehenden Setupanleitungen helfen Ihnen beim Konfigurieren der einzelnen Ebenen für Ihr Szenario.
Wer bist du?
🧑💻 Hobbyist
Sie erstellen einen persönlichen Assistenten, ein Nebenprojekt oder eine experimentelle App. Sie möchten den einfachsten Pfad zum Abrufen von Copilot in Ihrem Code.
Beginnen Sie mit:
- ** Standardsetup (gebündelte CLI)** – Das SDK enthält die CLI automatisch – einfach installieren und gehen
- ** Lokale CLI-Einrichtung**—Verwenden Sie Ihre eigene CLI-Binärdatei oder eine bereits laufende Instanz (erweitert)
🏢 Interner App-Entwickler
Sie erstellen Tools für Ihr Team oder Ihr Unternehmen. Benutzer sind Mitarbeiter, die sich mit ihrem Unternehmen GitHub Konten oder Organisationsmitgliedschaften authentifizieren müssen.
Beginnen Sie mit:
- ** Einrichtung von GitHub OAuth** – Lassen Sie Mitarbeiter sich mit ihren GitHub Konten anmelden
- ** Einrichtung von Back-End-Diensten** – Führen Sie das SDK in Ihren internen Diensten aus.
Wenn die Skalierung über einen einzelnen Server hinaus erfolgt:
- ** Skalierung und Mehrinstanzenfähigkeit** – Behandeln mehrerer Benutzer und Dienste
🚀 App-Entwickler (ISV)
Sie erstellen ein Produkt für Kunden. Sie müssen die Authentifizierung für Ihre Benutzer verarbeiten – entweder über GitHub oder durch die Verwaltung der Identität selbst.
Beginnen Sie mit:
- ** Einrichtung von GitHub OAuth**—Kunden die Anmeldung mit GitHub ermöglichen
- ** BYOK (bring your own key)** – Verwalten Sie Ihre Identität selbst mit Ihren eigenen Modellschlüsseln
- ** Einrichtung von Back-End-Diensten** – Versorgen Sie Ihr Produkt mit serverseitigem Code
Für die Produktion:
- ** Skalierung und Mehrinstanzenfähigkeit** – Viele Kunden zuverlässig bedienen
🏗️ Plattformentwickler
Sie betten Copilot in eine Plattform ein – APIs, Entwicklertools oder Infrastruktur, auf denen andere Entwickler aufbauen. Sie benötigen eine differenzierte Kontrolle über Sitzungen, Skalierung und Mehrinstanzenschaft.
Beginnen Sie mit:
- ** Einrichtung von Back-End-Diensten** – Kern-serverseitige Integration
- ** Skalierung und Mehrinstanzenfähigkeit** – Sitzungsisolation, horizontale Skalierung, Persistenz
Abhängig von Ihrem Authentifizierungsmodell:
- ** Einrichtung von GitHub OAuth** – Für GitHub authentifizierte Benutzer
- ** BYOK (bring your own key)** – Für selbstverwaltete Identitäten und den Modellzugriff
Entscheidungsmatrix
Verwenden Sie diese Tabelle, um die richtigen Führungslinien zu finden, je nachdem, was Sie tun müssen:
| Was Sie benötigen | Guide |
|---|---|
| Schnelles Starten | |
| Standardsetup (gebündelte CLI) | |
| Verwenden Einer eigenen CLI-Binärdatei oder eines eigenen Servers | |
| Lokale CLI-Einrichtung | |
| Benutzer melden sich mit GitHub an | |
| Einrichtung von GitHub OAuth | |
| Verwenden Sie Ihre eigenen Modellschlüssel (OpenAI, Azure usw.) | |
| BYOK (bring your own key) | |
| Azure BYOK mit verwalteter Identität (keine API-Schlüssel) | |
| Azure verwaltete Identität mit BYOK | |
| Ausführen des SDK auf einem Server | |
| Einrichtung von Back-End-Diensten | |
| Mehrere Benutzer bedienen/horizontal skalieren | |
| Skalierung und Mehrinstanzenfähigkeit |
Konfigurationsvergleich
Voraussetzungen
Alle Leitfäden gehen davon aus, dass Sie folgendes haben:
- Eines der SDKs muss installiert sein (Node.js-, Python- und .NET-SDKs enthalten die CLI automatisch):
- Node.js:
npm install @github/copilot-sdk - Python:
pip install github-copilot-sdk - Go:
go get github.com/github/copilot-sdk/go(erfordert separate CLI-Installation) - .NET:
dotnet add package GitHub.Copilot.SDK
- Node.js:
Wenn Sie ganz neu sind, beginnen Sie zuerst mit der Erstellen Sie Ihre erste Copilot-gestützte App , und kehren Sie dann zur Produktionskonfiguration zurück.
Nächste Schritte
Wählen Sie den Leitfaden aus der obigen Entscheidungsmatrix aus, oder beginnen Sie mit der Persona-Beschreibung, die Ihrer Rolle am nächsten kommt.