Escolhendo um caminho de instalação para o SDK do Copilot

Visão geral da arquitetura

Cada SDK do GitHub Copilot integração segue o mesmo padrão principal: o seu aplicativo se comunica com o SDK, que se comunica com o JSON-RPC de CLI do Copilot. 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.

quem é você?

Entusiasta

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:

1.           [AUTOTITLE](/copilot/how-tos/copilot-sdk/set-up-copilot-sdk/local-cli): use o CLI conectado no seu computador.
   

2. Usando uma CLI agrupada com o SDK do Copilot – empacotar tudo em um aplicativo independente.

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:

1. Usando o GitHub OAuth com o SDK do Copilot – permitir que os funcionários entrem com suas GitHub contas.
2. Configurando o SDK do Copilot para serviços de back-end – execute o SDK em seus serviços internos.

Se o dimensionamento for além de um único servidor:

1. Dimensionamento de implantações do SDK do Copilot – 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 GitHub ou gerenciando a identidade por conta própria.

Comece com:

1. Usando o GitHub OAuth com o SDK do Copilot — permitir que os clientes entrem com GitHub.

2.           [BYOK](https://github.com/github/copilot-sdk/blob/main/docs/auth/byok.md) no `github/copilot-sdk` repositório: gerencie a identidade com as suas próprias chaves de modelo.
   

3. Configurando o SDK do Copilot para serviços de back-end — alimente seu produto a partir do código de servidor.

Para produção:

1. Dimensionamento de implantações do SDK do Copilot – atenda a 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 as sessões, o dimensionamento e a multilocação.

Comece com:

1. Configurando o SDK do Copilot para serviços de back-end — integração principal do lado do servidor.
2. Dimensionamento de implantações do SDK do Copilot — isolamento de sessão, dimensionamento horizontal, persistência.

Dependendo do modelo de autenticação:

1. Usando o GitHub OAuth com o SDK do Copilot – para GitHubusuários autenticados.
2. BYOK no repositório github/copilot-sdk — para autogerenciamento de identidade e acesso a modelos.

Matriz de decisão

Use esta tabela para encontrar o guia certo com base no que você precisa fazer.

O que você precisa	Guide
Configuração mais simples possível
Usando uma CLI local com o SDK do Copilot
Enviar um aplicativo autônomo com o Copilot
Usando uma CLI agrupada com o SDK do Copilot
Os usuários entram com GitHub
Usando o GitHub OAuth com o SDK do Copilot
Use suas próprias chaves de modelo (OpenAI, Azure, etc.)
BYOK no github/copilot-sdk repositório
BYOK do Azure com Identidade Gerenciada (sem chaves de API)
Usando a Identidade Gerenciada do Azure com o SDK do Copilot
Executar o SDK em um servidor
Configurando o SDK do Copilot para serviços de back-end
Atender a vários usuários ou dimensionar horizontalmente
Dimensionamento de implantações do SDK do Copilot

Pré-requisitos

Todos os guias pressupõem que você tenha:

• CLI do Copilot Instalado. Para obter mais informações, consulte Instalando a CLI do GitHub Copilot.
• Um dos SDKs instalados :
  • Node.js: npm install @github/copilot-sdk
  • Python: pip install github-copilot-sdk
  • Go: go get github.com/github/copilot-sdk/go
  • .NET: dotnet add package GitHub.Copilot.SDK
  • Java: Consulte o github/copilot-sdk-java repositório para configuração do Maven/Gradle

Se você for novo no SDK do GitHub Copilot, comece com Introdução ao SDK do Copilot primeiro e retorne 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.