Aller au contenu principal

groupe de commandesgenie

remarque

L'utilisation de Databricks CLI est soumise à la licence Databricks et à la politique de confidentialité Databricks, y compris toutes les dispositions relatives aux données d'utilisation.

Le groupe de commandes genie au sein de la CLI Databricks contient des commandes pour Genie. Consultez Genie Agents.

Demander à Databricks Genie

Posez une question sur les données et obtenez une réponse de Genie.

databricks genie ask QUESTION [flags]

Arguments

QUESTION

La question sur les données à poser à Genie.

Options

--include-sql

Afficher les queries SQL exécutées par l'agent. S'applique à la sortie texte ; la sortie JSON les inclut toujours.

--raw

Imprimer les événements SSE bruts au lieu de la sortie rendue.

-s, --session string

ID de session (n'importe quelle chaîne) pour poursuivre une conversation entre plusieurs appels.

--warehouse-id string

ID SQL Warehouse. Auto-résolu en cas d'omission.

Indicateurs globaux

Exemples

L'exemple suivant pose une question sur les données :

Bash
databricks genie ask "What were total sales last month?"

L'exemple suivant pose une question avec un SQL Warehouse spécifique :

Bash
databricks genie ask "Revenue by region" --warehouse-id 1234567890abcdef

L'exemple suivant poursuit une conversation entre plusieurs appels en utilisant un ID de session de votre choix :

Bash
databricks genie ask -s sales "What were total sales by quarter?"
databricks genie ask -s sales "Break that down by region"

databricks genie create-message-comment

Créer un commentaire sur un message de conversation.

databricks genie create-message-comment SPACE_ID CONVERSATION_ID MESSAGE_ID CONTENT [flags]

Arguments

SPACE_ID

L'ID associé au Genie space.

CONVERSATION_ID

L’ID associé à la conversation.

MESSAGE_ID

L'identifiant associé au message.

CONTENT

Contenu du texte de commentaire.

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Exemples

L'exemple suivant crée un commentaire sur un message :

Bash
databricks genie create-message-comment abc123 conv456 msg789 "Great analysis!"

databricks genie create-message

Créer un nouveau message dans une conversation. La réponse de l'IA utilise tous les messages créés précédemment dans la conversation pour répondre.

databricks genie create-message SPACE_ID CONVERSATION_ID CONTENT [flags]

Arguments

SPACE_ID

L'ID associé au Genie Agent où la conversation est start.

CONVERSATION_ID

L’ID associé à la conversation.

CONTENT

Contenu du message utilisateur.

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

--no-wait

N'attendez pas d'atteindre l'état TERMINÉ.

--timeout duration

Durée maximale pour atteindre l'état COMPLETED (default 20m0s).

Indicateurs globaux

Exemples

L'exemple suivant crée un message dans une conversation :

Bash
databricks genie create-message abc123 conv456 "What were our sales last quarter?"

L'exemple suivant crée un message avec la configuration JSON :

Bash
databricks genie create-message abc123 conv456 "Show me top customers" --json '{"additional_context": "Include revenue data"}'

L'exemple suivant crée un message sans attendre la fin :

Bash
databricks genie create-message abc123 conv456 "Analyze customer trends" --no-wait

databricks genie create-space

Créer un Genie Agent.

databricks genie create-space WAREHOUSE_ID SERIALIZED_SPACE [flags]

Arguments

WAREHOUSE_ID

L’ID du SQL warehouse à associer à l’espace.

SERIALIZED_SPACE

La configuration de l'espace sérialisé.

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Exemples

L'exemple suivant crée un Genie Agent :

Bash
databricks genie create-space my-warehouse-id '{}' --json @space-config.json

databricks genie delete-conversation

Supprimer une conversation d'un Genie Agent.

databricks genie delete-conversation SPACE_ID CONVERSATION_ID [flags]

Arguments

SPACE_ID

L'ID du Genie Agent.

CONVERSATION_ID

L’ID de la conversation à supprimer.

Options

Indicateurs globaux

Exemples

L'exemple suivant supprime une conversation :

Bash
databricks genie delete-conversation abc123 conv456

databricks genie delete-conversation-message

Supprimer un message d'une conversation dans un Genie Agent.

databricks genie delete-conversation-message SPACE_ID CONVERSATION_ID MESSAGE_ID [flags]

Arguments

SPACE_ID

L'ID du Genie Agent.

CONVERSATION_ID

L'ID de la conversation.

MESSAGE_ID

L'ID du message à supprimer.

Options

Indicateurs globaux

Exemples

L'exemple suivant supprime un message :

Bash
databricks genie delete-conversation-message abc123 conv456 msg789

databricks genie download-message-attachment-visualization

download une image rendue d'une pièce jointe de visualisation de message. Ceci n'est disponible que si la pièce jointe est une visualisation et que le statut du message est COMPLETED.

databricks genie download-message-attachment-visualization NAME [flags]

Arguments

NAME

Le nom de la ressource de la pièce jointe à afficher, au format spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}.

