Pular para o conteúdo principal

Criar e Executar Remote Quick Commands

Você pode usar os Quick Commands que criou no Portal da StackSpot AI além das IDEs. Esses comandos podem ajudá-lo a usar a infraestrutura da StackSpot, como Workspaces, Stack AI e Knowledge Sources, para acelerar casos de uso de GenAI via API.

Quando usados remotamente, os Quick Commands devem aproveitar sem problemas a infraestrutura da StackSpot, incluindo Stack AI e Knowledge Sources. Além disso, Remote Quick Commands suportam o tratamento de parâmetros, permitindo que você insira variáveis ou argumentos para personalizar o comportamento dos comandos.

O objetivo do Remote Quick Command é utilização e integração por software de terceiros.

Dica!

Qual é a principal diferença entre Quick Command IDE e Remote Quick Command?

Quick Command é um recurso personalizado que funciona apenas no seu IDE. Você pode usá-lo clicando com o botão direito do mouse. Por outro lado, você pode executar Remote Quick Command via API e gerar payloads úteis para serviços externos através da internet. É perfeito para integrações e processamento além do ambiente local.

Criar um Remote Quick Command

Pré-requisitos

Passo 1. Criar e executar um Remote Quick

1. Navegue até o ‘Contents > Quick Command’ no menu principal.

2. Clique em ‘Create Quick Command’ e selecione a opção ‘Remote’. Preencha os campos para adicionar informações sobre o seu Quick Command:

  • Nome do Quick Command: adicione um nome para o seu comando

  • 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.

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

Você pode criar um RQC utilizando um template ou criar um em branco. Pode ser prompt ou web request.

- Prompt

Clique na caixa de Prompt e arraste-a para a caixa 'Iniciar', conectando-a usando a linha.

Na caixa de Prompt, preencha os campos:

  • Nome do prompt: adicione um identificador slug seguindo o padrão de slug.
  • Adicione o prompt: escreva o que você quer que seu comando faça. Inclua a variável Jinja {{input_data}} para passar dados dinâmicos.
  • Selecione um Knowledge Source e/ou um Agente.

- Web Request

Clique na caixa de Web Request e arraste-a para a caixa 'Iniciar', conectando-a usando a linha.

Na caixa de Web Request, configure a URL, os headers e o corpo da requisição para uma requisição HTTP.

  • Nome do Web request: Add a request name following the slug pattern.
  • Método HTTP: Choose a HTTP method.
  • URL Endpoint: Add the Endpoint URL.
  • Headers
  • Body da requisição

A conectividade é limitada a StackSpot AI, e seu serviço ficará disponível online. Ao usar um Quick Command na extensão do IDE, o web request opera dentro dele, habilitando funcionalidade apenas em redes privadas. Se este for o seu caso, opte pelo Quick Command.

3. Clique em 'Finalizar' e preencha a Utilização do Quick Command. Adicione:

{{o-nome-do-seuQC.answer}}

Ele representa o resultado esperado exibido no serviço.

Passo 3. Execute o Remote Quick Command via API

Você pode executar o Quick Command via API na aba ‘Como usar’. Siga os passos:

3.1. Autenticar e obter um Bearer Token

  1. Abra seu cliente de API (por exemplo, Postman);
  2. Crie uma nova requisição POST para a seguinte URL:
POST https://idm.stackspot.com/stackspot/oidc/oauth/token

  1. Adicione os seguintes headers: Content-Type: application/x-www-form-urlencoded

  2. No corpo da requisição, inclua suas credenciais de cliente::

{
  "grant_type": "client_credentials",
  "client_id": "seu_client_id",
  "client_secret": "seu_client_secret"
}
  1. Envie a requisição e copie o access_token da resposta.

3.2. Criar uma execução

  1. Crie uma nova requisição POST para o endpoint da API StackSpot para o seu Quick Command:
POST https://genai-code-buddy-api.stackspot.com/v1/quick-commands/create-execution/{{quick_command_slug}}

  1. Substitua o {{quick_command_slug}} pelo slug do seu Quick Command (por exemplo, meu-comando-remoto).

  2. Adicione os seguintes headers:

  • Authorization: Bearer seu_access_token
  • Content-Type: application/json
  1. No corpo da requisição, inclua os dados de entrada para o Quick Command:
{
  "input_data": "Adicione seu input data aqui"
}

  1. Envie a requisição. A resposta incluirá um execution_id.

3.3. Monitorar o status da execução

  1. Crie uma nova requisição GET para a seguinte URL:
GET https://genai-code-buddy-api.stackspot.com/v1/quick-commands/callback/{{execution_id}}

Substitua o execution_id pelo ID retornado na etapa anterior.

  1. Adicione o seguinte header:
  • Authorization: Bearer seu_access_token
  1. Envie a requisição. A resposta incluirá o status da execução e o resultado.

Monitore a resposta na página para status de progresso, horários de início e fim, duração, porcentagem de execução e status.

Você receberá atualizações sobre o status em cada etapa, incluindo o resultado final, que você pode usar em qualquer lugar.

Informação Adicional
  • Remote Quick Command Rate Limit

Existe um limite no número de vezes que você pode usar o Remote Quick Command dentro de um período de 24 horas. O limite varia com base no tipo de token que você está usando.

  1. Personal Access Token (PAT)

Se você já o usou mais de 100 vezes nas últimas 24 horas, não poderá usá-lo novamente até que o limite de tempo tenha expirado. Neste caso, você receberá um erro HTTP status 429. Confira o exemplo:

{
    "type": "TooManyRequests",
    "code": "CODEBUDDY_1044_QUICK_COMMAND_RATE_LIMIT_EXCEEDED",
    "details": "Maximum number of requests reached. Your limit is 100 requests in the last 1440 minutes"
}

Aguarde até que o limite de tempo tenha expirado antes de usar o Remote Quick Command novamente.

  1. Credencial de Serviço: se você usar uma Credencial de Serviço para a Conta, você tem um limite de 20 requisições por minuto e até 6.000 requisições diárias.

Apenas Account Holders podem criar Credenciais de Serviço e o limite é para toda a Conta.

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 'Compartilhar'.

Próximos Passos