Usando ganchos de contexto - Amazon Q Developer

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Usando ganchos de contexto

Ganchos de contexto são um recurso na CLI do Amazon Q Developer que você pode usar para injetar contexto automaticamente em suas conversas com o Q Developer. Em vez de adicionar contexto manualmente com o /context comando, os ganchos de contexto executam comandos e incluem sua saída como contexto.

Tipos de ganchos de contexto

O Q Developer CLI oferece suporte a dois tipos de ganchos de contexto:

Ganchos de início de conversa

Execute uma vez no início de uma conversa. Sua saída é adicionada ao contexto da conversa e persiste durante toda a sessão.

Ganchos por solicitação

Execute com cada mensagem do usuário. Sua saída é adicionada somente ao prompt atual.

Gerenciando ganchos de contexto

Você pode gerenciar ganchos de contexto usando o /context hooks comando na CLI do Q Developer.

Veja seus ganchos

Para visualizar todos os ganchos configurados nos níveis global e de perfil:

/context hooks

Esse comando exibe todos os ganchos configurados para seu perfil atual e em nível global, junto com seu status (ativado ou desativado).

Adicione um gancho

Para adicionar um novo gancho de contexto:

/context hooks add [--global] <name> --trigger <trigger> --command <command>
<name>

Um nome exclusivo para o gancho

<trigger>

per_prompt ou conversation_start

<command>

O comando shell a ser executado

--global

(Opcional) Adicione o gancho à configuração global em vez do perfil atual

exemplo Adicionando um gancho de status do git
/context hooks add git-status --trigger per_prompt --command "git status --short"

Remova um gancho

Para remover um gancho de contexto existente:

/context hooks rm <name> [--global]

Ativar ou desativar ganchos

Para ativar um gancho específico:

/context hooks enable [--global] <name>

Para desativar um gancho específico:

/context hooks disable [--global] <name>

Para ativar todos os ganchos:

/context hooks enable-all [--global]

Para desativar todos os ganchos:

/context hooks disable-all [--global]

Obtenha ajuda com ganchos

Para exibir ajuda detalhada para os comandos hooks:

/context hooks help

Configurações

Você pode verificar a configuração de seus ganchos nos seguintes locais.

Se o gancho for global:

~/.aws/amazonq/global_context.json

Se o gancho for baseado em perfil:

~/.aws/amazonq/profiles/profile-name/context.json

Exemplo de casos de uso

Os exemplos a seguir demonstram casos de uso comuns para ganchos de contexto.

Status do Git

Adicione um gancho para mostrar o status do git com cada prompt:

/context hooks add git-status --trigger per_prompt --command "git status --short"

Esse gancho executa o git status --short comando antes de cada prompt e inclui a saída em sua conversa com o Q Developer. Isso ajuda o Q Developer a entender o estado atual do seu repositório git quando você faz perguntas sobre controle de versão ou precisa de ajuda com os comandos git.

Informações do projeto

Adicione um gancho para mostrar as informações do projeto no início de uma conversa:

/context hooks add project-info --trigger conversation_start --command "echo 'Project: '$(basename $(pwd))"

Esse hook é executado uma vez no início da conversa e inclui o nome do projeto atual no contexto. Isso ajuda o Q Developer a fornecer respostas mais relevantes e específicas para seu projeto.

dica

Você pode expandir esse gancho para incluir mais informações do projeto, como a linguagem de programação, a estrutura ou a estrutura do projeto.

Comportamento e limitações

Ao usar ganchos de contexto, tenha em mente os seguintes comportamentos e limitações:

  • Os ganchos funcionam paralelamente para minimizar o impacto no tempo de resposta

  • A saída do gancho é formatada e claramente marcada no contexto

  • O /clear comando reavalia os ganchos de início da conversa

  • Os ganchos são armazenados na configuração da CLI do Q Developer

  • Atualmente, somente ganchos de comando embutidos são suportados

  • A saída do gancho é limitada a 10 KB por gancho

  • Os ganchos expiram após 5 segundos por padrão

Considerações sobre segurança

Ao usar ganchos de contexto, considere as seguintes práticas recomendadas de segurança:

  • Os ganchos de contexto executam comandos shell com suas permissões de usuário atuais. Tenha cuidado com os comandos que você inclui em seus ganchos, pois eles têm o mesmo acesso que sua conta de usuário.

  • Tenha cuidado ao adicionar ganchos que possam expor informações confidenciais, como credenciais ou dados pessoais. Analise a saída de seus ganchos para garantir que eles não incluam informações que você não deseja compartilhar.

  • Considere desativar os ganchos quando eles não forem necessários. Isso reduz o risco de expor acidentalmente informações confidenciais.

  • Não use ganchos para executar comandos que possam modificar seu sistema ou dados. Os ganchos devem ser usados para ler informações, não para fazer alterações.

  • Tenha cuidado ao usar ganchos em ambientes compartilhados. Outros usuários podem ver a saída de seus ganchos se tiverem acesso às suas sessões do Q Developer CLI.

Atenção

Nunca inclua comandos em seus ganchos que exponham senhas, chaves de acesso ou outras credenciais. Essas informações podem ser armazenadas em seu histórico de conversas e potencialmente expostas a outras pessoas.

Solução de problemas

Se você encontrar problemas com ganchos de contexto, tente as seguintes soluções:

Solução de problemas de ganchos de contexto
Problema Solução
O gancho não funciona Verifique se o gancho está habilitado com /context hooks
Falha no comando Teste o comando diretamente no seu terminal para garantir que ele funcione
A saída é muito grande Modifique seu comando para limitar o tamanho da saída
O tempo limite do gancho Otimize seu comando para uma execução mais rápida