Options

Indicateurs globaux

Exemples

L'exemple suivant download une visualisation de pièce jointe de message :

Bash
databricks genie download-message-attachment-visualization "spaces/abc123/conversations/conv456/messages/msg789/attachments/attach001"

databricks genie execute-message-attachment-query

Exécutez la requête SQL pour une pièce jointe de requête de message. Utilisez cette commande lorsque l'attachement de query a expiré et doit être réexécutée.

databricks genie execute-message-attachment-query SPACE_ID CONVERSATION_ID MESSAGE_ID ATTACHMENT_ID [flags]

Arguments

SPACE_ID

ID de Genie Agent.

CONVERSATION_ID

ID de conversation.

MESSAGE_ID

ID du message.

ATTACHMENT_ID

ID de pièce jointe.

Options

Indicateurs globaux

Exemples

L'exemple suivant exécute une query de pièce jointe de message :

Bash
databricks genie execute-message-attachment-query abc123 conv456 msg789 attach001

databricks genie generate-download-full-query-result

Générez un download pour le résultat complet de la requête d'une pièce jointe de message.

databricks genie generate-download-full-query-result SPACE_ID CONVERSATION_ID MESSAGE_ID ATTACHMENT_ID [flags]

Arguments

SPACE_ID

L'ID du Genie Agent.

CONVERSATION_ID

L'ID de la conversation.

MESSAGE_ID

L’ID du message.

ATTACHMENT_ID

L'ID de la pièce jointe.

Options

Indicateurs globaux

Exemples

L'exemple suivant génère un download pour un résultat de query complet :

Bash
databricks genie generate-download-full-query-result abc123 conv456 msg789 attach001

databricks genie genie-create-eval-run

Créez un cycle d'évaluation pour un Genie Agent.

databricks genie genie-create-eval-run SPACE_ID [flags]

Arguments

SPACE_ID

L'ID du Genie Agent.

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Exemples

L'exemple suivant crée un cycle d'évaluation :

Bash
databricks genie genie-create-eval-run abc123 --json @eval-config.json

databricks genie genie-get-eval-result-details

Obtenir les détails d'un résultat d'évaluation.

databricks genie genie-get-eval-result-details SPACE_ID EVAL_RUN_ID RESULT_ID [flags]

Arguments

SPACE_ID

L'ID du Genie Agent.

EVAL_RUN_ID

ID de l’exécution de l’évaluation.

RESULT_ID

L’ID du résultat de l’évaluation.

Options

Indicateurs globaux

Exemples

L'exemple suivant obtient les détails des résultats d'évaluation :

Bash
databricks genie genie-get-eval-result-details abc123 run456 result789

databricks genie genie-get-eval-run

Obtenez une exécution d'évaluation pour un Genie Agent.

databricks genie genie-get-eval-run SPACE_ID EVAL_RUN_ID [flags]

Arguments

SPACE_ID

L'ID du Genie Agent.

EVAL_RUN_ID

ID de l’exécution de l’évaluation.

Options

Indicateurs globaux

Exemples

L'exemple suivant obtient un cycle d'évaluation :

Bash
databricks genie genie-get-eval-run abc123 run456

databricks genie genie-list-eval-results

Afficher la liste des résultats d'évaluation pour une exécution d'évaluation.

databricks genie genie-list-eval-results SPACE_ID EVAL_RUN_ID [flags]

Arguments

SPACE_ID

L'ID du Genie Agent.

EVAL_RUN_ID

ID de l’exécution de l’évaluation.

Options

--page-size int

Nombre maximum de résultats d'évaluation à renvoyer par page.

--page-token string

Jeton opaque pour récupérer la page suivante des résultats.

Indicateurs globaux

Exemples

L’exemple suivant répertorie les résultats de l’évaluation :

Bash
databricks genie genie-list-eval-results abc123 run456

databricks Genie genie-list-eval-runs

Lister les exécutions d'évaluation pour un Genie Agent.

databricks genie genie-list-eval-runs SPACE_ID [flags]

Arguments

SPACE_ID

L'ID du Genie Agent.

