vector-search-indexes 命令群組

Note

此資訊適用於 Databricks CLI 版本 0.205 及以上。 Databricks CLI 處於 公開預覽狀態。

Databricks CLI 的使用受限於 Databricks 授權 和 Databricks 隱私權聲明，包括任何使用數據條款。

vector-search-indexes 內的命令群組包含管理向量搜尋索引的命令。 向量搜尋索引是內嵌向量的有效表示法，可支持即時和近似近鄰 （ANN） 搜尋查詢。 請參閱 馬賽克 AI 向量搜尋。

Databricks 向量搜尋索引 創建索引

建立新的索引。

databricks vector-search-indexes create-index NAME ENDPOINT_NAME PRIMARY_KEY INDEX_TYPE [flags]

Arguments

NAME

    索引的名稱

ENDPOINT_NAME

    要用於提供索引的端點名稱

PRIMARY_KEY

    索引的主鍵

INDEX_TYPE

    有兩種類型的向量搜尋索引：Delta同步（自動與來源Delta表同步的索引）或直接存取（支持直接讀取和寫入向量及中繼資料的索引）。 支援的值：DELTA_SYNC、DIRECT_ACCESS

選項

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

Examples

下列範例會建立新的 Delta Sync 索引：

databricks vector-search-indexes create-index my-index my-endpoint id DELTA_SYNC

下列範例會建立新的直接存取索引：

databricks vector-search-indexes create-index my-index my-endpoint id DIRECT_ACCESS

databricks 向量搜尋索引刪除資料向量索引

從索引中刪除數據。

databricks vector-search-indexes delete-data-vector-index INDEX_NAME [flags]

Arguments

INDEX_NAME

    要刪除資料的向量索引名稱。 必須是直接向量存取索引。

選項

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

Examples

下列範例會從直接向量存取索引中刪除資料：

databricks vector-search-indexes delete-data-vector-index my-index --json '{"primary_keys": ["key1", "key2"]}'

Databricks 向量搜尋索引 刪除索引

刪除索引。

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 向量搜尋索引 list-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 向量搜尋索引查詢索引

查詢索引。

databricks vector-search-indexes query-index INDEX_NAME [flags]

Arguments

INDEX_NAME

    要查詢的向量索引名稱

選項

--filters-json string

    代表查詢篩選的 JSON 字串

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

--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 向量搜尋索引查詢下一頁

查詢下一頁。

databricks vector-search-indexes query-next-page INDEX_NAME [flags]

Arguments

INDEX_NAME

    要查詢的向量索引名稱

選項

--endpoint-name string

    端點的名稱

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

--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 字串或 @path 整合至包含要求內容的 JSON 檔案。

--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

下列範例會觸發 Delta Sync 索引的同步處理：

databricks vector-search-indexes sync-index my-delta-sync-index

Databricks 向量搜尋索引插入或更新資料向量索引

將數據插入或更新至索引。

databricks vector-search-indexes upsert-data-vector-index INDEX_NAME INPUTS_JSON [flags]

Arguments

INDEX_NAME

    要向上插入數據的向量索引的名稱。 必須是直接向量存取索引。

INPUTS_JSON

    JSON 字串，表示要向上插入的數據

選項

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

Examples

下列範例會將資料插入或更新至直接向量存取索引：

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、、appendinplace、 或json

-t, --target 字串

    如果適用，要使用的套件組合目標