Aperçu de l’architecture
Chaque intégration du KIT de développement logiciel (SDK) Copilot suit le même modèle de base : votre application communique avec le KIT SDK, qui communique avec l’interface CLI Copilot via JSON-RPC. Les modifications apportées aux configurations sont l’emplacement où l’interface CLI s’exécute, comment les utilisateurs s’authentifient et comment les sessions sont gérées.
Les guides de configuration ci-dessous vous aident à configurer chaque couche pour votre scénario.
Qui es-tu?
🧑 💻 Amateur
Vous créez un assistant personnel, un projet latéral ou une application expérimentale. Vous voulez le chemin le plus simple pour obtenir Copilot dans votre code.
Commencez par :
- ** Configuration par défaut (interface CLI groupée)** : le Kit de développement logiciel (SDK) inclut automatiquement l’interface CLI, il vous suffit d’installer et d’accéder à
- ** Configuration de l’interface CLI locale** : utiliser votre propre binaire CLI ou une instance en cours d’exécution (avancé)
🏢 Développeur d’applications interne
Vous créez des outils pour votre équipe ou votre entreprise. Les utilisateurs sont des employés qui doivent s’authentifier auprès de leurs comptes d’entreprise GitHub ou d’appartenances à l’organisation.
Commencez par :
- ** configuration de GitHub OAuth** : permettre aux employés de se connecter avec leur compte GitHub
- ** Configuration des services principaux** : exécuter le Kit de développement logiciel (SDK) dans vos services internes
En cas de mise à l’échelle au-delà d’un seul serveur :
- ** Mise à l’échelle et multilocation** : gérer plusieurs utilisateurs et services
🚀 Développeur d’applications (ISV)
Vous créez un produit pour les clients. Vous devez gérer l’authentification pour vos utilisateurs, via GitHub ou en gérant vous-même l’identité.
Commencez par :
- ** configuration de GitHub OAuth** : permettre aux clients de se connecter avec GitHub
- ** BYOK (bring your own key)**—Gérez votre identité vous-même avec vos propres clés de modèle
- ** Configuration des services principaux** : alimenter votre produit à partir du code côté serveur
Pour la production :
- ** Mise à l’échelle et multilocation** : servir de nombreux clients de manière fiable
🏗️ Développeur de plateforme
Vous incorporez Copilot dans une plateforme : des API, des outils de développement ou une infrastructure utilisée par d’autres développeurs. Vous avez besoin d’un contrôle granulaire sur les sessions, la mise à l’échelle et la multi-location.
Commencez par :
- ** Configuration des services principaux** — Intégration côté serveur principale
- ** Mise à l’échelle et multilocation** : isolation de session, mise à l’échelle horizontale, persistance
Selon votre modèle d’authentification :
- ** configuration de GitHub OAuth** — Pour les utilisateurs authentifiés par GitHub
- ** BYOK (bring your own key)**—Pour l’identité autogérée et l’accès aux modèles
Matrice décisionnelle
Utilisez ce tableau pour trouver les guides appropriés en fonction de ce que vous devez faire :
| Ce dont vous avez besoin | Guide |
|---|---|
| Prise en main rapide | |
| Configuration par défaut (interface CLI groupée) | |
| Utilisez votre propre binaire CLI ou serveur | |
| Configuration de l’interface CLI locale | |
| Les utilisateurs se connectent avec GitHub | |
| configuration de GitHub OAuth | |
| Utilisez vos propres clés de modèle (OpenAI, Azure, etc.) | |
| BYOK (bring your own key) | |
| Azure BYOK avec Managed Identity (aucune clé API) | |
| Identité gérée Azure avec BYOK | |
| Exécuter le Kit de développement logiciel (SDK) sur un serveur | |
| Configuration des services principaux | |
| Prendre en charge plusieurs utilisateurs / effectuer une mise à l’échelle horizontale | |
| Mise à l’échelle et multilocation |
Comparaison de configuration
Prerequisites
Tous les guides supposent que vous avez :
- One des kits SDK installés (Node.js, Python et sdk .NET incluent automatiquement l’interface CLI) :
- Node.js :
npm install @github/copilot-sdk - Python :
pip install github-copilot-sdk - Go :
go get github.com/github/copilot-sdk/go(nécessite une installation CLI distincte) - .NET :
dotnet add package GitHub.Copilot.SDK
- Node.js :
Si vous êtes tout nouveau, commencez par l’AUTOTITLE en premier, puis revenez ici pour la configuration de production.
Étapes suivantes
Choisissez le guide qui correspond à votre situation dans la matrice de décision ci-dessus, ou commencez par la description de la personne la plus proche de votre rôle.