knowledge-assistants コマンド グループ

Note

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

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

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

databricks knowledge-assistants create-knowledge-assistant

ナレッジ アシスタントを作成します。

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

論争

DISPLAY_NAME

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

DESCRIPTION

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

オプション

--instructions string

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

--json JSON

    要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。

--name string

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

グローバル フラグ

例示

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

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

databricks knowledge-assistants create-knowledge-source

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

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

論争

PARENT

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

DISPLAY_NAME

    知識ソースの人間が判読できる表示名。

DESCRIPTION

    ナレッジソースの説明。

SOURCE_TYPE

    ソースの種類。 サポートされている値: index、files、file_table。

オプション

--json JSON

    要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。

--name string

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

グローバル フラグ

例示

次の例では、ナレッジ ソースを作成します。

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

databricks knowledge-assistants delete-knowledge-assistant

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

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

論争

NAME

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

オプション

グローバル フラグ

例示

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

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

databricks knowledge-assistants delete-knowledge-source

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

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

論争

NAME

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

オプション

グローバル フラグ

例示

次の例では、ナレッジ ソースを削除します。

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

databricks knowledge-assistants get-knowledge-assistant

ナレッジ アシスタントを取得します。

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

論争

NAME

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

オプション

グローバル フラグ

例示

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

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

databricks knowledge-assistants get-knowledge-source

ナレッジ ソースを取得します。

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

論争

NAME

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

オプション

グローバル フラグ

例示

次の例では、ナレッジ ソースを取得します。

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

databricks knowledge-assistants list-knowledge-assistants

ナレッジ アシスタントを一覧表示します。

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

論争

なし

オプション

--page-size int

    返されるナレッジ アシスタントの最大数。

--page-token string

    前の list-knowledge-assistants 呼び出しから受信したページ トークン。

グローバル フラグ

例示

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

databricks knowledge-assistants list-knowledge-assistants

databricks knowledge-assistants list-knowledge-sources

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

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

論争

PARENT

    一覧表示する親リソース。 形式: knowledge-assistants/{knowledge_assistant_id}.

オプション

--page-size int

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

--page-token string

    前のリスト呼び出しのページ トークン。

グローバル フラグ

例示

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

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

databricks knowledge-assistants sync-knowledge-sources

ナレッジ アシスタントのインデックス以外のすべてのナレッジ ソースを同期します。 インデックス ソースには同期は必要ありません。

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

論争

NAME

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

オプション

グローバル フラグ

例示

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

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

databricks knowledge-assistants update-knowledge-assistant

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

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

論争

NAME

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

UPDATE_MASK

    更新するフィールドのコンマ区切りのリスト。 許可値: display_name、description、instructions。

DISPLAY_NAME

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

DESCRIPTION

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

オプション

--instructions string

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

--json JSON

    要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。

--name string

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

グローバル フラグ

例示

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

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

databricks knowledge-assistants update-knowledge-source

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

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_name、description。

DISPLAY_NAME

    知識ソースの人間が判読できる表示名。

DESCRIPTION

    ナレッジソースの説明。

SOURCE_TYPE

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

オプション

--json JSON

    要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。

--name string

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

グローバル フラグ

例示

次の例では、ナレッジ ソースを更新します。

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 文字列

    出力ログを書き込むファイルを表す文字列。 このフラグが指定されていない場合、既定では 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