メインコンテンツまでスキップ

knowledge-assistantsコマンドグループ

注記

この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI はパブリックプレビュー版です。

Databricks CLI使用には、使用状況データ プロビジョニングを含むDatabricksライセンスおよびDatabricksプライバシー通知が適用されます。

Databricks CLI内のknowledge-assistantsコマンド グループを使用すると、ナレッジ アシスタントおよび関連リソースを管理できます。

Databricks ナレッジアシスタント ナレッジアシスタントの作成

知識アシスタントを作成する。

databricks knowledge-assistants create-knowledge-assistant DISPLAY_NAME DESCRIPTION [flags]

議論

DISPLAY_NAME

ナレッジアシスタントの表示名。ワークスペースレベルで一意です。

DESCRIPTION

このアシスタントができることの説明(ユーザー向け)。

オプション

--instructions string

エージェントが回答を生成する方法に関する追加のグローバル指示。

--json JSON

インラインJSON構文、またはリクエストボディを含むJSONファイルへの@path。

--name string

ナレッジアシスタントのリソース名。

世界の国旗

次の例では、ナレッジアシスタントを作成します。

Bash
databricks knowledge-assistants create-knowledge-assistant "Sales Assistant" "Answers questions about sales data"

Databricks ナレッジアシスタント ナレッジソースの作成

ナレッジアシスタントの下にナレッジソースを作成します。

databricks knowledge-assistants create-knowledge-source PARENT DISPLAY_NAME DESCRIPTION SOURCE_TYPE [flags]

議論

PARENT

このソースが作成される親リソース。形式: knowledge-assistants/{knowledge_assistant_id}

DISPLAY_NAME

人間が判読できるナレッジ ソースの表示名。

DESCRIPTION

ナレッジ ソースの説明。

SOURCE_TYPE

ソースの種類。サポートされている値: indexfilesfile_table

オプション

--json JSON

インラインJSON構文、またはリクエストボディを含むJSONファイルへの@path。

--name string

完全なリソース名: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}

世界の国旗

次の例は、知識ソースを作成するものです。

Bash
databricks knowledge-assistants create-knowledge-source knowledge-assistants/my-assistant-id "Sales Docs" "Documentation about sales processes" files

Databricks ナレッジアシスタント ナレッジアシスタント削除

ナレッジアシスタントを削除します。

databricks knowledge-assistants delete-knowledge-assistant NAME [flags]

議論

NAME

削除するナレッジアシスタントのリソース名。形式: knowledge-assistants/{knowledge_assistant_id}

オプション

世界の国旗

次の例は、ナレッジアシスタントを削除する例です。

Bash
databricks knowledge-assistants delete-knowledge-assistant knowledge-assistants/my-assistant-id

Databricks ナレッジアシスタント ナレッジソースの削除

ナレッジ ソースを削除します。

databricks knowledge-assistants delete-knowledge-source NAME [flags]

議論

NAME

削除するナレッジ ソースのリソース名。 形式: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}

オプション

世界の国旗

次の例は、知識ソースを削除するものです。

Bash
databricks knowledge-assistants delete-knowledge-source knowledge-assistants/my-assistant-id/knowledge-sources/my-source-id

Databricks ナレッジアシスタント 知識取得アシスタント

知識アシスタントを入手しましょう。

databricks knowledge-assistants get-knowledge-assistant NAME [flags]

議論

NAME

知識アシスタントのリソース名。形式: knowledge-assistants/{knowledge_assistant_id}

オプション

世界の国旗

次の例では、ナレッジアシスタントを取得します。

Bash
databricks knowledge-assistants get-knowledge-assistant knowledge-assistants/my-assistant-id

Databricks ナレッジアシスタント 知識ソースの取得

ナレッジソースを入手してください。

databricks knowledge-assistants get-knowledge-source NAME [flags]

議論

NAME

ナレッジ ソースのリソース名。 形式: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}

オプション

世界の国旗

次の例では、知識ソースを取得します。

Bash
databricks knowledge-assistants get-knowledge-source knowledge-assistants/my-assistant-id/knowledge-sources/my-source-id

データブリックス ナレッジアシスタント一覧 ナレッジアシスタント

知識アシスタントの一覧を表示します。

databricks knowledge-assistants list-knowledge-assistants [flags]

議論

なし

オプション

--page-size int

返却する知識アシスタントの最大数。

--page-token string

前回のlist-knowledge-assistants呼び出しで受け取ったページトークン。

世界の国旗

以下の例は、すべてのナレッジアシスタントを一覧表示したものです。

