Skip to main content

Guías de configuración

Estas guías le guiarán a través de la configuración del SDK de Copilot para su caso de uso específico, desde proyectos personales hasta plataformas de producción que sirven a miles de usuarios.

Arquitectura de un vistazo

Cada integración del SDK de Copilot sigue el mismo patrón principal: la aplicación se comunica con el SDK, que se comunica con la CLI de Copilot a 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.

Diagrama: Diagrama de flujo que muestra el proceso descrito.

Las guías de configuración siguientes le ayudarán a configurar cada capa para su escenario.

¿Quién eres?

🧑 💻 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:

  1. ** Configuración predeterminada (CLI agrupada)**: el SDK incluye automáticamente la CLI, solo tiene que instalar y ir.
  2. ** Configuración de la CLI local**—Use su propio binario de CLI o una instancia de la CLI en ejecución (avanzado)

🏢 Desarrollador interno de aplicaciones

Está creando herramientas para su equipo o empresa. Los usuarios son empleados que necesitan autenticarse con sus cuentas de empresa GitHub o pertenencias a la organización.

Comience con:

  1. ** Configuración de OAuth de GitHub**: permitir que los empleados inicien sesión con sus cuentas de GitHub
  2. ** Configuración de servicios back-end**: ejecución del SDK en los servicios internos

Si se escala más allá de un único servidor:

  1. ** Implementaciones multiinquilino y servidor**: configuración de las opciones del SDK para el modo de servidor multiusuario
  2. ** Escalabilidad y multitenencia**: control de 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 mediante la administración de la identidad usted mismo.

Comience con:

  1. ** Configuración de OAuth de GitHub**: permitir que los clientes inicien sesión con GitHub
  2. ** BYOK (traiga su propia clave)**—Gestione usted mismo su identidad con las claves de sus propios modelos
  3. ** Configuración de servicios back-end**—Impulsa tu producto con código del lado del servidor

Para producción:

  1. ** Implementaciones multiinquilino y servidor**: use mode: "empty", tokens por sesión y estado de tiempo de ejecución aislado.
  2. ** Escalabilidad y multitenencia**: atender 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 de servicios back-end**—Integración principal del servidor
  2. ** Implementaciones multiinquilino y servidor**: opciones de aislamiento de nivel de SDK, autenticación por sesión y tiempo de ejecución compartido
  3. ** Escalabilidad y multitenencia**: aislamiento de sesión, escalado horizontal, persistencia

Dependiendo del modelo de autenticación:

  1. ** Configuración de OAuth de GitHub**: para usuarios autenticados por GitHub
  2. ** BYOK (traiga su propia clave)**—Para la identidad autogestionada y el acceso a modelos

Matriz de decisión

Use esta tabla para encontrar las guías adecuadas en función de lo que necesita hacer:

Lo que necesitasGuía
Primeros pasos rápidos
Configuración predeterminada (CLI agrupada)
Usa tu propio binario CLI o servidor
Configuración de la CLI local
Los usuarios inician sesión con GitHub
Configuración de OAuth de GitHub
Use sus propias claves de modelo (OpenAI, Azure, etc.)
BYOK (traiga su propia clave)
Azure BYOK con identidad administrada (sin claves de API)
Identidad administrada de Azure con BYOK
Ejecución del SDK en un servidor
Configuración de servicios back-end
Configuración de las opciones del SDK para usuarios simultáneos
Implementaciones multiinquilino y servidor
Atender a varios usuarios o escalar horizontalmente
Escalabilidad y multitenencia

Comparación de configuración

Diagrama: Diagrama de flujo que muestra el proceso descrito.

Prerequisites

Todas las Guías asumen que usted tiene:

  • Uno de los SDKs instalados (los SDK de Node.js, Python y .NET incluyen la CLI automáticamente):
    • Node.js: npm install @github/copilot-sdk
    • Pitón: pip install github-copilot-sdk
    • Go: go get github.com/github/copilot-sdk/go (requiere una instalación independiente de la CLI)
    • .NET: dotnet add package GitHub.Copilot.SDK

Si es nuevo, comience primero con Crea tu primera aplicación con tecnología Copilot y vuelva 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.