Integração da API Genie do Databricks com fluxos de trabalho de API

O Databricks Genie permite a interação de linguagem natural com seus dados corporativos, permitindo que você consulte, analise e aja em conjuntos de dados sem precisar escrever código.

Este guia fornece uma explicação prática de como interagir com uma API do Databricks Genie para obter informações com base em uma entrada de pergunta. Ele executa as seguintes ações principais:

• Inicializa variáveis— Configura parâmetros necessários, como tokens, URLs e IDs.
• Gets a token— Faz uma solicitação HTTP POST para obter um token de acesso para a autenticação.
• Inicia uma conversa— Envia a pergunta do usuário para a API Genie para iniciar uma conversa.
• Pesquisas de conclusão de mensagem— entra em um loop Do While para verificar repetidamente o status da mensagem do Genie até que seja CONCLUÍDO.

• Recupera resultados de consultas—Depois que a mensagem é concluída, ela busca os resultados finais da consulta da API Genie e fornece os dados recuperados como a saída do fluxo de trabalho.

Pré-requisitos

Primeiro, você precisa ter um espaço Genie chamado "Restrições de itens" em seu espaço de trabalho do Databricks.

Seu objetivo é fazer referência a restrições de envio para diferentes produtos e fornecer respostas sobre detalhes de envio.

1. Crie um fluxo de trabalho da API.
2. Defina entradas de fluxo de trabalho. Abra o Data Manager e adicione um novo parâmetro Entradas com a seguinte configuração:
   • Nome— Pergunta
   • Tipo— String
   • Marque-a como Obrigatório.
3. Defina as variáveis do fluxo de trabalho. Abra Data Manager > Variáveis e adicione o seguinte:
   • token (String)— Armazena o token de autenticação necessário para acessar a API Databricks Genie.
   • conversation_id (String)—Rastreia uma sessão de conversa específica com a API Databricks Genie. Quando você inicia uma conversa, a API fornece esse ID, e você o usa para se referir a essa conversa em andamento em solicitações subsequentes.
   • message_id (String)—Refere-se a uma mensagem específica em uma conversa. Esse ID é então usado para recuperar o status e, eventualmente, os resultados desse processamento de mensagem específico.
   • attachment_id (String)—Aponta para um anexo específico (que, neste caso, tem o resultado da consulta) associado a uma mensagem na API Genie.
   • url (String)—Armazena o URL base para o endpoint da API do Databricks Genie.
   • space_id (String)—Aponta para um espaço específico dentro do Databricks Genie.
4. Adicione uma atividade HTTP para recuperar o token de acesso e configure-a da seguinte forma:
   • Nome de exibição—"Get token HTTP Request"
   • Método— POST
   • URL da solicitação—https://accounts.cloud.databricks.com/oidc/accounts/{account_id}/v1/token
   • Cabeçalhos—

     {
     "Authorization": "Basic <your_basic_token>",
     "Content-Type": "application/x-www-form-urlencoded"
     }

   • Corpo da solicitação—

     "grant_type=client_credentials&scope=all-apis"

   O nome da saída de contexto para essa atividade é HTTP_Request_1.
5. Atribua o token recuperado da atividade anterior à sua variável token . Adicione uma atividade Assign e configure-a da seguinte forma:
   • Para a variável—token
   • Definir valor—$context.outputs.HTTP_Request_1.content.access_token

   O nome da saída do contexto HTTP_Request_1 pode ser diferente do usado em seu fluxo de trabalho.
6. Adicione uma atividade HTTP para iniciar a conversa e configure-a da seguinte forma:
   • Nome de exibição—"Iniciar solicitação HTTP de conversa"
   • Método— POST
   • URL da solicitação—https://{your-databricks-instance}/api/2.0/genie/spaces/{space_id}/start-conversation, ou crie-a com o Editor de expressão como

     $context.variables.url + "/api/2.0/genie/spaces/"+ $context.variables.space_id +"/start-conversation"

   • Cabeçalhos—

     {"Authorization": "Bearer " + $context.variables.token}

   • Corpo da solicitação—

     {"content": $workflow.input.question}

   Certifique-se de que a saída seja salva. Você pode recuperar conversation_id e message_id da saída desta atividade.

   O nome da saída de contexto para essa atividade é HTTP_Request_2.
