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

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.

Criando um Remote Quick Command segue o mesmo processo de criação do Custom. Confira os passos:

Passo 1. Faça login na sua Conta da StackSpot AI;

Passo 2. Navegue até o ‘Contents > Quick Command’ no menu principal. Clique em ‘Create Quick Command’, 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.

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

  1. 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 o {{input_data}}.
  • Selecione um Knowledge Source
  1. Http Request

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

Na caixa de Http Request, preencha os campos:

  • 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 solicitaçã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.

Passo 4. 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.

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.

Como usar?

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

Passo 1. gere seu Token de Acesso clicando no botão de ’Generate client key’ na aba superior;

Para mais detalhes, confira o guia de Credencial de Serviço na documentação do EDP da StackSpot.

Passo 2. na seção Criar (POST), obtenha o endpoint para criar uma execução do Quick Command. A URL deve conter o nome do seu Quick Command e você pode usar {{input_data}} como um parâmetro encontrado no corpo da solicitação da mesma página. Isso envia uma solicitação de serviço com os dados específicos que você requer.

Os dados de entrada podem ser uma string ou um JSON.

Passo 3. o endpoint recupera a resposta para a solicitação de serviço (callback (GET)). Inclua o execution_id como um parâmetro de caminho;

Passo 4. 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.

Próximos Passos