genie 命令组

Note

Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明，包括任何数据使用规定。

genie Databricks CLI 中的命令组包含 Genie 的命令。 请参阅 Genie 代理。

Databricks Genie Ask

提出数据问题，Genie会给出答案。

databricks genie ask QUESTION [flags]

Arguments

QUESTION

    要问精灵的数据问题。

选项

--include-sql

    显示代理执行的SQL查询。 适用于文本输出;JSON 输出总是包含这些内容。

--raw

    打印原始SSE事件，而不是渲染输出。

-s, --session string

    会话ID（任意字符串）用于跨通话继续对话。

--warehouse-id string

    SQL 仓库 ID。 如果省略了，则自动解决。

全局标志

Examples

以下示例提出了一个数据问题：

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

以下示例提出一个针对特定SQL仓库的问题：

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

以下示例继续使用你选择的会话ID跨通话进行对话：

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

在对话消息中添加评论。

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

Arguments

SPACE_ID

    与 Genie 空间关联的 ID。

CONVERSATION_ID

    与对话关联的 ID。

MESSAGE_ID

    与该消息关联的ID。

CONTENT

    评论文本内容。

选项

--json JSON

    包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。

全局标志

Examples

以下示例为一条消息创建注释：

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

databricks genie 创建消息

在对话中创建新邮件。 AI 响应使用对话中以前创建的所有消息进行响应。

databricks genie create-message SPACE_ID CONVERSATION_ID CONTENT [flags]

Arguments

SPACE_ID

    与启动会话的 Genie 代理关联的 ID。

CONVERSATION_ID

    与对话关联的 ID。

CONTENT

    用户消息内容。

选项

--json JSON

    包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。

--no-wait

    不要等待进入 COMPLETED 状态。

--timeout duration

    达到已完成状态的最大时间（默认为 20m0s）。

全局标志

Examples

以下示例在对话中创建一条消息：

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

以下示例使用 JSON 配置创建消息：

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

以下示例创建一条消息，而无需等待完成：

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

Databricks Genie create-space

创建 Genie 代理。

databricks genie create-space WAREHOUSE_ID SERIALIZED_SPACE [flags]

Arguments

WAREHOUSE_ID

    要与空间关联的 SQL 仓库的 ID。

SERIALIZED_SPACE

    序列化的空间配置。

选项

--json JSON

    包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。

全局标志

Examples

以下示例创建 Genie 代理：

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

Databricks Genie Delete-Conversation

从 Genie 代理中删除对话。

databricks genie delete-conversation SPACE_ID CONVERSATION_ID [flags]

Arguments

SPACE_ID

    Genie 代理的 ID。

CONVERSATION_ID

    要删除的对话的 ID。

选项

全局标志

Examples

以下示例删除对话：

databricks genie delete-conversation abc123 conv456

Databricks Genie delete-conversation-message

从 Genie 代理中的对话中删除消息。

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

Arguments

SPACE_ID

    Genie 代理的 ID。

CONVERSATION_ID

    会话的 ID。

MESSAGE_ID

    要删除的消息的 ID。

选项

全局标志

Examples

以下示例删除消息：

databricks genie delete-conversation-message abc123 conv456 msg789

Databricks Genie 下载-消息-附件-可视化

下载一份信息可视化附件的渲染图像。 只有当附件是可视化且消息状态为已完成时才可用。

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

Arguments

NAME

    渲染附件的资源名称，格式为 spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}。

选项

全局标志

Examples

以下示例下载了一个消息附件可视化：

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

databricks genie 执行消息附件查询

执行消息查询附件的 SQL。 当查询附件已过期且需要重新执行时，请使用此命令。

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

Arguments

SPACE_ID

    Genie 代理 ID。

CONVERSATION_ID

    对话 ID。

MESSAGE_ID

    消息 ID。

ATTACHMENT_ID

    附件 ID。

选项

全局标志

Examples

以下示例执行邮件附件查询：

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

Databricks Genie generate-download-full-query-result

为邮件附件的完整查询结果生成下载。

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

Arguments

SPACE_ID

    Genie 代理的 ID。

CONVERSATION_ID

    会话的 ID。

MESSAGE_ID

    消息的 ID。

