从 Databricks 助手获取编码帮助

本文介绍如何使用 Databricks 助手来帮助你编码和调试笔记本,并提供有关如何充分利用助手的提示。

Databricks 助手能够帮助处理哪些事情?

Databricks 助手是一种上下文感知 AI 助手,可以使用对话界面与该助手交互,使你在 Databricks 中更高效。 可以使用英语描述任务,让助手生成 Python 代码或 SQL 查询、解释复杂代码并自动修复错误。 助手使用 Unity 目录元数据中的信息来分析整个公司的表、列、说明和常用数据资产,以提供个性化的响应。

Databricks 助手可帮助你完成以下任务:

  • 生成代码。
  • 调试代码,包括识别和建议错误修复。
  • 转换、优化和重构代码。
  • 解释代码。
  • 帮助你在 Azure Databricks 文档中找到相关信息。

有关支持 Databricks 助手的模型的信息,请参阅 合作伙伴支持的 AI 功能。 有关 Databricks 助手的一般信息,请参阅什么是 Databricks 助手?

笔记本的助手命令快捷方式

在笔记本中,Databricks 助手可在“助手”窗格中使用,也可在代码单元格中内联使用。

若要直接在代码单元格中使用 Databricks Assistant,请按 MacOS 上的 Cmd+I 或在 Windows 上 Ctrl+I。 单元格中将显示一个文本框。 你可以用英语键入问题或批注,然后按 Enter(而不是 Shift+Enter,就像运行单元格一样),让助手生成响应。

内联助手可帮助你查找和添加扩充数据。

对提示使用斜杠命令

斜线命令是创建常见提示的快捷方式。

提示文本 助手的作用
/ 显示常见命令
/doc 注释差异视图中的代码
/explain 提供单元格中代码的说明
/fix 建议修复差异视图中的任何代码错误
/findTables 基于 Unity Catalog 元数据搜索相关表。 若要查找特征或功能表,请提及查询中的“特征”或“功能表”。 请参阅使用 Databricks 助手查找功能和功能表
/findQueries 基于 Unity Catalog 元数据搜索相关查询。
/optimize 改进 SQL 和 Python 代码。
/prettify 设置代码的格式以获取可读性。
/rename 根据上下文,为笔记本单元格和其他元素建议更新名称。
/settings 通过助手直接调整笔记本设置。

使用 /fix/doc时,在差异窗口中,选择 接受 接受建议的更改或 拒绝 保留原始代码。 如果接受建议的代码,则代码不会自动运行。 可以在运行代码之前查看代码。 如果生成的代码不是您想要的,请尝试在评论中添加更多详细信息。 请参阅 改进助手响应的提示

获取代码片段的详细说明。 使用 /explain 提示,并包含“简洁”或“逐行解释代码”等术语,以请求所需详细信息级别。 还可以要求 Databricks 助手向代码添加注释。

对于代码自动完成,使用“助手”窗格可能比在笔记本单元格中性能更好。

如果接受拒绝生成的代码,助手会自动关闭。

在提示中使用 @ 引用表

若要快速引用助手提示中的表,请使用 @ (at) 符号。

使用 @ 符号在助手提示中引用表 在助手提示符中使用 @ 符号引用表

获取有关代码的帮助

Databricks Assistant 可帮助处理 SQL 和 Python 的代码:

  • 编辑模式,可跨笔记本对多个单元格进行修复和更新。
  • Databricks 笔记本、SQL 编辑器和文件编辑器中基于 AI 的自动完成功能。
  • 使用自然语言提示筛选数据。
  • 使用诊断错误进行代码调试。

跨多个笔记本单元格的建议编辑模式

编辑模式通过单个提示在笔记本中的多个单元格中应用 AI 生成的建议。

若要使用编辑模式,请执行以下作:

  1. 打开笔记本后,单击屏幕右上角的助手 图标 Sparkle 图标

  2. 在“助手”窗格中,单击提示框底部的 “编辑 ”。

    Databricks 助手面板中的编辑模式。

  3. 在编辑模式下,像在聊天模式下一样输入提示。

    助手在需要更改的单元格中内联分析笔记本并显示建议。

  4. 生成建议后,可以直接在笔记本中或通过助手面板查看它们。 单击“助理”面板中的任意单元格以跳转到笔记本的该部分。

  5. 在笔记本中或助手面板中单独接受或拒绝编辑。 若要一次性应用所有建议,请单击“ 全部接受 ”或“ 全部拒绝”。

获取内联代码建议:Python 和 SQL 示例

键入时,会自动显示建议。 按下 Tab 接受建议。 若要手动触发建议,请按 Option+Shift+Space(在 macOS 上)或 Control+Shift+Space(在 Windows 上)。

SQL 的代码补全动画 GIF。

Python 的代码补全动画 GIF。

人工智能驱动的自动完成功能还可以从注释中生成代码。

注释中代码补全的动画 GIF。

使用自然语言提示筛选数据

使用 Databricks 助手通过自然语言提示筛选数据输出。

若要使用自然语言筛选输出,请单击输出表中的“筛选器”图标并输入提示。 例如,如下面的动画示例所示,可以提示“仅显示超过 70 的男性”。

动画 GIF 显示 Databricks 助手正在筛选一张泰坦尼克号幸存者的表格,以寻找 70 岁以上的男性。

快速修复

当代码返回错误时,快速修复会自动建议修复可在单行更改中修复的基本错误。

单击“ 接受并运行 ”以进行建议的修复并继续运行代码,如以下屏幕截图所示:

Databricks 助手内联 bug 修复 UI 的屏幕截图。

调试代码:Python 和 SQL 示例

若要使用 Databricks Assistant 修复代码,请执行下列操作之一:

  • 在“助理”窗格中提问。
  • 发生错误时,单击单元格结果中显示的“诊断错误”按钮。
  • 单击 “调试 ”以交互方式逐行执行代码、设置断点、检查变量和分析程序的执行。

以下选项卡显示了 Python 和 SQL 代码中的 诊断错误 示例:

Python

在 Python 中 Python 中的助手调试示例。

SQL

单击“ 诊断错误”时,助手会自动运行“/修复”提示。

SQL 中的 助手调试示例。

单击 诊断错误时,助手会自动运行 /fix

调试环境错误

助手可以帮助诊断并建议修复环境故障,包括库安装错误。

当环境端面板中出现安装失败时,助手 图标 Sparkle 图标 将显示在右下角。 单击 “Sparkle”图标。 打开“助手”窗格,其中助手运行 /repairEnvironment 以帮助诊断和解决问题。

还可以打开 pip 日志,然后单击“ 诊断错误 ”以在“助手”窗格中运行 /repairEnvironment 命令。

优化 Python、PySpark 和 SQL 代码

使用斜杠提示 /optimize、评估和优化 Python、PySpark 和 SQL 代码。

  1. 在笔记本单元格或 SQL 编辑器中,单击 产品内助手图标 - 颜色 助手图标。
  2. 在提示框中,键入 /optimize并单击“ 生成 ”按钮。
  3. 若要使用助手中的优化建议,请单击“ 接受”。

在笔记本上使用优化提示。

以下是 /optimize 对代码的帮助:

  • 预运行警告: 黄色下划线突出显示在执行前优化查询的机会,例如,在未筛选分区列时。 将鼠标悬停在带下划线的文本上以查看优化建议。
  • 运行后分析: 运行代码后,单击“ 优化 ”按钮。
  • 表级建议: 例如,当用户创建表时,他们会收到建议 CREATE TABLE CLUSTER BY AUTO的提示。

其他信息

以下文章包含有关使用 Databricks 助手的其他信息: