Note
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
vector-search-indexes 内の コマンド グループには、ベクター検索インデックスを管理するコマンドが含まれています。 ベクター検索インデックスは、リアルタイムおよび近似最近隣 (ANN) 検索クエリをサポートする埋め込みベクターの効率的な表現です。 「Mosaic AI ベクトル検索」を参照してください。
databricks ベクトル検索インデックス create-index
新しいインデックスを作成します。
databricks vector-search-indexes create-index NAME ENDPOINT_NAME PRIMARY_KEY INDEX_TYPE [flags]
Arguments
NAME
インデックス名。
ENDPOINT_NAME
インデックスの提供に使用するエンドポイントの名前
PRIMARY_KEY
インデックスの主キー
INDEX_TYPE
Vector Search インデックスには、差分同期 (ソース Delta Table と自動的に同期されるインデックス) と直接アクセス (ベクトルとメタデータの直接読み取りと書き込みをサポートするインデックス) の 2 種類があります。 サポートされる値: DELTA_SYNC、DIRECT_ACCESS
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
Examples
次の例では、新しい差分同期インデックスを作成します。
databricks vector-search-indexes create-index my-index my-endpoint id DELTA_SYNC
次の例では、新しい Direct Access インデックスを作成します。
databricks vector-search-indexes create-index my-index my-endpoint id DIRECT_ACCESS
データブリックス ベクトル検索インデックス データベクトルインデックスを削除
インデックスからデータを削除します。
databricks vector-search-indexes delete-data-vector-index INDEX_NAME [flags]
Arguments
INDEX_NAME
データを削除するベクター インデックスの名前。 直接ベクター アクセス インデックスである必要があります。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
Examples
次の例では、Direct Vector Access インデックスからデータを削除します。
databricks vector-search-indexes delete-data-vector-index my-index --json '{"primary_keys": ["key1", "key2"]}'
databricks vector-search-indexes の delete-index
インデックスを削除します。
databricks vector-search-indexes delete-index INDEX_NAME [flags]
Arguments
INDEX_NAME
インデックス名。
オプション
Examples
次の例では、ベクター検索インデックスを削除します。
databricks vector-search-indexes delete-index my-index
Databricks ベクター検索インデックスの取得
インデックスを取得します。
databricks vector-search-indexes get-index INDEX_NAME [flags]
Arguments
INDEX_NAME
インデックス名。
オプション
Examples
次の例では、ベクター検索インデックスの詳細を取得します。
databricks vector-search-indexes get-index my-index
databricks vector-search-indexesリストインデックスコマンドにより、インデックスの一覧を取得します。
インデックスを一覧表示します。
databricks vector-search-indexes list-indexes ENDPOINT_NAME [flags]
Arguments
ENDPOINT_NAME
エンドポイントの名前
オプション
--page-token string
改ページのトークン
Examples
次の例では、エンドポイント内のすべてのインデックスを一覧表示します。
databricks vector-search-indexes list-indexes my-endpoint
次の例では、ページネーションを使用してインデックスを一覧表示します。
databricks vector-search-indexes list-indexes my-endpoint --page-token next-page-token
データブリックス ベクトル検索インデックス クエリ インデックス
インデックスのクエリを実行します。
databricks vector-search-indexes query-index INDEX_NAME [flags]
Arguments
INDEX_NAME
クエリするベクター インデックスの名前
オプション
--filters-json string
クエリ フィルターを表す JSON 文字列
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--num-results int
返される結果の数
--query-text string
クエリ テキスト
--query-type string
使用するクエリの種類
--score-threshold float
近似最近隣検索のしきい値
Examples
次の例では、テキストを使用してインデックスを照会します。
databricks vector-search-indexes query-index my-index --query-text "search term" --num-results 10
次の例では、フィルターを使用してインデックスを照会します。
databricks vector-search-indexes query-index my-index --query-text "search term" --filters-json '{"category": "product"}' --num-results 5
データブリックス ベクトル検索 インデックス 次のページを検索するクエリ
次のページをクエリします。
databricks vector-search-indexes query-next-page INDEX_NAME [flags]
Arguments
INDEX_NAME
クエリするベクター インデックスの名前
オプション
--endpoint-name string
エンドポイントの名前
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--page-token string
前の QueryVectorIndex または QueryVectorIndexNextPage API から返されたページ トークン
Examples
次の例では、結果の次のページを照会します。
databricks vector-search-indexes query-next-page my-index --endpoint-name my-endpoint --page-token "next-page-token"
Databricks ベクター検索インデックス スキャンインデックス
インデックスをスキャンします。
databricks vector-search-indexes scan-index INDEX_NAME [flags]
Arguments
INDEX_NAME
スキャンするベクター インデックスの名前
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--last-primary-key string
前回のスキャンで返された最後のエントリの主キー
--num-results int
返される結果の数
Examples
次の例では、インデックスをスキャンします。
databricks vector-search-indexes scan-index my-index --num-results 100
次の例では、特定のキーから始まるインデックスをスキャンします。
databricks vector-search-indexes scan-index my-index --last-primary-key "key123" --num-results 100
Databricks ベクトル検索インデックス 同期インデックス
インデックスを同期します。
databricks vector-search-indexes sync-index INDEX_NAME [flags]
Arguments
INDEX_NAME
同期するベクター インデックスの名前。 差分同期インデックスである必要があります。
オプション
Examples
次の例では、差分同期インデックスの同期をトリガーします。
databricks vector-search-indexes sync-index my-delta-sync-index
Databricks ベクター検索インデックス upsert-data-vector-index
データをインデックスにアップサートします。
databricks vector-search-indexes upsert-data-vector-index INDEX_NAME INPUTS_JSON [flags]
Arguments
INDEX_NAME
データがアップサートされるベクター インデックスの名前。 直接ベクター アクセス インデックスである必要があります。
INPUTS_JSON
アップサートするデータを表す JSON 文字列
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
Examples
次の例では、データを Direct Vector Access インデックスにアップサートします。
databricks vector-search-indexes upsert-data-vector-index my-index '{"vectors": [{"id": "1", "vector": [0.1, 0.2, 0.3], "metadata": {"title": "Document 1"}}]}'
グローバル フラグ
--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 文字列
該当する場合は、使用するバンドル ターゲット