vector-search-indexes 命令组

The vector-search-indexes command group within the Databricks CLI contains commands to manage vector search indexes. 矢量搜索索引是嵌入矢量的有效表示形式，支持实时和近似近邻（ANN）搜索查询。 请参阅如何创建和查询矢量搜索索引。

databricks vector-search-indexes create-index

创建新索引。

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

Arguments

NAME

    索引的名称

ENDPOINT_NAME

    要用于提供索引的终结点的名称

PRIMARY_KEY

    索引的主键

INDEX_TYPE

    有两种类型的矢量搜索索引：增量同步（自动与源 Delta 表同步的索引）或直接访问（支持直接读取和写入矢量和元数据的索引）。 支持的值： DELTA_SYNC、 DIRECT_ACCESS

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

Global flags

Examples

以下示例创建新的 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]

Arguments

INDEX_NAME

    要删除数据的向量索引的名称。 必须是直接矢量访问索引。

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

Global flags

Examples

以下示例从直接矢量访问索引中删除数据：

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

    索引的名称

选项

Global flags

Examples

以下示例删除矢量搜索索引：

databricks vector-search-indexes delete-index my-index

databricks vector-search-indexes get-index

获取索引。

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

Arguments

INDEX_NAME

    索引的名称

选项

Global flags

Examples

以下示例获取矢量搜索索引的详细信息：

databricks vector-search-indexes get-index my-index

databricks vector-search-indexes list-indexes

List indexes.

databricks vector-search-indexes list-indexes ENDPOINT_NAME [flags]

Arguments

ENDPOINT_NAME

    终结点的名称

选项

--page-token string

    分页的令牌

Global flags

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

查询索引。

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

Arguments

INDEX_NAME

    要查询的向量索引的名称

选项

--filters-json string

    表示查询筛选器的 JSON 字符串

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

--num-results int

    要返回的结果数

--query-text string

    Query text

--query-type string

    要使用的查询类型

--score-threshold float

    近似邻近搜索的阈值

Global flags

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

查询下一页。

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

Arguments

INDEX_NAME

    要查询的向量索引的名称

选项

--endpoint-name string

    终结点的名称

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

--page-token string

    从以前的 QueryVectorIndex 或 QueryVectorIndexNextPage API 返回的页面令牌

Global flags

Examples

以下示例查询下一页结果：

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]

Arguments

INDEX_NAME

    要扫描的矢量索引的名称

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

--last-primary-key string

    上一次扫描中返回的最后一项的主键

--num-results int

    要返回的结果数

Global flags

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 vector-search-indexes sync-index

同步索引。

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

Arguments

INDEX_NAME

    要同步的向量索引的名称。 必须是增量同步索引。

选项

Global flags

Examples

以下示例触发增量同步索引的同步：

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]

Arguments

INDEX_NAME

    要插入数据的向量索引的名称。 必须是直接矢量访问索引。

INPUTS_JSON

    表示要插入的数据的 JSON 字符串

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

Global flags

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"}}]}'

Global flags

--debug

  是否启用调试日志记录。

-h 或 --help

    显示 Databricks CLI、相关命令组或相关命令的帮助。

--log-file 字符串

    一个字符串，表示要将输出日志写入到的文件。 如果未指定此标志，则默认会将输出日志写入到 stderr。

--log-format 格式

    日志格式类型或 textjson。 默认值是 text。

--log-level 字符串

    一个表示日志格式级别的字符串。 如果未指定，则禁用日志格式级别。

-o, --output 类型

    命令输出类型或 textjson。 默认值是 text。

-p, --profile 字符串

    用于运行命令的文件中配置文件 ~/.databrickscfg 的名称。 如果未指定此标志，则如果存在，则使用命名 DEFAULT 的配置文件。

--progress-format 格式

    显示进度日志的格式： default、 append、 inplace或 json

-t, --target 字符串

    如果适用，要使用的捆绑包目标