Options

--page-size int

Nombre maximal d'exécutions d'évaluation à afficher par page.

--page-token string

Jeton pour obtenir la page de résultats suivante.

Indicateurs globaux

Exemples

L'exemple suivant liste les exécutions d'évaluation :

Bash
databricks genie genie-list-eval-runs abc123

databricks genie get-download-full-query-result

Obtenir le download du résultat complet d'une query générée précédemment.

databricks genie get-download-full-query-result SPACE_ID CONVERSATION_ID MESSAGE_ID ATTACHMENT_ID DOWNLOAD_ID DOWNLOAD_ID_SIGNATURE [flags]

Arguments

SPACE_ID

L'ID du Genie Agent.

CONVERSATION_ID

L'ID de la conversation.

MESSAGE_ID

L’ID du message.

ATTACHMENT_ID

L'ID de la pièce jointe.

DOWNLOAD_ID

L'ID du download.

DOWNLOAD_ID_SIGNATURE

La signature pour l'ID de download.

Options

Indicateurs globaux

Exemples

L'exemple suivant permet de download un résultat de query complet :

Bash
databricks genie get-download-full-query-result abc123 conv456 msg789 attach001 dl001 sig001

Databricks Genie get-message

Obtenir un message d'une conversation.

databricks genie get-message SPACE_ID CONVERSATION_ID MESSAGE_ID [flags]

Arguments

SPACE_ID

L'ID associé au Genie Agent où se situe la conversation cible.

CONVERSATION_ID

L'ID associé à la conversation cible.

MESSAGE_ID

L'ID associé au message cible de la conversation identifiée.

Options

Indicateurs globaux

Exemples

L'exemple suivant récupère un message d'une conversation :

Bash
databricks genie get-message abc123 conv456 msg789

databricks genie get-message-attachment-query-result

Obtenez le résultat de la query SQL si le message a une pièce jointe de query. Ceci est disponible uniquement si un message possède une pièce jointe de query et que le statut du message est EXECUTING_QUERY ou COMPLETED.

databricks genie get-message-attachment-query-result SPACE_ID CONVERSATION_ID MESSAGE_ID ATTACHMENT_ID [flags]

Arguments

SPACE_ID

ID de Genie Agent.

CONVERSATION_ID

ID de conversation.

MESSAGE_ID

ID du message.

ATTACHMENT_ID

ID de pièce jointe.

Options

Indicateurs globaux

Exemples

L'exemple suivant obtient le résultat de la query pour une pièce jointe de message :

Bash
databricks genie get-message-attachment-query-result abc123 conv456 msg789 attach001

databricks genie list-conversation-messages

Lister les messages d'une conversation.

databricks genie list-conversation-messages SPACE_ID CONVERSATION_ID [flags]

Arguments

SPACE_ID

L'ID du Genie Agent.

CONVERSATION_ID

L'ID de la conversation.

Options

--page-size int

Nombre maximal de messages à renvoyer par page.

--page-token string

Jeton pour obtenir la page de résultats suivante.

Indicateurs globaux

Exemples

L'exemple suivant répertorie les messages d'une conversation :

Bash
databricks genie list-conversation-messages abc123 conv456

databricks genie list-conversations

Répertoriez les conversations dans un Genie Agent.

databricks genie list-conversations SPACE_ID [flags]

Arguments

SPACE_ID

L'ID du Genie Agent.

Options

--page-size int

Nombre maximal de conversations à renvoyer par page.

--page-token string

Jeton pour obtenir la page de résultats suivante.

Indicateurs globaux

Exemples

L'exemple suivant liste les conversations dans un espace :

Bash
databricks genie list-conversations abc123

databricks genie list-conversation-comments

Lister tous les commentaires de tous les messages d’une conversation.

databricks genie list-conversation-comments SPACE_ID CONVERSATION_ID [flags]

Arguments

SPACE_ID

L'ID associé au Genie space.

CONVERSATION_ID

L’ID associé à la conversation.

Options

--page-size int

Nombre maximal de commentaires à renvoyer par page.

--page-token string

Jeton de pagination pour obtenir la page suivante des résultats.

Indicateurs globaux

Exemples

L'exemple suivant liste tous les commentaires d'une conversation :

Bash
databricks genie list-conversation-comments abc123 conv456

databricks genie list-message-comments

Lister les commentaires sur un message de conversation spécifique.

databricks genie list-message-comments SPACE_ID CONVERSATION_ID MESSAGE_ID [flags]

Arguments

SPACE_ID

L'ID associé au Genie space.