7. Insira um loop para verificar o status da mensagem Genie até CONCLUÍDO. Adicione uma atividade Do While e defina a Condição como $context.outputs.HTTP_Request_3?.content?.status !== "COMPLETED", onde HTTP_Request_3 se refere à atividade Get message HTTP Request. Isso significa que o loop continuará enquanto o status da mensagem não for CONCLUÍDO.
8. Dentro do loop Do While :
   1. Adicione uma atividade HTTP para receber a última mensagem e configure-a da seguinte forma:
      • Nome de exibição—"Get message HTTP Request"
      • Método—GET
      • URL da solicitação—https://{your-databricks-instance}/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}, ou crie-a com o Editor de expressão como

        [ $context.variables.url+"/api/2.0/genie/spaces/"+$context.variables.space_id+"/conversations/", $context.outputs.HTTP_Request_2.content.conversation_id, "/messages/", $context.outputs.HTTP_Request_2.content.message_id ].join('')

        Onde HTTP_Request_2 se refere à atividade Conversa HTTP Request.
      • Cabeçalhos—

        {"Authorization": "Bearer " + $context.variables.token}

      • Corpo da solicitação—

        {"content": $workflow.input.question}

      O nome da saída de contexto para essa atividade é HTTP_Request_3.
   2. Adicione uma atividade If imediatamente após a atividade Get message HTTP Request e defina a Condição como $context.outputs.HTTP_Request_3?.content?.status === "COMPLETED", onde HTTP_Request_3 se refere à atividade Get message HTTP Request.
   3. Na ramificação Then (true), adicione uma atividade Assign e configure-a da seguinte forma:
      • Para a variável—conversation_id
      • Defina o valor—$context.outputs.HTTP_Request_3.content.conversation_id, onde HTTP_Request_3 se refere à atividade Get message HTTP Request.
   4. Adicione outra atividade Assign :
      • Para a variável—message_id
      • Defina o valor—$context.outputs.HTTP_Request_3.content.message_id, onde HTTP_Request_3 se refere à atividade Get message HTTP Request.
   5. Adicione outra atividade Assign :
      • Para a variável—attachment_id
      • Defina o valor—$context.outputs.HTTP_Request_3.content.attachments[0].attachment_id, onde HTTP_Request_3 se refere à atividade Get message HTTP Request.
   6. Na ramificação Else , adicione uma atividade Wait e defina a duração como um segundo. Isso instrui o fluxo de trabalho a aguardar um curto período antes de tentar novamente.
9. Saia do loop e adicione uma atividade HTTP para executar a consulta SQL e configure-a da seguinte maneira:
   • Nome de exibição—"Executar solicitação HTTP do SQL"
   • Método—GET
   • URL da solicitação—https://{your-databricks-instance}/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}/query-result, ou crie-a com o Editor de expressão como

     $context.variables.url+"/api/2.0/genie/spaces/"+$context.variables.space_id+"/conversations/" + $context.variables.conversation_id + "/messages/"  + $context.variables.message_id + "/attachments/" +  $context.variables.attachment_id + "/query-result"

   • Cabeçalhos—

     {"Authorization": "Bearer " + $context.variables.token}

   O nome da saída de contexto para essa atividade é HTTP_Request_3.
10. Defina saídas de fluxo de trabalho. Abra o Data Manager e adicione os seguintes parâmetros de Entrada :
    • Nome— Row_count
    • Tipo—Número
    • Marque-a como Obrigatório.

    e

    • Nome—data_array
    • Tipo— Array
    • Marque-a como Obrigatório.
11. Adicione uma atividade Response e configure-a da seguinte maneira:
    • Resposta—

      {
        "row_count": -75647404.57028332,
        "data_array": [
          [],
          [],
          [
            "ut et aute officia",
            "ex ut",
            "nisi non ut Lorem velit",
            "aliquip Duis consectetur irure id"
          ]
        ]
      }

12. Execute a integração. Depois de implantado, o fluxo de trabalho pode ser invocado com qualquer consulta de linguagem natural. Um exemplo de pergunta poderia ser: "Existe alguma restrição para enviar SKU ENF-SP-200 para Cuba?"

Principais pontos:

1. Configuração simples - O fluxo de trabalho da API fornece uma maneira rápida de conectar o Genie sem código personalizado.
2. Esquema consistente – As respostas do Genie são baseadas em JSON, fáceis de analisar no UiPath.
3. Integração escalável — as respostas podem ser usadas em apps, fluxos de trabalho de longa duração ou orquestrações.
4. Prototipagem rápida — a configuração para automação de trabalho leva minutos, permitindo a validação rápida dos casos de uso.