Databricks Assistant からコーディングに関するヘルプを取得する
この記事では、Databricks Assistant を使用してノートブックをコーディングおよびデバッグする方法について説明し、アシスタントを最大限に活用する方法に関するヒントを提供します。
Databricks Assistant は何に役立ちますか?
Databricks Assistant はコンテキスト対応の AI アシスタントであり、会話インターフェイスを使用して対話できるため、Databricks 内での生産性が向上します。 タスクを英語で記述し、アシスタントが Python コードまたは SQL クエリを生成したり、複雑なコードを説明したり、エラーを自動的に修正したりできます。 アシスタントは、Unity Catalog メタデータを使用して、会社全体のテーブル、列、説明、人気のあるデータ資産を理解し、パーソナライズされた応答を提供します。
Databricks Assistant は、次のタスクに役立ちます。
- コードを生成します。
- エラーの修正プログラムの識別と提案など、コードをデバッグします。
- コードの変換と最適化。
- コードについて説明します。
- Azure Databricks のドキュメントで関連情報を見つけるのに役立ちます。
Databricks Assistant の有効化と使用の詳細については、「Databricks Assistant を有効にして試すを参照してください。 Databricks Assistant の一般的な情報については、DatabricksIQ を使用した機能 を参照してください。
ノートブックの Assistant コマンド ショートカット
ノートブックでは、Databricks Assistant は [アシスタント] ウィンドウまたはコード セル内のインラインで使用できます。
コード セルで Databricks Assistant を直接使用するには、MacOS で Cmd+I キーを押すか、Windows で Ctrl+I を押します。 セルにテキスト ボックスが表示されます。 英語で質問やコメントを入力し、(セルを実行する場合のように Shift+Enterではなく) Enter を押して、アシスタントに応答を生成させることができます。
プロンプトにスラッシュ コマンドを使用する
スラッシュ コマンドは、一般的なプロンプトを作成するためのショートカットです。
| テキストの入力を求める | アシスタントの機能 |
|---|---|
/ |
一般的なコマンドを表示します |
/doc |
差分ビューでコードにコメントを付け加える |
/explain |
セル内のコードの説明を提供します |
/fix |
差分ビューでコード エラーの修正を提案します |
/findTables |
Unity カタログメタデータに基づいて関連するテーブルを検索します。 フィーチャまたはフィーチャ テーブルを検索するには、クエリで "features" または "feature tables" をメンションします。 機能およびフィーチャ テーブルの検索には、Databricks Assistantを参照してください。 |
/findQueries |
Unity カタログメタデータに基づいて関連するクエリを検索します。 |
/optimize |
非効率的な SQL クエリを改善します。 |
/prettify |
読みやすくするためにコードを書式設定します。 |
/rename |
コンテキストに応じて、ノートブックのセルやその他の要素に更新された名前を提案します。 |
/settings |
アシスタントからノートブックの設定を直接調整します。 |
/fix または /docを使用する場合は、差分ウィンドウで 「受け入れる」 を選択して提案された変更を受け入れるか、「拒否」 を選択して元のコードを保持します。 提案されたコードを受け入れると、コードは自動的に実行されません。 コードを実行する前に確認できます。 生成されたコードが必要でない場合は、コメントに詳細または情報を追加して、もう一度やり直してください。 Databricks Assistant の使用に関するヒントを参照してください。
コード スニペットの詳細な説明を取得します。 /explain プロンプトを使用し、"簡潔にする" や "コードを 1 行ずつ説明する" などの用語を含め、必要な詳細レベルを要求します。 Databricks Assistant にコードにコメントを追加するように依頼することもできます。
コード オートコンプリートの場合、ノートブック のセルよりもアシスタント ウィンドウを使用した方がパフォーマンスが良い場合があります。
生成されたコードを [承認] または[拒否] すると、Assistant は自動的に閉じられます。
@ を使用してプロンプトでテーブルを参照する
アシスタント プロンプトでテーブルをすばやく参照するには、@ (at) 記号を使用します。
@ 記号する
コードに関するヘルプを表示する
Databricks Assistant は、SQL と Python の両方のコードに役立ちます。
- Databricks ノートブック、SQL エディター、ファイル エディターの AI ベースのオートコンプリート。
- 自然言語プロンプトを使用したデータ フィルター処理。
- 診断エラー (パブリック プレビュー) を使用したコード デバッグ。
注
FedRAMP 準拠の Azure Government リージョンまたはワークスペースでは、インライン コードの候補を使用できません。
インライン コードの候補を取得する: Python と SQL の例
入力すると、候補が自動的に表示されます。 Tab を押して提案を受け入れます。 提案を手動でトリガーするには、Option+Shift+Space (macOS の場合) または Control+Shift+Space (Windows の場合) を押します。
AI ベースのオートコンプリートでは、コメントからコードを生成することもできます。
自然言語プロンプトを使用してデータをフィルター処理する
Databricks Assistant を使用して、自然言語プロンプトでデータ出力をフィルター処理します。
自然言語で出力をフィルター処理するには、出力テーブルの [フィルター] アイコンをクリックし、プロンプトを入力します。 たとえば、次のアニメーションの例のように、"Show me only males over 70" (70 歳以上の男性のみを表示する) というメッセージを表示できます。
デバッグ コード: Python と SQL の例
重要
この機能はパブリック プレビュー段階にあります。
Databricks Assistant を使用してコードを修正するには、次のいずれかの操作を行います。
- アシスタント ウィンドウで質問します。
- エラーが発生したときにセルの結果に表示される エラーの診断 ボタンをクリックします。
- デバッグ をクリックして、コードを 1 行ずつ対話形式でステップ実行し、ブレークポイントを設定し、変数を検査し、プログラムの実行を分析します。
次のタブは、Python と SQL コードの例を示しています。
パイソン
Python の 
SQL
sql の 
[診断エラー] をクリックすると、アシスタントが自動的に /fix を実行します。
迅速な修正
コードからエラーが返されると、クイック修正では、1 行の変更で修正できる基本的なエラーの修正が自動的に推奨されます。
推薦される修正を加えてコードを動かし続けるには、「同意」をクリックしてを受け入れ、を実行してください。
Databricks Assistant の使い方に関するヒント
このセクションには、Databricks Assistant を使用するときの一般的なヒントとベスト プラクティスがいくつか含まれています。
Databricks Assistant はコンテキストを使用して、より良い回答を提供します
Databricks Assistant は、テーブルと列のスキーマとメタデータにアクセスできます。 これにより、自然言語を使用して、より正確なクエリを生成できます。 たとえば、テーブルに Stateという名前の列がある場合は、Databricks Assistant に、ミシガン州に住むユーザーの一覧を生成するように依頼できます。
Databricks Assistant では、次のコンテキストが使用されます。
- 現在のノートブック セルまたは Databricks SQL エディター タブのコードまたはクエリ。
- テーブル名と列名、その説明。
- 以前のプロンプトの質問。
- お気に入りおよびアクティブなテーブル。
- 診断エラー機能については、エラー出力のスタック トレース。
DataFrame から列を選択する場合は、開始クエリを指定することで、より正確な結果を得ることができます。 たとえば、SELECT * FROM <table_name>などのステートメントを指定します。 これにより、Databricks Assistant は列名を取得でき、推測する必要はありません。
Databricks Assistant は会話履歴を使用して、より正確な回答を提供するため、プロンプト全体を書き換えることなく、Databricks Assistant に以前の応答の出力を変更するよう依頼できます。 アシスタントのチャット履歴を使用して、アシスタント ウィンドウで DataFrame を繰り返しクリーンアップ、探索、フィルター処理、スライスします。
具体的にする
Databricks Assistant が提供する構造と詳細は、同じプロンプトであっても、随時異なります。 必要な形式、詳細レベルなどの情報を返すのに役立つできるだけ多くのガイダンスをアシスタントに提供してみてください。 次に例を示します。
- "このコードを 2 つの文で説明する" または "このコードを 1 行ずつ説明する"
- "MatPlotLib を使用して視覚化を作成する" または "Seaborn を使用して視覚化を作成する"
行レベルのデータ値の例を示します
Databricks Assistant は行レベルのデータを使用しないため、最も正確な回答を得るために、プロンプトに詳細を指定する必要がある場合があります。 カタログ エクスプローラーでテーブルまたは列のコメントを使用して、サンプル データの行を追加します。 たとえば、高さの列が feet-inches形式であるとします。 アシスタントがデータを解釈できるようにするには、「高さの列は文字列形式で、ハイフンで区切られています。」などのコメントを追加します。 例: '6-2'。 テーブルと列のコメントの詳細については、「データおよび AI 資産にコメントを追加する」を参照してください。
列データ型変換を使用して操作を実行する必要がある場合は、詳細を指定する必要があります。 たとえば、「pandas DataFrame を PySpark DataFrame に変換し、列チャーンのデータ型をブール値から整数に変更するために必要なコードを含め、このコードを pandas から PySpark に変換する」などです。
Shift + Enter キーを使用してチャット テキスト ボックスに新しい行を追加する
Shift + Enter を使用して、[アシスタント チャット] テキスト ボックスに新しい行を追加します。 これにより、Databricks Assistant へのメッセージの書式設定と整理が簡単になります。
Databricks Assistant のチャット ウィンドウでコードを編集して実行する
アシスタント ウィンドウでコードを実行して検証するか、スクラッチパッドとして使用します。 コードを実行するには、[アシスタント] ウィンドウ ![コード ボックスの左上隅にある [コードの実行] アイコン](../_static/images/notebooks/run-code.png)
をクリックします。
次のタブは、Python と SQL コードの例を示しています。
パイソン
SQL
アシスタント ウィンドウでコードを実行すると、出力が表示され、変数がノートブックで使用できるようになります。
また、ノートブックにコードを移動する前に、Databricks Assistant がアシスタント チャット ボックスで直接生成するコードを編集することもできます。
追加情報
次の記事には、Databricks Assistant の使用に関する追加情報が含まれています。
- Databricks アシスタントとは?
- Databricks Assistant を有効にして試す
- DatabricksIQ の信頼と安全
- Databricks Assistant の影響を測定する