Pular para o conteúdo principal

Exemplo de Remote Quick Command

Exemplo: Criar e executar um Remote Quick Command de tradução

Este guia te orienta na criação e execução de um Remote Quick Command para traduzir texto de inglês para espanhol usando a plataforma da StackSpot AI.

Passo 1. Criar um Remote Quick Command

  1. Faça login no Portal da StackSpot AI;
  2. Navegue até a seção ‘Contents > Quick Command’ no lado esquerdo do menu;
  3. Clique em ‘Criar Quick Command’ e selecione a opção ‘Remote’;
  4. Preencha as informações do Quick Command:

  • Nome: Traduzir Inglês para Espanhol

  • Comando [O nome da URL]: translate-english-to-spanish

  • Descrição: Traduza textos em inglês para espanhol

  • Clique no botão ‘Próximo‘, depois clique em ‘Blank‘ e, em seguida, clique no botão ‘Criar‘;

  1. Escolha a opção Prompt e preencha:
  • Nome do Prompt: translate-en-es
  • Insira seu prompt: "Translate the following text from English to Spanish: {{input_data}}"

  1. Clique em 'Finish' para preencher os dados finais do Quick Command.

  2. Em 'Utilização do Quick Command', clique nas opções input_data e \{\{translate-en-es.answer}}. Clique 'Finish'.

Passo 2. Gerar Token de Acesso (Access Token)

  1. Na seção Access Token, clique no botão 'Gerar client key';
  2. Uma nova aba será aberta. Clique em 'Gerar Tokens';
  3. Copie o exemplo de curl fornecido e salve-o. Você irá precisar dele para autenticar suas solicitações de API no passo 3.

Para mais detalhes sobre como gerar Tokens, confira a documentação da StackSpot EDP.

Passo 3. Executar o Quick Command via API

Certifique-se de ter o Postman instalado ou outro cliente de API. Este exemplo funciona sem erros apenas no Postman.

Para executar o Quick Command, faça uma solicitação POST/GET para o endpoint da API StackSpot. Siga os passos a seguir:

  1. Abra o Postman. Clique em 'Import' e cole o exemplo de curl que você copiou anteriormente.
    • Uma nova aba será aberta com a URL POST semelhante a:
   POST https://idm.stackspot.com/stackspot/oidc/oauth/token
  • Clique em enviar e copie o token da resposta.

  1. Na seção de headers em uma nova aba, adicione seu token e a chave:

    • Chave: Authorization
    • Valor: Bearer seu_token

  2. Agora, na aba POST, adicione a URL ‘Create Execution’ da StackSpot. Confira o exemplo:

POST https://genai-code-buddy-api.stackspot.com/v1/quick-commands/create-execution/translate-english-to-spanish

Informação Adicional

Você pode manter a mesma conversa entre várias execuções, se desejar. Para fazer isso, você deve enviar um parâmetro de consulta conversation_id com o mesmo ULID para todas as execuções.

  • Você precisará fazer a primeira solicitação RQC sem incluir o conversation_id para recebê-lo na resposta. Nas solicitações seguintes, você pode fornecer o conversation_id recebido na primeira solicitação.

Exemplo:


POST https://genai-code-buddy-api.stackspot.com/v1/quick-commands/create-execution/translate-english-to-spanish?conversation_id=01J03MBAJ17FV25JKDE3NCQ8WH

  1. Adicione o corpo da requisição que, nesse caso, é um prompt para traduzir para o Espanhol:
{

 "input_data": "Hi, how are you? This is an example of how to create Remote Quick Command."

}

  1. A requisição retorna um valor. Você precisa copiá-lo e salvá-lo.

  2. Abra outra aba no Postman com GET. Copie o Callback no site da StackSpot e cole-o.

Você deve colar o Access Token no cabeçalho novamente.

  1. Substitua o {{execution_id}} na URL pelo valor retornado da solicitação POST:
GET https://genai-code-buddy-api.stackspot.com/v1/quick-commands/callback/{execution_id}

Confira o exemplo:


GET https://genai-code-buddy-api.stackspot.com/v1/quick-commands/callback/01HZ828C3K4E2093EYBABG014K

  1. A resposta fornecerá o texto traduzido em espanhol para a entrada que você adicionou. Certifique-se de que o processamento seja concluído com sucesso verificando se o campo execution_percentage é igual a 1.0 (100%) e o status é COMPLETED.

Continue verificando em intervalos até que a resposta indique 100% de conclusão.

Você irá encontrar o resultado do serviço no campo de resultado.

{
   "execution_id": "01HZ828C3K4E2093EYBABG014K",
   "quick_command_slug": "translate-english-to-spanish",
   "conversation_id": "01HZ828C3KXNTD8CQAWV056ZVG",
   "progress": {
       "start": "2024-05-31T19:33:03.731642+00:00",
       "end": "2024-05-31T19:33:09.141119+00:00",
       "duration": 5,
       "execution_percentage": 1.0,
       "status": "COMPLETED"
   },
   "steps": [
       {
           "step_name": "translate-english-to-spanish",
           "execution_order": 0,
           "type": "LLM",
           "step_result": {
               "answer": "Hola, ¿cómo estás? Este es un ejemplo de cómo crear un Comando Rápido Remoto.",
               "sources": []
           }
       }
   ],
   "result": " Hi, how are you? This is an example of how to create a Remote Quick Command.  Hola, ¿cómo estás? Este es un ejemplo de cómo crear un Comando Rápido Remoto." 
}