ATTACHMENT_ID

    附件的 ID。

选项

全局标志

Examples

以下示例生成完整查询结果的下载：

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

Databricks Genie Genie-create-eval-run

为 Genie 代理创建评估运行。

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

Arguments

SPACE_ID

    Genie 代理的 ID。

选项

--json JSON

    包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。

全局标志

Examples

以下示例创建评估运行：

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

Databricks Genie Genie-get-eval-result-details

获取评估结果的详细信息。

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

Arguments

SPACE_ID

    Genie 代理的 ID。

EVAL_RUN_ID

    评估运行的 ID。

RESULT_ID

    计算结果的 ID。

选项

全局标志

Examples

以下示例获取评估结果详细信息：

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

Databricks Genie genie-get-eval-run

获取 Genie 代理的评估运行。

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

Arguments

SPACE_ID

    Genie 代理的 ID。

EVAL_RUN_ID

    评估运行的 ID。

选项

全局标志

Examples

以下示例获取计算运行：

databricks genie genie-get-eval-run abc123 run456

Databricks Genie Genie-List-Eval-results

列出评估运行的评估结果。

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

Arguments

SPACE_ID

    Genie 代理的 ID。

EVAL_RUN_ID

    评估运行的 ID。

选项

--page-size int

    每个页面要返回的最大评估结果数。

--page-token string

    用于检索下一页结果的不透明令牌。

全局标志

Examples

以下示例列出了评估结果：

databricks genie genie-list-eval-results abc123 run456

Databricks Genie Genie-List-eval-Runs

列出 Genie 代理的评估运行。

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

Arguments

SPACE_ID

    Genie 代理的 ID。

选项

--page-size int

    每个页面要返回的最大评估运行数。

--page-token string

    用于获取下一页结果的令牌。

全局标志

Examples

以下示例列出了评估运行：

databricks genie genie-list-eval-runs abc123

Databricks Genie get-download-full-query-result

获取以前生成的完整查询结果的下载。

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

Arguments

SPACE_ID

    Genie 代理的 ID。

CONVERSATION_ID

    会话的 ID。

MESSAGE_ID

    消息的 ID。

ATTACHMENT_ID

    附件的 ID。

DOWNLOAD_ID

    下载的 ID。

DOWNLOAD_ID_SIGNATURE

    下载 ID 的签名。

选项

全局标志

Examples

以下示例获取完整的查询结果下载：

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

databricks 精灵 获取消息

从对话中获取消息。

databricks genie get-message SPACE_ID CONVERSATION_ID MESSAGE_ID [flags]

Arguments

SPACE_ID

    与目标会话所在的 Genie 代理关联的 ID。

CONVERSATION_ID

    与目标对话关联的ID。

MESSAGE_ID

    与指定对话中的目标消息关联的 ID。

选项

全局标志

Examples

以下示例从对话中检索消息：

databricks genie get-message abc123 conv456 msg789

databricks Genie 获取消息附件查询结果

如果消息具有查询附件，则获取 SQL 查询的结果。 仅当邮件具有查询附件且消息状态为EXECUTING_QUERY或COMPLETED时，此功能才可用。

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

Arguments

SPACE_ID

    Genie 代理 ID。

CONVERSATION_ID

    对话 ID。

MESSAGE_ID

    消息 ID。

ATTACHMENT_ID

    附件 ID。

选项

全局标志

Examples

以下示例获取邮件附件的查询结果：

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

Databricks Genie 列表-会话-消息

列出对话中的邮件。

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

Arguments

SPACE_ID

    Genie 代理的 ID。

CONVERSATION_ID

    会话的 ID。

选项

--page-size int

    每页要返回的最大消息数。

--page-token string

    用于获取下一页结果的令牌。

全局标志

Examples

以下示例列出对话中的消息：

databricks genie list-conversation-messages abc123 conv456

Databricks Genie 列表-对话

列出 Genie 代理中的对话。

databricks genie list-conversations SPACE_ID [flags]

Arguments

SPACE_ID

    Genie 代理的 ID。

选项

--page-size int

    每个页面要返回的最大会话数。

--page-token string

    用于获取下一页结果的令牌。

全局标志

Examples

以下示例列出空格中的对话：

databricks genie list-conversations abc123

