Архитектура в каждом взгляде
Каждая интеграция Copilot SDK следует одной и той же основной схеме: ваше приложение взаимодействует с SDK, который взаимодействует с Copilot CLI через JSON-RPC. Что меняется в зависимости от конфигурации — это то, где работает CLI, как пользователи аутентифицируются и как управляются сессиями.
Руководства по настройке ниже помогут настроить каждый слой под ваш сценарий.
Ты кто?
🧑 💻 Любитель
Вы создаёте личного ассистента, побочный проект или экспериментальное приложение. Вам нужен самый простой путь к внедрению Copilot в ваш код.
Начните с:
- ** Настройка по умолчанию (в комплекте CLI)** — SDK автоматически включает CLI — просто установите и запустите
- ** Локальная настройка CLI** — Используйте свой собственный бинарный файл CLI или запущенный экземпляр (продвинутый)
🏢 Внутренний разработчик приложений
Вы создаёте инструменты для своей команды или компании. Пользователи — это сотрудники, которым необходимо пройти аутентификацию через корпоративные аккаунты GitHub или членство в организации.
Начните с:
- ** Настройка GitHub OAuth** — Позвольте сотрудникам войти через свои GitHub аккаунты
- ** Настройка серверных сервисов** — Запустите SDK во внутренних сервисах
Если масштабироваться выше одного сервера:
- ** Масштабирование и многоарендность**—Управление несколькими пользователями и сервисами
🚀 Разработчик приложений (ISV)
Вы создаёте продукт для клиентов. Вам нужно заниматься аутентификацией для пользователей — либо через GitHub, либо самостоятельно управляя идентификацией.
Начните с:
- ** Настройка GitHub OAuth** — Позвольте клиентам войти с GitHub
- ** BYOK (bring your own key)** — Управляйте идентификацией самостоятельно с помощью ключей моделей
- ** Настройка серверных сервисов** — Питание вашего продукта на серверной стороне кода
Для производства:
- ** Масштабирование и многоарендность** — Надежно обслуживать многих клиентов
🏗️ Разработчик платформы
Вы встраиваете Copilot в платформу — API, инструменты для разработчиков или инфраструктуру, на которой строят другие разработчики. Вам нужен тонкий контроль над сессиями, масштабированием и мультиарендой.
Начните с:
- ** Настройка серверных сервисов**—Основная серверная интеграция
- ** Масштабирование и многоарендность** — Изоляция сессии, горизонтальное масштабирование, персистенция
В зависимости от вашей модели аутентификации:
- ** Настройка GitHub OAuth** — Для пользователей с GitHub аутентификацией
- ** BYOK (bring your own key)**—Для самоуправляемой идентичности и доступа к модели
Матрица принятия решений
Используйте эту таблицу, чтобы найти правильные руководства в зависимости от того, что вам нужно сделать:
| Что вам нужно | Guide |
|---|---|
| Быстрый старт | |
| Настройка по умолчанию (в комплекте CLI) | |
| Используйте свой собственный CLI-бинар или сервер | |
| Локальная настройка CLI | |
| Пользователи входят через GitHub | |
| Настройка GitHub OAuth | |
| Используйте свои собственные ключи модели (OpenAI, Azure и др.) | |
| BYOK (bring your own key) | |
| Azure BYOK с управляемой идентификацией (без API-ключей) | |
| Azure managed identity with BYOK | |
| Запустите SDK на сервере | |
| Настройка серверных сервисов | |
| Обслуживать нескольких пользователей / масштабироваться горизонтально | |
| Масштабирование и многоарендность |
Сравнение конфигураций
Необходимые условия
Все гайды предполагают, что у вас есть:
- один из SDK установленных (Node.js, Python и .NET SDK автоматически включают CLI):
- Node.js:
npm install @github/copilot-sdk - Питон (язык программирования):
pip install github-copilot-sdk - Go:
go get github.com/github/copilot-sdk/go(требуется отдельная установка CLI) - .NET:
dotnet add package GitHub.Copilot.SDK
- Node.js:
Если вы новичок, начните с Создайте своё первое приложение на базе Copilot , а потом возвращайтесь сюда для серийной конфигурации.
Дальнейшие действия
Выберите гайд, который соответствует вашей ситуации, из матрицы решений выше, или начните с описания персонажа, наиболее близкого к вашей роли.