CONVERSATION_ID

L’ID associé à la conversation.

MESSAGE_ID

L'identifiant associé au message.

Options

--page-size int

Nombre maximal de commentaires à renvoyer par page.

--page-token string

Jeton de pagination pour obtenir la page suivante des résultats.

Indicateurs globaux

Exemples

L’exemple suivant liste les commentaires sur un message :

Bash
databricks genie list-message-comments abc123 conv456 msg789

databricks genie list-spaces

Répertorier les agents Genie dans le Workspace.

databricks genie list-spaces [flags]

Options

--page-size int

Nombre maximal d’espaces à renvoyer par page.

--page-token string

Jeton de pagination pour obtenir la page suivante des résultats.

Indicateurs globaux

Exemples

L'exemple suivant répertorie tous les agents Genie :

Bash
databricks genie list-spaces

databricks genie send-message-feedback

Envoyer des commentaires sur un message dans une conversation Genie.

databricks genie send-message-feedback SPACE_ID CONVERSATION_ID MESSAGE_ID RATING [flags]

Arguments

SPACE_ID

L'ID du Genie Agent.

CONVERSATION_ID

L'ID de la conversation.

MESSAGE_ID

L’ID du message.

RATING

L'évaluation des commentaires du message.

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Exemples

L'exemple suivant envoie des commentaires positifs sur un message :

Bash
databricks genie send-message-feedback abc123 conv456 msg789 POSITIVE

databricks genie get-space

Obtenir les détails d'un Genie Agent.

databricks genie get-space SPACE_ID [flags]

Arguments

SPACE_ID

L'ID associé au Genie Agent.

Options

Indicateurs globaux

Exemples

L'exemple suivant fournit des détails sur un Genie Agent :

Bash
databricks genie get-space abc123

databricks genie start conversation

Start une nouvelle conversation.

databricks genie start-conversation SPACE_ID CONTENT [flags]

Arguments

SPACE_ID

L'ID associé à l'agent Genie Agent où vous souhaitez start une conversation.

CONTENT

Le texte du message qui start la conversation.

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

--no-wait

N'attendez pas d'atteindre l'état TERMINÉ.

--timeout duration

Durée maximale pour atteindre l'état COMPLETED (default 20m0s).

Indicateurs globaux

Exemples

L'exemple suivant start une nouvelle conversation :

Bash
databricks genie start-conversation abc123 "What are our top performing products this month?"

L'exemple suivant start une conversation avec la configuration JSON :

Bash
databricks genie start-conversation abc123 "Show me sales data" --json '{"context": "Q4 2024"}'

L'exemple suivant start une conversation sans attendre qu'elle soit terminée :

Bash
databricks genie start-conversation abc123 "Analyze customer behavior" --no-wait

databricks genie trash-space

Déplacer un Genie Agent vers la corbeille.

databricks genie trash-space SPACE_ID [flags]

Arguments

SPACE_ID

L'ID du Genie Agent à supprimer.

Options

Indicateurs globaux

Exemples

L’exemple suivant met un Genie Agent à la corbeille :

Bash
databricks genie trash-space abc123

databricks genie update-space

Mettre à jour un Genie Agent.

databricks genie update-space SPACE_ID [flags]

Arguments

SPACE_ID

L'ID du Genie Agent à mettre à jour.

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Exemples

L'exemple suivant met à jour un Genie Agent :

Bash
databricks genie update-space abc123 --json '{"title": "Updated Space Title"}'

Drapeaux globaux

--debug

Activer ou non la journalisation de débogage.

-h OU --help

Afficher l'aide de Databricks CLI ou du groupe de commandes associé ou de la commande associée.

--log-file chaîne

Une chaîne représentant le fichier dans lequel écrire les logs de sortie. Si cet indicateur n'est pas spécifié, la default est d'écrire les logs de sortie dans stderr.

--log-format Format

Le type de format de log, text ou json. La valeur par default est text.

--log-level chaîne

Une chaîne représentant le niveau de format du log. S'il n'est pas spécifié, le niveau de format du log est désactivé.

-o, --output Type

Le type de sortie de commande, text ou json. La valeur par default est text.

-p, --profile chaîne

Nom du profil dans le fichier ~/.databrickscfg à utiliser pour exécuter la commande. Si cet indicateur n'est pas spécifié, alors s'il existe, le profil nommé DEFAULT est utilisé.

--progress-format Format

Le format pour afficher les logs de progression : default, append, inplace ou json

-t, --target chaîne

Le cas échéant, la cible de bundle à utiliser