Bash
databricks knowledge-assistants list-knowledge-assistants

Databricks 知識アシスタント 知識ソース一覧

ナレッジ アシスタントの下にナレッジ ソースをリストします。

databricks knowledge-assistants list-knowledge-sources PARENT [flags]

議論

PARENT

リストの親リソース。形式: knowledge-assistants/{knowledge_assistant_id}

オプション

--page-size int

返されるナレッジ ソースの最大数。

--page-token string

前回のリスト呼び出しで取得したページトークン。

世界の国旗

次の例では、アシスタントのナレッジ ソースをリストします。

Bash
databricks knowledge-assistants list-knowledge-sources knowledge-assistants/my-assistant-id

Databricks 知識アシスタント 知識ソースの同期

ナレッジアシスタント用の、インデックス化されていないすべてのナレッジソースを同期します。インデックスソースは同期を必要としません。

databricks knowledge-assistants sync-knowledge-sources NAME [flags]

議論

NAME

ナレッジアシスタントのリソース名。形式: knowledge-assistants/{knowledge_assistant_id}

オプション

世界の国旗

次の例は、アシスタントのすべての知識ソースを同期します。

Bash
databricks knowledge-assistants sync-knowledge-sources knowledge-assistants/my-assistant-id

Databricks ナレッジアシスタント ナレッジアシスタントの更新

ナレッジアシスタントを更新する。

databricks knowledge-assistants update-knowledge-assistant NAME UPDATE_MASK DISPLAY_NAME DESCRIPTION [flags]

議論

NAME

ナレッジアシスタントのリソース名。形式: knowledge-assistants/{knowledge_assistant_id}

UPDATE_MASK

更新するフィールドをカンマ区切りで指定します。許容値: display_namedescriptioninstructions

DISPLAY_NAME

ナレッジアシスタントの表示名。

DESCRIPTION

このアシスタントができることの説明。

オプション

--instructions string

エージェントが回答を生成する方法に関する追加のグローバル指示。

--json JSON

インラインJSON構文、またはリクエストボディを含むJSONファイルへの@path。

--name string

ナレッジアシスタントのリソース名。

世界の国旗

次の例は、ナレッジアシスタントの表示名を更新するものです。

Bash
databricks knowledge-assistants update-knowledge-assistant knowledge-assistants/my-assistant-id display_name "Updated Sales Assistant" "Answers questions about sales data"

Databricks ナレッジアシスタント ナレッジソースの更新

ナレッジ ソースを更新します。

databricks knowledge-assistants update-knowledge-source NAME UPDATE_MASK DISPLAY_NAME DESCRIPTION SOURCE_TYPE [flags]

議論

NAME

更新するナレッジ ソースのリソース名。 形式: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}

UPDATE_MASK

更新するフィールドをカンマ区切りで指定します。許容値: display_namedescription

DISPLAY_NAME

人間が判読できるナレッジ ソースの表示名。

DESCRIPTION

ナレッジ ソースの説明。

SOURCE_TYPE

ソースの種類。このフィールドは更新時に無視されます。

オプション

--json JSON

インラインJSON構文、またはリクエストボディを含むJSONファイルへの@path。

--name string

完全なリソース名: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}

世界の国旗

次の例は、知識ソースを更新するものです。

Bash
databricks knowledge-assistants update-knowledge-source knowledge-assistants/my-assistant-id/knowledge-sources/my-source-id display_name "Updated Sales Docs" "Updated documentation about sales" files

世界の国旗

--debug

デバッグログを有効にするかどうか。

-h または --help

Databricks CLI、関連するコマンドグループ、または関連するコマンドのヘルプを表示します。

--log-file string

出力ログを書き込むファイルを表す文字列。このフラグが指定されていない場合、デフォルトでは出力ログは標準エラー出力に書き込まれます。

--log-format format

ログフォーマットタイプ、 textまたはjson 。デフォルト値はtextです。

--log-level string

ログフォーマットレベルを表す文字列。指定されていない場合、ログフォーマットレベルは無効になります。

-o, --output タイプ

コマンド出力タイプ、 textまたはjson 。デフォルト値はtextです。

-p, --profile string

コマンドを実行するために使用する、 ~/.databrickscfgファイル内のプロファイル名。このフラグが指定されていない場合、存在する場合はDEFAULTという名前のプロファイルが使用されます。

--progress-format format

進捗ログを表示する形式: defaultappendinplace 、または json

-t, --target string

該当する場合、使用するバンドルターゲット