vector-search-indexes コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI内のvector-search-indexesコマンドグループには、ベクトル検索インデックスを管理するコマンドが含まれています。ベクトル検索インデックスは、リアルタイムおよび近似最近傍 (ANN) 検索クエリをサポートする埋め込みベクトルの効率的な表現です。「 ベクトル検索インデックスを作成してクエリする方法」を参照してください。
databricks vector-search-indexes create-index
新しいインデックスを作成します。
databricks vector-search-indexes create-index NAME ENDPOINT_NAME PRIMARY_KEY INDEX_TYPE [flags]
引数
NAME
インデックスの名前
ENDPOINT_NAME
インデックスの提供に使用されるエンドポイントの名前
PRIMARY_KEY
インデックスの主キー
INDEX_TYPE
ベクトル検索インデックスには Delta 、同期(ソース Delta テーブルと自動的に同期するインデックス)とダイレクトアクセス(ベクトルとメタデータの直接読み取りと書き込みをサポートするインデックス)の2種類があります。 サポートされている値: DELTA_SYNC、 DIRECT_ACCESS
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
例
次の例では、新しい Delta Sync インデックスを作成します。
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
インデックスからデータを削除します。
databricks vector-search-indexes delete-data-vector-index INDEX_NAME [flags]
引数
INDEX_NAME
データを削除するベクトルインデックスの名前。ダイレクトベクトルアクセスインデックスである必要があります。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
例
次の例では、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]
引数
INDEX_NAME
インデックスの名前
オプション
例
次の例では、ベクトル検索インデックスを削除します。
databricks vector-search-indexes delete-index my-index
databricks vector-search-indexes get-index
インデックスを取得します。
databricks vector-search-indexes get-index INDEX_NAME [flags]
引数
INDEX_NAME
インデックスの名前
オプション
例
次の例では、ベクトル検索インデックスの詳細を取得します。
databricks vector-search-indexes get-index my-index
databricks vector-search-indexes list-indexes
インデックスを一覧表示します。
databricks vector-search-indexes list-indexes ENDPOINT_NAME [flags]
引数
ENDPOINT_NAME
エンドポイントの名前
オプション
--page-token string
ページネーションのトークン
例
次の例は、エンドポイント内のすべてのインデックスを一覧表示します。
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
インデックスをクエリします。
databricks vector-search-indexes query-index INDEX_NAME [flags]
引数
INDEX_NAME
クエリするベクトルインデックスの名前
オプション
--filters-json string
クエリフィルターを表す JSON 文字列
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--num-results int
返される結果の数
--query-text string
クエリテキスト
--query-type string
使用するクエリの種類
--score-threshold float
近似最近傍検索のしきい値
例
次の例では、テキストを含むインデックスをクエリします。
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
次のページをクエリします。
databricks vector-search-indexes query-next-page INDEX_NAME [flags]
引数
INDEX_NAME
クエリするベクトルインデックスの名前
オプション
--endpoint-name string
エンドポイントの名前
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--page-token string
以前の QueryVectorIndex または QueryVectorIndexNextPage API から返されたページ トークン
例
次の例では、結果の次のページを照会します。
databricks vector-search-indexes query-next-page my-index --endpoint-name my-endpoint --page-token "next-page-token"
databricks vector-search-indexes scan-index
インデックスをスキャンします。
databricks vector-search-indexes scan-index INDEX_NAME [flags]
引数
INDEX_NAME
スキャンするベクトルインデックスの名前
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--last-primary-key string
前回のスキャンで返された最後のエントリの主キー
--num-results int
返される結果の数
例
次の例では、インデックスをスキャンします。
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 vector-search-indexes sync-index
インデックスを同期します。
databricks vector-search-indexes sync-index INDEX_NAME [flags]
引数
INDEX_NAME
同期するベクトルインデックスの名前。Delta Sync インデックスである必要があります。
オプション
例
次の例では、Delta Sync インデックスの同期をトリガーします。
databricks vector-search-indexes sync-index my-delta-sync-index
databricks vector-search-indexes upsert-data-vector-index
データをインデックスにアップサートします。
databricks vector-search-indexes upsert-data-vector-index INDEX_NAME INPUTS_JSON [flags]
引数
INDEX_NAME
データが更新挿入されるベクトルインデックスの名前。ダイレクトベクトルアクセスインデックスである必要があります。
INPUTS_JSON
更新挿入されるデータを表す JSON 文字列
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
例
次の例では、データを 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 string
出力ログの書き込み先となるファイルを表す文字列。このフラグが指定されていない場合、デフォルトでは出力ログが stderr に書き込まれます。
--log-format format
ログ・フォーマット・タイプ ( text または json) 。デフォルト値は textです。
--log-level string
ログ形式レベルを表す文字列。指定しない場合、ログ・フォーマット・レベルは使用不可になります。
-o, --output タイプ
コマンド出力タイプ text または json。デフォルト値は textです。
-p, --profile string
コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。このフラグが指定されていない場合、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。
--progress-format format
進行状況ログを表示する形式: default、 append、 inplace、 json
-t, --target string
該当する場合は、使用するバンドル・ターゲット