ai-search コマンド グループ

注記

Databricks CLIの使用には、使用データ条項を含むDatabricksライセンスおよびDatabricksプライバシー通知が適用されます。

Databricks CLI内のai-searchコマンド グループには、AI Search Endpointとインデックスを管理するためのコマンドが含まれています。AI Search Endpointは、AI Searchインデックスをホストするコンピュートリソースです。「AI Search」を参照してください。

databricks ai-search create-endpoint

AI Search Endpointを作成します。

databricks ai-search create-endpoint PARENT ENDPOINT_TYPE [flags]

引数

PARENT

このEndpointが作成されるワークスペース。形式: workspaces/{workspace_id}

ENDPOINT_TYPE

Endpointのタイプ。サポートされている値: STANDARD、 STORAGE_OPTIMIZED

オプション

--budget-policy-id string

Endpointに対してユーザーが選択した予算ポリシーID。

--endpoint-id string

ユーザーが指定したEndpointの短い名前。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの @path。

--name string

AI Searchエンドポイント名。

--replica-count int

Endpointの希望するレプリカ数。

--target-qps int

Endpointの目標QPS（1秒あたりのクエリー数）。

--usage-policy-id string

Endpoint に適用される使用ポリシー ID。

グローバル フラグ

databricks ai-search create-index

AI Searchインデックスを作成します。

databricks ai-search create-index PARENT PRIMARY_KEY INDEX_TYPE [flags]

引数

PARENT

このインデックスが作成されるEndpoint。形式： workspaces/{workspace_id}/endpoints/{endpoint_id}

PRIMARY_KEY

インデックスのプライマリ・キー。作成時に設定され、その後は変更できません。

INDEX_TYPE

インデックスのタイプ。サポートされている値: DELTA_SYNC、 DIRECT_ACCESS

オプション

--index-id string

インデックス用にユーザーが指定したUnity Catalogテーブル名。

--index-subtype IndexSubtype

インデックスのサブタイプ。サポートされている値: FULL_TEXT、 HYBRID、 VECTOR

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの @path。

--name string

AI Searchインデックスの名前。

グローバル フラグ

databricks ai-search delete-endpoint

AI Searchエンドポイントを削除してください。

databricks ai-search delete-endpoint NAME [flags]

引数

NAME

削除するEndpointの完全なリソース名。形式: workspaces/{workspace_id}/endpoints/{endpoint_id}

オプション

グローバル フラグ

databricks ai-search delete-index

AI Searchインデックスを削除します。

databricks ai-search delete-index NAME [flags]

引数

NAME

削除するインデックスの完全なリソース名。形式: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}

オプション

グローバル フラグ

databricks ai-search get-endpoint

AI Search Endpointを取得します。

databricks ai-search get-endpoint NAME [flags]

引数

NAME

Endpointの完全なリソース名。形式： workspaces/{workspace_id}/endpoints/{endpoint_id}

オプション

グローバル フラグ

databricks ai-search get-index

AI Searchインデックスを取得します。

databricks ai-search get-index NAME [flags]

引数

NAME

インデックスの完全なリソース名。形式: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}

オプション

グローバル フラグ

databricks AI-search list-Endpoint

AI Search Endpointを一覧表示します。

databricks ai-search list-endpoints PARENT [flags]

引数

PARENT

このEndpointのコレクションを所有するワークスペース。形式： workspaces/{workspace_id}

オプション

--limit int

返される結果の最大数。

--page-size int

返される結果数のベストエフォート型の上界。

グローバル フラグ

databricks ai-search list-indexes

AI検索インデックスを一覧表示します。

databricks ai-search list-indexes PARENT [flags]

引数

PARENT

このインデックスコレクションを所有するEndpoint。形式： workspaces/{workspace_id}/endpoints/{endpoint_id}

オプション

--limit int

返される結果の最大数。

--page-size int

返される結果数のベストエフォート型の上界。

グローバル フラグ

databricks AI-search クエリー-index

AI Searchインデックスをクエリーします。

databricks ai-search query-index NAME [flags]

引数

NAME

クエリー対象のインデックスの完全なリソース名。形式： workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}

オプション

--filters-json string

クエリーフィルターを記述するJSON文字列。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの @path。

--max-results int

返される結果の最大数。

--query-text string

クエリー テキスト。

--query-type string

クエリータイプ：ANN、 HYBRID、または FULL_TEXT。

--score-threshold float

近似最近傍検索のスコア threshold。

グローバル フラグ

databricks ai-search remove-data

AI Searchインデックスからデータを削除します。

databricks ai-search remove-data NAME [flags]

引数

NAME

インデックスの完全なリソース名。Direct Accessインデックスである必要があります。形式： workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの @path。

グローバル フラグ

databricks ai-search scan-index

AI Searchインデックスをスキャンします。

databricks ai-search scan-index NAME [flags]

引数

NAME

スキャンするインデックスの完全なリソース名。形式: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの @path。

--page-size int

このページで返す最大行数。

--page-token string

前回のレスポンスからのページトークン。設定されていない場合、スキャンは最初から起動されます。

グローバル フラグ

databricks ai-search sync-index

AI Searchインデックスを同期します。

databricks ai-search sync-index NAME [flags]

引数

NAME

同期するインデックスの完全なリソース名。Delta Syncインデックスである必要があります。形式： workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}

オプション

グローバル フラグ

databricks ai-search update-endpoint

AI Search Endpointを更新します。

databricks ai-search update-endpoint NAME UPDATE_MASK ENDPOINT_TYPE [flags]

引数

NAME

Name of the AI Search Endpoint.出力時の完全なリソースパス（形式：workspaces/{workspace_id}/endpoints/{endpoint_id}）。

UPDATE_MASK

更新するフィールドのリスト。

ENDPOINT_TYPE

Endpointのタイプ。サポートされている値: STANDARD、 STORAGE_OPTIMIZED

オプション

--budget-policy-id string

Endpointに対してユーザーが選択した予算ポリシーID。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの @path。

--name string

AI Searchエンドポイント名。

--replica-count int

Endpointの希望するレプリカ数。

--target-qps int

Endpointの目標QPS（1秒あたりのクエリー数）。

--usage-policy-id string

Endpoint に適用される使用ポリシー ID。

グローバル フラグ

databricks ai-search upsert-data

AI Search インデックスにデータをアップサートします。

databricks ai-search upsert-data NAME INPUTS_JSON [flags]

引数

NAME

インデックスの完全なリソース名。Direct Accessインデックスである必要があります。形式： workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}

INPUTS_JSON

アップサートする行を記述した JSON ドキュメント。

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの @path。

グローバル フラグ

グローバル フラグ

--debug

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

-h または --help

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

--log-file string

出力Logsの書き込み先ファイルを表す文字列。このフラグが指定されていない場合、defaultでは出力Logsが stderr に書き込まれます。

--log-format format

ログ形式タイプ（text または json）。default値は text です。

--log-level string

Log形式レベルを表す文字列。指定しない場合、ログ形式レベルは無効になります。

-o, --output タイプ

コマンド出力タイプ、text または json。default値は text です。

-p, --profile string

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

--progress-format format

進行状況Logsを表示する形式: default、append、inplace、または json

-t, --target string

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