Intégration de l'API Databricks Genie avec les workflows d'API

Databricks Genie permet l'interaction en langage naturel avec vos données d'entreprise, ce qui vous permet d'interroger, d'analyser et d'agir sur des ensembles de données sans avoir besoin d'écrire du code.

Ce guide explique comment interagir avec une API Databricks Genie afin d'obtenir des informations en fonction des saisies de question. Il effectue les principales actions suivantes :

• Initialise les variables : configure les paramètres nécessaires tels que les jetons, les URL et les identifiants.

• Obtient un jeton : effectue une requête POST HTTP pour obtenir un jeton d’accès à des fins d’authentification.

• Démarre une conversation : envoie la question de l'utilisateur à l'API Genie pour engager une conversation.

• Interrogations pour la complétion du message : entre dans une boucle Do While pour vérifier à plusieurs reprises le statut du message Genie jusqu'à ce qu'il soit TERMINÉ (COMPLETE).

• Récupère les résultats de la requête : une fois le message terminé, il récupère les résultats de la requête finale à partir de l’API Genie et fournit les données récupérées comme sortie du workflow.

  

Prérequis

Tout d'abord, vous devez avoir un espace Genie appelé « Restrictions d'éléments » dans votre espace de travail Databricks.

Son objectif est de référencer les restrictions d’expédition pour différents produits et de fournir des réponses concernant les détails d’expédition.

1. Créez un workflow d’API.

2. Définissez les entrées de workflow. Ouvrez le gestionnaire de données et ajoutez un nouveau paramètre Entrées avec la configuration suivante :

   • Nom—Question
   • Type—String
   • Marquez-le comme obligatoire.

3. Définissez des variables de workflow. Ouvrez le Gestionnaire de données > Variables et ajoutez les éléments suivants :

   • token (String) : stocke le jeton d'authentification nécessaire pour accéder à l'API Databricks Genie.
   • conversation_id (String) : suit une session de conversation spécifique avec l'API Databricks Genie. Lorsque vous démarrez une conversation, l'API fournit cet ID et vous l'utilisez pour faire référence à cette conversation en cours dans les requêtes suivantes.
   • message_id (String) : fait référence à un message spécifique au sein d'une conversation. Cet ID est ensuite utilisé pour récupérer le statut et éventuellement les résultats du traitement de ce message particulier.
   • attachment_id (String) : indique une pièce jointe spécifique (qui, dans ce cas, contient le résultat de la requête) associée à un message dans l'API Genie.
   • url (String) : stocke l'URL de base du point de terminaison de l'API Databricks Genie.
   • space_id (String) : indique un espace spécifique dans Databricks Genie.

