從 Databricks Assistant 取得程式代碼撰寫說明

本文說明如何使用 Databricks Assistant 協助您撰寫和偵錯筆記本，並提供如何充分利用小幫手的秘訣。

Databricks 小幫手能協助什麼？

Databricks Assistant 是一個內容感知 AI 助理，您可以使用對話式介面與互動，讓您在 Databricks 內更具生產力。 您可以使用英文描述您的工作，並讓小幫手產生 Python 程式代碼或 SQL 查詢、說明複雜的程式碼，以及自動修正錯誤。 助手會使用 Unity Catalog 目錄元數據來了解整個公司的數據表、欄位、描述和常用的數據資產，以提供個人化的回應。

Databricks Assistant 可協助您完成下列工作：

• 產生程序代碼。
• 偵錯程式代碼，包括識別及建議錯誤修正。
• 轉換、優化和重構程序代碼。
• 說明程序代碼。
• 協助您在 Azure Databricks 檔中尋找相關信息。

如需支援 Databricks Assistant 之模型的相關資訊，請參閱 合作夥伴支援的 AI 功能。 如需 Databricks Assistant 的一般資訊，請參閱 什麼是 Databricks Assistant？。

筆記本助理指令快捷方式

在筆記簿中，Databricks 助手可在助手窗格或程式碼單元內使用。

若要直接在程式代碼數據格中使用 Databricks Assistant，請在 MacOS 上按 Cmd+I，或在 Windows 上按 Ctrl+I。 文字框會出現在儲存格中。 您可以使用英文輸入問題或批注，然後按 Enter（而非 Shift+Enter，就像您要執行單元格一樣），讓小幫手產生回應。

針對提示使用斜線命令

斜線命令是建立常見提示的快捷方式。

提示訊息	小幫手的用途
/	顯示一般命令
/doc	在差異檢視中批注程序代碼
/explain	提供儲存格中程式代碼的說明
/fix	提議修復差異視圖中的任何程式錯誤
/findTables	根據 Unity 目錄元數據搜尋相關數據表。 若要尋找功能或功能數據表，請在查詢中提及「功能」或「功能數據表」。 請參閱 使用 Databricks Assistant尋找功能和功能數據表。
/findQueries	根據 Unity 目錄元數據搜尋相關的查詢。
/optimize	改善 SQL 和 Python 程式代碼。
/prettify	格式化程序代碼以取得可讀性。
/rename	根據上下文，建議筆記本的單元格和其他元素的更新名稱。
/settings	直接從助理調整筆記本設定。

當您使用 /fix 或 /doc時，在差異視窗中，選取 [接受]，以接受建議的變更，或 拒絕 保留原始程式碼。 如果您接受建議的程式代碼，程式代碼不會自動執行。 您可以在執行程式碼之前先檢閱程式代碼。 如果產生的程式代碼不是您想要的程式碼，請再試一次，將更多詳細數據或資訊新增至批注。 請參閱 改善 Google 助理回應的提示。

取得代碼段的詳細說明。 使用 /explain 提示，並包含「簡潔」或「逐行說明程式代碼」等字詞，以請求您想要的細節程度。 您也可以要求 Databricks Assistant 將批註新增至程序代碼。

在進行程式碼自動完成時，使用 [小幫手] 窗格的效能可能比在筆記本的儲存格中更好。

如果您 接受 或 拒絕 產生的程式代碼，助理會自動關閉。

在提示中使用 參考 @數據表

若要快速參考小幫手提示中的數據表，請使用 @ （at） 符號。

在小幫手提示中使用 @ 符號

獲得程式碼協助

Databricks Assistant 可協助處理 SQL 和 Python 的程序代碼：

• 編輯模式可跨筆記本運作，以對多個單元格進行修正和更新。
• Databricks 筆記本、SQL 編輯器和檔案編輯器中的 AI 基於的自動完成功能。
• 使用自然語言提示進行數據篩選。
• 使用 診斷錯誤進行程式碼除錯。

針對跨多個筆記本儲存格的建議編輯模式

