Como criar Quick Commands IDE

Criando o seu Quick Command

Siga os passos abaixo para criar:

Passo 1. Acesse o Portal da StackSpot AI

Passo 2. No menu lateral esquerdo, clique em ‘Quick Command’

Passo 3. Clique no botão ‘Criar Quick Command IDE’

Passo 4. Clique em 'Início' e preencha os campos em ‘Informação Quick Command’ para adicionar informações sobre o seu quick command

Confira um exemplo abaixo:

Nome: adicione um nome para o seu comando

Technical Debt

Comando: adicione um nome que você usará mais tarde; ele deve seguir o padrão de slug. Para mais informações sobre Slugs, confira o padrão do slug.

/technical_debt_1

Descrição: adicione uma descrição do que o seu comando pode fazer.

Criar uma issue no GitHub destacando a dívida técnica no código selecionado e sugerir uma forma de correção.

Passo 5. siga o fluxo na tela. Clique no botão 'adicionar'. Escolha ‘Prompt’

1. Prompt

Preencha os campos:

Insira seu prompt: adicione um identificador slug seguindo o padrão de slug. Confira um exemplo:

/nome_prompt_1 /titulo__da_issue

Insira seu prompt: escreva o que você quer que seu comando faça.

Se você quiser que o usuário selecione um trecho específico de código, insira o {{selected_code}} na caixa designada. Adicionar esta opção envia a informação para a StackSpot AI e facilita o entendimento, confira o exemplo abaixo:

Leia este {{selected_code}} e escreva um título de até 80 caracteres para uma issue no GitHub.

Use a Stack atual para gerar código: Esta opção depende das suas necessidades.
- Quando habilitada, considera o contexto da sua Stack e gera código baseado se você tem uma Stack de Java ou Python, por exemplo. Se você requer geração de código, então esta opção é necessária.
- No entanto, se você precisa gerar texto, como traduções, é melhor não habilitar esta opção, pois não deve produzir os melhores resultados.
2. Selecionar Knowledge Sources

Isso não é obrigatório. Você deve escolher esta opção ao criar um Quick Command e quiser selecionar um contexto específico de um Knowledge Source. Esta opção é útil ao criar um comando que requer conhecimento detalhado, como procurar vulnerabilidades baseadas em políticas de segurança.

Passo 6. Clique no botão ‘Criar +’. Confira o resumo do seu comando

Ele usa o formato Jinja

Exemplo:

Titulo_da_issue Leia este {{selected_code}} e escreva um título de até 80 caracteres para uma issue no GitHub.

Captura de tela da tela de criação de Quick Command no portal da StackSpot. Um destaque é exibido na área de adicionar a função do Quick Command, que é 'Summarize this selected_code} snippet for a GitHub issue description

Clique em 'End' e então na Tela de Resultado Final: Insira .answer após o nome do seu Quick Command (apenas se for uma opção de prompt):

{{title_issue.answer}}

Passo 7. Clique ‘End > Finalizar Flow’

2. Criando um Web Request

Criando um Web Request para abrir uma issue no GitHub, por exemplo.

Preencha os campos:

Nome do Web request: adicione um nome para a solicitação seguindo o padrão de slug. Exemplo:

/solicitacao_github

Método HTTP: escolha um método HTTP.

GET

URL Endpoint: adicione a URL do Endpoint.

https://api.example.com/users

Headers:

content-type: application/json
authorization: Bearer your_access_token

Corpo da Solicitação:

{ 
    "name": "John".
    "age": 30

}

Confira o exemplo:

Captura de tela da tela de criação de Web Request no portal da StackSpot. A imagem mostra campos para inserir o nome do Web Request, o método HTTP, o URL do endpoint, cabeçalhos e corpo da requisição.

tip

Use Jinja para interpolar valores no endpoint da URL, cabeçalhos (headers) e corpo da solicitação (request body). Por exemplo, adicione uma variável como {{selected_code}} na URL ou cabeçalho.

Passo 8. Clique em 'End' e preencha a Utilização do Quick Command

Escolha a forma como o usuário pode interagir com o seu Quick Command na IDE, confira abaixo:

Substituir o código selecionado
Acima do código selecionado
Abaixo do código selecionado
Chat
Resultado final: Esta opção mostra a mensagem de sucesso que o usuário verá usando o seu Quick Command. Você pode editar a mensagem e escolher o modo de utilização também. Confira o exemplo abaixo mostrando a URL para criar uma issue no GitHub:

Resultado final Insira { para visualizar as opções de entrada pré-definidas ou clique nas tags abaixo: select_mode, titulo_da_issue, summarize, propose_improvement;

Usar contexto de chat: Esta opção usa respostas e interações de Quick Command anteriores como contexto para interações subsequentes em uma sessão de chat específica. Você pode usar esta opção para ter uma experiência mais coerente e enriquecida contextualmente em suas interações dentro da plataforma. A StackSpot AI usa entradas e respostas anteriores para informar e aprimorar seus comandos e respostas futuras.

Sua issue foi criada com sucesso no seguinte URL: {{create_issue.json[0].url}}

Passo 8. Clique em ‘End > Terminar Flow’

info

Como posso navegar por cada etapa desse fluxo de criação?

Quando a resposta é um JSON, você pode navegar por partes específicas das etapas anteriores que você fez no fluxo de criação. Você pode trabalhar com os atributos, os valores, etc. Esse passo é essencial porque você pode extrair o que o usuário precisa. Por exemplo, um campo daquele serviço que você criou, um cabeçalho, qual foi o status, etc.

Se você precisar saber qualquer valor das etapas anteriores, adicione as informações abaixo:

1. Web Request Confira abaixo um servidor que pode retornar o seguinte formato de objeto:

Headers: {"headers_name": "value", ...}
data: text
status: [200-599]
json: json - dictionary of the "data"

Exemplo: {{create_issue.json[0].url}}

Se os dados que você recebe estão em formato JSON, você pode facilmente navegar pelos valores e atributos dos seus dados.
O campo json estará vazio se não for um JSON.

2. Prompt Por padrão, você pode navegar pelos seguintes campos:

answer: string
prompt_tokens: string
completion_tokens: string
total_cost: Decimal

Exemplo: {{my_prompt.answer}}

O que você pode fazer a seguir?

Após criar o seu Quick Command, adicione-o ao seu Workspace, dependendo da sua permissão.

1. Compartilhar o seu Quick Command

Você pode compartilhar um Quick Command que criou com outros usuários. Isso permitirá o uso direto dentro das IDEs da Conta.

Na tela de 'Quick Commands' clique no botão de compartilhar no lado esquerdo para compartilhar.

2. Adicione o QC ao seu Workspace para torná-lo disponível na sua organização

Confira se você tem permissão para fazer isso. Se precisar de ajuda, contate o administrador da sua conta.

Siga as instruções:

No menu lateral esquerdo, acesse 'Workspace';
Clique em 'Adicionar Quick Command';
Selecione os comandos que deseja e clique em 'Adicionar Quick Command.'

info

Encontre Knowledge Sources dentro do Workspace com o Quick Command. No entanto, usar um Quick Command não afeta os Knowledge Sources.
O único Knowledge Sources que afetam o seur Quick Command são os que você adicionou ao criar o comando.

Excluir um Quick Command IDE conectado a um Workspace

caution

Esta ação é irreversível.

Excluir um Quick Command IDE em um Workspace pode afetar outras pessoas usuárias. Siga os passos:

No o menu lateral esquerdo vá para ‘Quick Command’;
Selecione o Quick Command que deseja excluir e clique em ‘Configurações’;
Clique no botão ‘Excluir’