4. Ajoutez une activité HTTP pour récupérer le jeton d'accès et configurez-la comme suit :

   • Nom d’affichage—« Obtenir la requête HTTP du jeton »
   • Méthode—PUBLIER
   • URL de la demande—https://accounts.cloud.databricks.com/oidc/accounts/{account_id}/v1/token
   • En-têtes—

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

   • Corps de la requête—

     "grant_type=client_credentials&scope=all-apis"
     ```The context output name for this activity is `HTTP_Request_1`.
     

5. Affectez le jeton récupéré dans l'activité précédente à votre variable token . Ajoutez une activité Attribuer et configurez-la comme suit :

   • En variable—token
   • Définir la valeur—$context.outputs.HTTP_Request_1.content.access_tokenLe nom de la sortie du contexte HTTP_Request_1 peut différer de celui utilisé dans votre workflow.

6. Ajoutez une activité HTTP pour démarrer la conversation et configurez-la comme suit :

   • Nom complet—« Démarrer la conversation HTTP Requête »
   • Méthode—PUBLIER
   • URL de la demande—https://{your-databricks-instance}/api/2.0/genie/spaces/{space_id}/start-conversation, ou créez-la avec l'éditeur d'expressions

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

   • En-têtes—

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

   • Corps de la requête—

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

   Assurez-vous que la sortie est enregistrée. Vous pouvez récupérer conversation_id et message_id à partir de la sortie de cette activité. Le nom de sortie du contexte pour cette activité est HTTP_Request_2.

7. Entrez une boucle pour vérifier le statut du message Genie jusqu’à TERMINER (FINISH). Ajoutez une activité Faire pendant et définissez la Condition sur $context.outputs.HTTP_Request_3?.content?.status !== "COMPLETED", où HTTP_Request_3 fait référence à l'activité Obtenir la requête HTTP du message. Cela signifie que la boucle se poursuit tant que le statut du message n’est pas TERMINÉ (COMPLETE).

8. Dans la boucle Faire pendant :

   1. Ajoutez une activité HTTP pour obtenir le dernier message et configurez-la comme suit :
      • Nom d’affichage—« Obtenir une requête HTTP du message »
      • Méthode—GET
      • URL de la demande—https://{your-databricks-instance}/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}, ou créez-la avec l'éditeur d'expressions

        [ $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('')
        

   Où HTTP_Request_2 fait référence à l'activité Démarrer la conversation HTTP Request.

   • En-têtes—

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

   • Corps de la requête—

     {"content": $workflow.input.question}
     ```The context output name for this activity is `HTTP_Request_3`.
     

   2. Ajoutez une activité Si immédiatement après l’activité Obtenir la requête HTTP du message, et définissez la Condition sur $context.outputs.HTTP_Request_3?.content?.status === "COMPLETED", où HTTP_Request_3 fait référence à l’activité Obtenir la requête HTTP du message.
   3. Dans la branche Puis (true), ajoutez une activité Affecter et configurez-la comme suit :
      • En variable—conversation_id
      • Définissez la valeur—$context.outputs.HTTP_Request_3.content.conversation_id, où HTTP_Request_3 fait référence à l’activité Obtenir la requête HTTP du message.
   4. Ajouter une autre activité de type Attribuer :
      • En variable—message_id
      • Définissez la valeur—$context.outputs.HTTP_Request_3.content.message_id, où HTTP_Request_3 fait référence à l’activité Obtenir la requête HTTP du message.
   5. Ajouter une autre activité de type Attribuer :
      • En variable—attachment_id
      • Définissez la valeur—$context.outputs.HTTP_Request_3.content.attachments[0].attachment_id, où HTTP_Request_3 fait référence à l’activité Obtenir la requête HTTP du message.
   6. Sur la branche Sinon , ajoutez une activité Attendre et définissez la durée sur une seconde. Cela indique au workflow d'attendre pendant une courte période avant de réessayer.

9. Quittez la boucle et ajoutez une activité HTTP pour exécuter la requête SQL et configurez-la comme suit :

   • Nom d’affichage—« Exécuter la requête HTTP SQL »
   • Méthode—GET
   • URL de la demande—https://{your-databricks-instance}/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}/query-result, ou créez-la avec l'éditeur d'expressions

     $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"
     

   • En-têtes—

     {"Authorization": "Bearer " + $context.variables.token}
     ```The context output name for this activity is `HTTP_Request_3`.
     

10. Définissez les sorties du workflow. Ouvrez le Gestionnaire de données et ajoutez les paramètres d'entrée suivants :

    • Nom—nombre_lignes
    • Type—Nombre
    • Marquez-le comme requis.et
    • Nom—table_données
    • Type—Tableau
    • Marquez-le comme obligatoire.

11. Ajoutez une activité Réponse et configurez-la comme suit :

    • Réponse—

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

12. Exécutez l'intégration. Une fois déployé, le workflow peut être invoqué avec n’importe quelle requête en langage naturel. Par exemple, la question pourrait être la suivante : « Y a-t-il des restrictions pour la livraison de l’UGS SKU ENB-SP-200 à Cube ?

Points à retenir :

1. Configuration simple : le workflow d'API fournit un moyen rapide de connecter Genie sans code personnalisé.
2. Schéma cohérent : les réponses Genie sont basées sur des données JSON, ce qui est facile à analyser dans UiPath.
3. Intégration évolutive : les réponses peuvent être utilisées dans Apps, dans des workflows de longue durée ou dans des orchestrations.
4. Prototypage rapide : la configuration de l'automatisation du travail prend quelques minutes, ce qui permet une validation rapide des cas d'utilisation.