Databricks Genie 列表-对话-评论

列出对话中所有消息中的所有评论。

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

Arguments

SPACE_ID

    与 Genie 空间关联的 ID。

CONVERSATION_ID

    与对话关联的 ID。

选项

--page-size int

    每页最多可回复的评论数。

--page-token string

    用于获取下一页结果的分页令牌。

全局标志

Examples

以下示例列出了对话中的所有评论：

databricks genie list-conversation-comments abc123 conv456

Databricks Genie 列表-消息-评论

列出对特定对话信息的评论。

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

Arguments

SPACE_ID

    与 Genie 空间关联的 ID。

CONVERSATION_ID

    与对话关联的 ID。

MESSAGE_ID

    与该消息关联的ID。

选项

--page-size int

    每页最多可回复的评论数。

--page-token string

    用于获取下一页结果的分页令牌。

全局标志

Examples

以下示例列出了对消息的评论：

databricks genie list-message-comments abc123 conv456 msg789

Databricks Genie 列表空间

列出工作区中的 Genie 代理。

databricks genie list-spaces [flags]

选项

--page-size int

    每页要返回的最大空格数。

--page-token string

    用于获取下一页结果的分页令牌。

全局标志

Examples

以下示例列出所有 Genie 代理：

databricks genie list-spaces

Databricks Genie Send-Message-Feedback

在 Genie 对话中发送有关消息的反馈。

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

Arguments

SPACE_ID

    Genie 代理的 ID。

CONVERSATION_ID

    会话的 ID。

MESSAGE_ID

    消息的 ID。

RATING

    消息的反馈分级。

选项

--json JSON

    包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。

全局标志

Examples

以下示例对消息发送正反馈：

databricks genie send-message-feedback abc123 conv456 msg789 POSITIVE

databricks genie 获取空间

获取 Genie 代理的详细信息。

databricks genie get-space SPACE_ID [flags]

Arguments

SPACE_ID

    与 Genie 代理关联的 ID。

选项

全局标志

Examples

以下示例获取 Genie 代理的详细信息：

databricks genie get-space abc123

databricks genie 开始对话

启动新对话。

databricks genie start-conversation SPACE_ID CONTENT [flags]

Arguments

SPACE_ID

    与要在其中启动对话的 Genie 代理关联的 ID。

CONTENT

    启动对话的消息的文本。

选项

--json JSON

    包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。

--no-wait

    不要等待进入 COMPLETED 状态。

--timeout duration

    达到已完成状态的最大时间（默认为 20m0s）。

全局标志

Examples

以下示例启动一个新对话：

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

以下示例使用 JSON 配置启动会话：

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

以下示例在不等待完成的情况下启动对话：

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

databricks genie 垃圾空间

将 Genie 代理移动到垃圾桶。

databricks genie trash-space SPACE_ID [flags]

Arguments

SPACE_ID

    要回收的 Genie 代理的 ID。

选项

全局标志

Examples

以下示例会回收 Genie 代理：

databricks genie trash-space abc123

Databricks Genie Update-Space

更新 Genie 代理。

databricks genie update-space SPACE_ID [flags]

Arguments

SPACE_ID

    要更新的 Genie 代理的 ID。

选项

--json JSON

    包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件。

全局标志

Examples

以下示例更新 Genie 代理：

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

全局标志

--debug

  是否启用调试日志记录。

-h 或 --help

    显示 Databricks CLI、相关命令组或相关命令的帮助。

--log-file 字符串

    一个字符串，表示要将输出日志写入到的文件。 如果未指定此标志，则默认会将输出日志写入到 stderr。

--log-format 格式

    日志格式类型，text 或 json。 默认值是 text。

--log-level 字符串

    一个表示日志格式级别的字符串。 如果未指定，则禁用日志格式级别。

-o, --output 类型

    命令输出类型为text或json。 默认值是 text。

-p, --profile 字符串

     ~/.databrickscfg 文件中用于运行命令的配置文件的名称。 如果未指定此标志，则如果存在，将使用名为 DEFAULT 的配置文件。

--progress-format 格式

    显示进度日志的格式： default、 append、 inplace或 json

-t, --target 字符串

    如适用，要使用的捆绑包目标

  • Last updated on