Como Usar o GitHub Copilot com Bases de Conhecimento Personalizadas em Empresas

Equipes de desenvolvimento empresarial frequentemente precisam de sugestões de código de IA que reflitam bibliotecas internas, APIs proprietárias e padrões de codificação específicos da empresa. O GitHub Copilot funciona bem com código público, mas sem acesso aos seus repositórios privados ou documentação, suas sugestões podem não ser precisas. As bases de conhecimento personalizadas permitem que você forneça ao Copilot o contexto do seu próprio código para que ele gere conclusões relevantes. Este artigo explica como configurar e usar o GitHub Copilot com bases de conhecimento personalizadas em um ambiente empresarial.

Como Funcionam as Bases de Conhecimento Personalizadas do GitHub Copilot

O GitHub Copilot Enterprise inclui um recurso chamado bases de conhecimento. Uma base de conhecimento é uma coleção de repositórios que o Copilot indexa e usa como contexto ao gerar sugestões de código. Quando você digita código em um IDE conectado ao GitHub Copilot, o modelo recupera trechos relevantes dos seus repositórios de base de conhecimento. Isso torna as sugestões mais precisas para frameworks internos, bibliotecas personalizadas e APIs proprietárias.

O processo de indexação é executado nos servidores do GitHub. O serviço lê o branch padrão de cada repositório que você adiciona. Ele não armazena cópias do seu código fora da sua organização no GitHub. O índice é atualizado automaticamente a cada 24 horas, ou você pode acionar uma atualização manual. Apenas repositórios dentro da sua organização no GitHub Enterprise são elegíveis para bases de conhecimento.

Para usar esse recurso, você precisa de uma assinatura do GitHub Copilot Enterprise. Desenvolvedores individuais devem ter um assento atribuído na organização. Os administradores do repositório devem conceder acesso de leitura à conta de serviço do Copilot chamada github-copilot. Sem essa permissão, o repositório não será indexado e não aparecerá nas sugestões.

Pré-requisitos para Usar Bases de Conhecimento Personalizadas

Antes de começar, verifique estes requisitos:

• Sua organização tem um plano GitHub Copilot Enterprise. O Copilot Business e o Copilot Individual não suportam bases de conhecimento personalizadas.
• Você é proprietário da organização ou tem permissões de administrador nos repositórios que deseja adicionar.
• Os repositórios que você adiciona contêm código relevante para o trabalho diário da sua equipe. Adicionar repositórios não relacionados reduz a qualidade das sugestões.
• Seu IDE está conectado ao GitHub Copilot e autenticado com sua conta empresarial.

Passos para Criar e Configurar uma Base de Conhecimento Personalizada

1. Abra as configurações do GitHub Copilot na sua organização
   Vá para a página da sua organização no GitHub. Clique em Configurações na navegação superior. Na barra lateral esquerda, clique em Copilot e depois em Bases de conhecimento. Esta página lista todas as bases de conhecimento existentes e permite criar novas.
2. Crie uma nova base de conhecimento
   Clique em Nova base de conhecimento. Digite um nome que descreva sua finalidade, como documentacao-api-interna ou bibliotecas-compartilhadas. O nome deve ser único dentro da sua organização. Clique em Criar.
3. Adicione repositórios à base de conhecimento
   Na página de detalhes da base de conhecimento, clique em Adicionar repositórios. Selecione os repositórios da lista. Você pode adicionar até 100 repositórios por base de conhecimento. Clique em Adicionar selecionados. O serviço começa a indexar cada repositório. O tempo de indexação depende do tamanho do repositório e do número de arquivos.
4. Verifique o status da indexação
   Após adicionar os repositórios, a página da base de conhecimento mostra uma coluna de status. Indexado significa que o repositório está pronto. Indexando significa que o processo ainda está em execução. Falhou significa que o serviço não conseguiu ler o repositório. Clique no status para ver os detalhes do erro.
5. Conceda acesso de leitura à conta de serviço do Copilot
   Para cada repositório, vá em Configurações > Colaboradores e equipes. Adicione github-copilot com a função Leitura. Sem isso, a indexação falha silenciosamente. Esta etapa é necessária apenas uma vez por repositório.
6. Acione uma atualização manual, se necessário
   Na página da base de conhecimento, clique em Atualizar tudo para reindexar todos os repositórios imediatamente. A atualização leva alguns minutos. Use isso após enviar atualizações críticas para um repositório.

Usando a Base de Conhecimento no Seu IDE

Depois que a base de conhecimento for indexada, o Copilot a usa automaticamente quando você escreve código. Nenhuma configuração adicional é necessária no VS Code, JetBrains ou outros IDEs suportados. O modelo recupera trechos relevantes dos seus repositórios de base de conhecimento e os inclui como contexto para cada sugestão.

Para verificar se a base de conhecimento está ativa, abra um arquivo que faça referência a uma de suas bibliotecas internas. Comece a digitar um nome de função dessa biblioteca. Se a sugestão incluir seu código interno, a base de conhecimento está funcionando. Se as sugestões ainda mostrarem apenas código público, verifique o status da indexação e as permissões do repositório.

O Que Evitar ao Usar Bases de Conhecimento Personalizadas

Adicionar muitos repositórios reduz a qualidade das sugestões

O Copilot usa uma janela de contexto limitada. Se sua base de conhecimento contiver dezenas de repositórios não relacionados, o modelo pode não encontrar o trecho certo. Crie bases de conhecimento separadas para diferentes equipes ou projetos. Por exemplo, crie uma para bibliotecas de front-end e outra para serviços de backend.

Armazenar segredos sensíveis em repositórios indexados

O Copilot indexa arquivos, incluindo arquivos de configuração e exemplos de ambiente. Se um repositório contiver segredos reais, tokens ou senhas, esses valores se tornam parte do índice. Remova segredos antes de adicionar um repositório a uma base de conhecimento. Use a varredura de segredos do GitHub para detectar credenciais expostas.

Esperar atualizações imediatas após alterações de código

A atualização automática é executada a cada 24 horas. Se você enviar uma atualização crítica, acione uma atualização manual. Até que o índice seja atualizado, o Copilot usa a versão anterior do código. Planeje as implantações de acordo se sua equipe depende da base de conhecimento para novos recursos.

GitHub Copilot Enterprise vs GitHub Copilot Business: Suporte a Bases de Conhecimento

Item	GitHub Copilot Enterprise	GitHub Copilot Business
Bases de conhecimento personalizadas	Suportado	Não suportado
Máximo de repositórios por base de conhecimento	100	N/A
Acionar atualização manual	Sim	N/A
Intervalo de atualização automática	24 horas	N/A
Integração com IDE	VS Code, JetBrains, Visual Studio e mais	Mesmos IDEs, mas sem contexto de base de conhecimento

O GitHub Copilot Enterprise inclui bases de conhecimento como um recurso principal. Os usuários do Copilot Business não podem criar ou usar bases de conhecimento. Se sua organização já usa o Copilot Business, é necessário fazer upgrade para o Enterprise para acessar a funcionalidade de base de conhecimento personalizada.

Agora você pode configurar bases de conhecimento personalizadas no GitHub Copilot Enterprise para melhorar as sugestões de código para sua base de código interna. Comece criando uma base de conhecimento para sua biblioteca compartilhada mais usada. Após a indexação, teste as sugestões em um arquivo que importe essa biblioteca. Para organizações maiores, crie várias bases de conhecimento por equipe e atualize-as manualmente após grandes lançamentos para manter as sugestões atualizadas.