Note
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
Databricks CLI内のai-searchコマンドグループには、AI検索エンドポイントやインデックスを管理するコマンドが含まれています。 AI検索エンドポイントは、AI検索インデックスをホストするための計算資源を表します。 AI 検索を参照してください。
Databricks AI-Search create-endpoint
AI検索エンドポイントを作成しましょう。
databricks ai-search create-endpoint PARENT ENDPOINT_TYPE [flags]
Arguments
PARENT
このエンドポイントが作成されるワークスペース。 形式: workspaces/{workspace_id}
ENDPOINT_TYPE
エンドポイントの種類。 サポートされる値: STANDARD、STORAGE_OPTIMIZED
オプション
--budget-policy-id string
エンドポイントのユーザー選択予算ポリシーID。
--endpoint-id string
ユーザーが提供したエンドポイントの略名。
--json JSON
要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。
--name string
AI Search エンドポイントの名前。
--replica-count int
エンドポイントの希望されるレプリカ数。
--target-qps int
エンドポイントの目標QPS(1秒あたりのクエリ数)。
--usage-policy-id string
エンドポイントに適用された使用ポリシーIDです。
DataBricks AI-検索作成インデックス
AI検索インデックスを作成する。
databricks ai-search create-index PARENT PRIMARY_KEY INDEX_TYPE [flags]
Arguments
PARENT
このインデックスが作成されるエンドポイント。 形式: 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検索インデックスの名前。
Databricks AI-Search Delete-endpoint
AI Search エンドポイントを削除します。
databricks ai-search delete-endpoint NAME [flags]
Arguments
NAME
削除するエンドポイントの完全なリソース名。 形式: workspaces/{workspace_id}/endpoints/{endpoint_id}
オプション
DataBricks AI-Search Delete-index
AI検索インデックスを削除してください。
databricks ai-search delete-index NAME [flags]
Arguments
NAME
削除するインデックスの完全なリソース名。 形式: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}
オプション
Databricks AI-Search Get-Endpoint
AI検索エンドポイントを導入しましょう。
databricks ai-search get-endpoint NAME [flags]
Arguments
NAME
エンドポイントのリソース名を正式に。 形式: workspaces/{workspace_id}/endpoints/{endpoint_id}
オプション
Databricks AI-検索ゲット-インデックス
AI検索インデックスを取得しましょう。
databricks ai-search get-index NAME [flags]
Arguments
NAME
索引の完全なリソース名。 形式: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}
オプション
Databricks AI-検索リスト-エンドポイント
AI検索エンドポイントをリストアップ。
databricks ai-search list-endpoints PARENT [flags]
Arguments
PARENT
このエンドポイントの集合を所有するワークスペースです。 形式: workspaces/{workspace_id}
オプション
--limit int
返される結果の最大数。
--page-size int
結果の返送数のベストエフォート上限。
DataBricks AI-検索リスト-インデックス
AI検索インデックスをリストリスト。
databricks ai-search list-indexes PARENT [flags]
Arguments
PARENT
このインデックスの集合を所有するエンドポイントです。 形式: workspaces/{workspace_id}/endpoints/{endpoint_id}
オプション
--limit int
返される結果の最大数。
--page-size int
結果の返送数のベストエフォート上限。
DataBricks AI-Search Query-Index
AI検索インデックスを検索する。
databricks ai-search query-index NAME [flags]
Arguments
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
近似近傍探索のスコア閾値。
DataBricks AI-検索 remove-data
AI検索インデックスからデータを削除してください。
databricks ai-search remove-data NAME [flags]
Arguments
NAME
索引の完全なリソース名。 Direct Accessのインデックスに違いない。 形式: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}
オプション
--json JSON
要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。
Databricks AI-検索 スキャン-インデックス
AI検索インデックスをスキャンします。
databricks ai-search scan-index NAME [flags]
Arguments
NAME
スキャンするインデックスの完全なリソース名。 形式: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}
オプション
--json JSON
要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。
--page-size int
このページで返す最大行数。
--page-token string
前の応答のページ トークン。 未設定の場合は、スキャンを最初から始めます。
DataBricks AI-検索同期-インデックス
AI検索インデックスを同期させる。
databricks ai-search sync-index NAME [flags]
Arguments
NAME
同期のためにインデックスの完全なリソース名を。 Delta Syncのインデックスに違いありません。 形式: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}
オプション
DataBricks AI-Search Update-Endpoint
AI検索エンドポイントを更新してください。
databricks ai-search update-endpoint NAME UPDATE_MASK ENDPOINT_TYPE [flags]
Arguments
NAME
AI Search エンドポイントの名前。 出力時の全リソースパス(フォーマット: workspaces/{workspace_id}/endpoints/{endpoint_id})。
UPDATE_MASK
更新するフィールドの一覧。
ENDPOINT_TYPE
エンドポイントの種類。 サポートされる値: STANDARD、STORAGE_OPTIMIZED
オプション
--budget-policy-id string
エンドポイントのユーザー選択予算ポリシーID。
--json JSON
要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。
--name string
AI Search エンドポイントの名前。
--replica-count int
エンドポイントの希望されるレプリカ数。
--target-qps int
エンドポイントの目標QPS(1秒あたりのクエリ数)。
--usage-policy-id string
エンドポイントに適用された使用ポリシーIDです。
Databricks AI-Search upsert-data
データをAI検索インデックスにアップセルします。
databricks ai-search upsert-data NAME INPUTS_JSON [flags]
Arguments
NAME
索引の完全なリソース名。 Direct Accessのインデックスに違いない。 形式: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}
INPUTS_JSON
upsertする行を記述したJSONドキュメント。
オプション
--json JSON
要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。
グローバル フラグ
--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 文字列
該当する場合は、使用するバンドル ターゲット