編輯模式會從單一提示將 AI 產生的建議套用至筆記本中的多個儲存格。

若要使用編輯模式：

1. 開啟筆記本后，按兩下畫面右上方的助理 。

2. 在 [助理] 窗格中，點擊提示方塊底部的 [ 編輯 ]。

   

3. 在編輯模式中，輸入提示，就像您在聊天模式中一樣。

   小幫手會分析筆記本，並在需要變更的單元格中直接顯示建議。

4. 產生建議之後，您可以直接在筆記本中或透過助理面板檢閱這些建議。 單擊 [助理] 面板中的任何單元格，跳至筆記本的該部分。

5. 接受或拒絕個別編輯，無論是內嵌在筆記本中還是從助理面板。 若要一次套用所有建議，請按兩下 [全部接受] 或 [全部拒絕]。

取得內嵌程式代碼建議：Python 和 SQL 範例

當您輸入時，建議會自動出現。 按下 Tab 接受建議。 若要手動觸發建議，請按 Option+Shift+Space（在macOS上）或 Control+Shift+Space（在 Windows 上）。

AI 型自動補全也可以從註解生成程式碼。

使用自然語言提示篩選數據

使用 Databricks Assistant 以自然語言提示篩選數據輸出。

若要使用自然語言篩選輸出，請按下輸出資料表中的 [篩選] 圖示，然後輸入提示。 例如，如下列動畫範例所示，您可以提示「只顯示超過 70 的男性」。

快速修正

當程式碼傳回錯誤時，快速修復會自動建議可以透過單行修改修正的基本錯誤。

按一下 [接受並執行 ] 以進行建議的修正並繼續執行程式碼，如下列螢幕擷取畫面所示：

偵錯程式代碼：Python 和 SQL 範例

若要使用 Databricks Assistant 來修正程式代碼，請執行下列任一動作：

• 在 [小幫手] 窗格中提出問題。
• 按一下 診斷錯誤 按鈕，該按鈕會在發生錯誤時出現在單元格結果中。
• 按偵錯以互動方式逐行查看程式碼、設定斷點、檢查變數，以及分析程式的執行。

下列索引標籤顯示 Python 和 SQL 程式代碼中的 診斷錯誤 範例：

Python

SQL

當您按兩下 [診斷錯誤] 時，小幫手會自動執行 '/fix' 提示。

當您按鍵 [診斷錯誤時，小幫手會自動執行 /fix。

偵錯環境錯誤

小幫手可協助診斷環境故障並提出修正建議，包括程式庫安裝錯誤。

當環境側邊面板發生安裝失敗時，助理圖示 會出現在右下角。 按一下 以開啟 [助理] 窗格，其中會執行 /repairEnvironment [助理] 以協助診斷和修正問題。

您也可以開啟pip記錄，然後按一下 診斷錯誤 ，以在「小幫手」窗格中執行 /repairEnvironment 命令。

優化 Python、PySpark 和 SQL 程式代碼

使用斜線提示 /optimize、評估和優化 Python、PySpark 和 SQL 程式代碼。

1. 在筆記本數據格或 SQL 編輯器中，按兩下 助理圖示。
2. 在提示方塊中，輸入 /optimize，然後按兩下 [ 產生] 按鈕。
3. 若要使用小幫手的優化建議，請按兩下 [ 接受]。

以下是 /optimize 協助代碼的方式：

• 執行前警告： 黃色底線標示出在執行前優化查詢的機會，例如當您未篩選分區欄位時。 將滑鼠停留在加底線的文字上，以檢視優化建議。
• 執行後分析： 執行程式代碼之後，按兩下 [ 優化] 按鈕。
• 數據表層級建議： 例如，當使用者建立數據表時，他們會收到建議 的 CREATE TABLE CLUSTER BY AUTO提示。

其他資訊

下列文章包含使用 Databricks Assistant 的其他資訊：

• 什麼是 Databricks Assistant？
• 使用 Databricks Assistant
• Databricks AI 輔助功能信任與安全
• 評估 Databricks 小幫手的影響