Nota:
SDK de Copilot actualmente está en Versión preliminar técnica. La funcionalidad y la disponibilidad están sujetas a cambios.
Información general sobre la arquitectura
Cada SDK de GitHub Copilot integración sigue el mismo patrón principal: la aplicación se comunica con el SDK, que se comunica a CLI de Copilot través de JSON-RPC. Lo que cambia en las configuraciones es dónde se ejecuta la CLI, cómo se autentican los usuarios y cómo se administran las sesiones.
¿Quién es usted?
Aficionado
Va a crear un asistente personal, un proyecto lateral o una aplicación experimental. Quieres la forma más directa de obtener Copilot en tu código.
**Comience con:**
-
[AUTOTITLE](/copilot/how-tos/copilot-sdk/set-up-copilot-sdk/local-cli): use la CLI que ya ha iniciado sesión en el equipo. -
[AUTOTITLE](/copilot/how-tos/copilot-sdk/set-up-copilot-sdk/bundled-cli): empaqueta todo en una aplicación independiente.
Desarrollador interno de aplicaciones
Está creando herramientas para su equipo o empresa. Los usuarios son empleados que necesitan autenticarse con sus cuentas empresariales GitHub o pertenencias a la organización.
**Comience con:**
1. Uso de OAuth de GitHub con el SDK de Copilot: permite que los empleados inicien sesión con sus GitHub cuentas. 1. Configuración del SDK de Copilot para los servicios de back-end: ejecute el SDK en los servicios internos.
**Si se escala más allá de un único servidor:**
1. Escalado de implementaciones del SDK de Copilot: controla varios usuarios y servicios.
Desarrollador de aplicaciones (ISV)
Está creando un producto para los clientes. Debe controlar la autenticación de los usuarios, ya sea a través de GitHub, o gestionando la identidad usted mismo.
**Comience con:**
1.
Uso de OAuth de GitHub con el SDK de Copilot: permite que los clientes inicien sesión con GitHub.
1.
BYOK en el github/copilot-sdk repositorio: administre la identidad con sus propias claves de modelo.
1.
Configuración del SDK de Copilot para los servicios de back-end—potencia tu producto desde el código del lado del servidor.
**Para producción:**
1. Escalado de implementaciones del SDK de Copilot: atiende a muchos clientes de forma confiable.
Desarrollador de plataformas
Va a insertar Copilot en una plataforma: API, herramientas de desarrollo o infraestructura en la que se basan otros desarrolladores. Necesita un control específico sobre las sesiones, el escalado y el multiinquilino.
**Comience con:**
1. Configuración del SDK de Copilot para los servicios de back-end: integración principal del lado servidor. 1. Escalado de implementaciones del SDK de Copilot: aislamiento de sesión, escalado horizontal, persistencia.
**En función del modelo de autenticación:**
1. Uso de OAuth de GitHub con el SDK de Copilot: para GitHubusuarios autenticados.
-
[BYOK](https://github.com/github/copilot-sdk/blob/main/docs/auth/byok.md) en el `github/copilot-sdk` repositorio, para el acceso de identidad y modelo autoadministrados.
Matriz de decisión
Use esta tabla para encontrar la guía adecuada en función de lo que necesita hacer.
| Lo que necesitas | Guía |
|---|---|
| Configuración más sencilla posible |
[AUTOTITLE](/copilot/how-tos/copilot-sdk/set-up-copilot-sdk/local-cli) |
| Envía una aplicación independiente con Copilot |
Uso de una CLI agrupada con el SDK de Copilot |
| Los usuarios inician sesión con GitHub |
Uso de OAuth de GitHub con el SDK de Copilot |
| Use sus propias claves de modelo (OpenAI, Azure, etc.) |
BYOK en el github/copilot-sdk repositorio |
| Azure BYOK con identidad administrada (sin claves de API) |
Uso de Identidad Administrada de Azure con el SDK de Copilot |
| Ejecución del SDK en un servidor |
Configuración del SDK de Copilot para los servicios de back-end |
| Atender a varios usuarios o escalar horizontalmente |
Escalado de implementaciones del SDK de Copilot |
Prerrequisitos
Todas las Guías asumen que usted tiene:
CLI de Copilot
** instalado. Para obtener más información, vea [AUTOTITLE](/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli).
- Uno de los SDK instalados :
- Node.js:
npm install @github/copilot-sdk - Pitón:
pip install github-copilot-sdk - Ir:
go get github.com/github/copilot-sdk/go - .NET:
dotnet add package GitHub.Copilot.SDK
- Node.js:
Si no está familiarizado con el SDK de GitHub Copilot, comience primero con Introducción al SDK de Copilot y luego regrese aquí para la configuración de producción.
Pasos siguientes
Elija la guía que coincida con su situación en la matriz de decisiones anterior o comience con la descripción del rol más cercana a su rol.