Visão geral da arquitetura
Cada integração do SDK Copilot segue o mesmo padrão principal: seu aplicativo conversa com o SDK, que se comunica com a CLI do Copilot por JSON-RPC. O que muda entre as configurações é onde a CLI é executada, como os usuários se autenticam e como as sessões são gerenciadas.
Os guias de instalação abaixo ajudam você a configurar cada camada para seu cenário.
Quem é você?
🧑💻 Amador
Você está criando um assistente pessoal, um projeto lateral ou um aplicativo experimental. Você deseja o caminho mais simples para colocar Copilot em seu código.
Comece com:
- ** Configuração padrão (CLI empacotada)** — O SDK inclui a CLI automaticamente — basta instalar e ir
- ** Configuração da CLI local**—Use seu próprio binário da CLI ou uma instância já em execução (avançado)
🏢 Desenvolvedor de aplicativos interno
Você está criando ferramentas para sua equipe ou empresa. Os usuários são funcionários que precisam se autenticar com suas contas corporativas GitHub ou associações de organização.
Comece com:
- ** Configuração do OAuth do GitHub**— Permitir que os funcionários entrem com suas contas GitHub
- ** Configuração de serviços de back-end** – Executar o SDK em seus serviços internos
Se o dimensionamento for além de um único servidor:
- ** Escalabilidade e multitenância**—Gerenciar vários usuários e serviços
🚀 Desenvolvedor de aplicativos (ISV)
Você está criando um produto para os clientes. Você precisa lidar com a autenticação para seus usuários, seja por meio de GitHub ou gerenciando a identidade por conta própria.
Comece com:
- ** Configuração do OAuth do GitHub** — Permitir que os clientes entrem com GitHub
- ** BYOK (bring your own key)**—Gerencie sua identidade por conta própria com suas próprias chaves de modelo
- ** Configuração de serviços de back-end** — Habilitar seu produto a partir do código do lado do servidor
Para produção:
- ** Escalabilidade e multitenância** — Atender muitos clientes de forma confiável
🏗️ Desenvolvedor de plataforma
Você está inserindo o Copilot em uma plataforma — APIs, ferramentas de desenvolvedor ou infraestrutura na qual outros desenvolvedores se baseiam. Você precisa de controle refinado sobre sessões, dimensionamento e multilocação.
Comece com:
- ** Configuração de serviços de back-end** — Integração principal do lado do servidor
- ** Escalabilidade e multitenância** — Isolamento de sessão, dimensionamento horizontal, persistência
Dependendo do modelo de autenticação:
- ** Configuração do OAuth do GitHub** — Para usuários autenticados GitHub
- ** BYOK (bring your own key)**—Para identidade autogerenciada e acesso ao modelo
Matriz de decisão
Use esta tabela para encontrar os guias certos com base no que você precisa fazer:
| O que você precisa | Guide |
|---|---|
| Introdução rápida | |
| Configuração padrão (CLI empacotada) | |
| Usar seu próprio binário da CLI ou seu próprio servidor | |
| Configuração da CLI local | |
| Usuários fazem login com o GitHub | |
| Configuração do OAuth do GitHub | |
| Use suas próprias chaves de modelo (OpenAI, Azure, etc.) | |
| BYOK (bring your own key) | |
| BYOK do Azure com Identidade Gerenciada (sem chaves de API) | |
| Identidade gerenciada do Azure com BYOK | |
| Executar o SDK em um servidor | |
| Configuração de serviços de back-end | |
| Atender a vários usuários/dimensionar horizontalmente | |
| Escalabilidade e multitenância |
Comparação de configuração
Pré-requisitos
Todos os guias pressupõem que você tenha:
- Um dos SDKs instalados (Node.js, Python e os SDKs do .NET incluem a CLI automaticamente):
- Node.js:
npm install @github/copilot-sdk - Python:
pip install github-copilot-sdk - Go:
go get github.com/github/copilot-sdk/go(requer instalação separada da CLI) - .NET:
dotnet add package GitHub.Copilot.SDK
- Node.js:
Se você for novo, comece com o Crie seu primeiro aplicativo com tecnologia do Copilot primeiro e volte aqui para a configuração de produção.
Próximas Etapas
Escolha o guia que corresponde à sua situação na matriz de decisão acima ou comece com a descrição da persona mais próxima de sua função.