ai-search 命令组

注释

Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明，包括任何数据使用规定。

ai-search Databricks CLI 中的命令组包含管理 AI 搜索端点和索引的命令。 AI搜索端点代表用于托管AI搜索索引的计算资源。 参见 AI搜索。

Databricks AI-Search 创建-端点

创建一个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 搜索终结点的名称。

--replica-count int

    终端所需的副本数量。

--target-qps int

    目标QPS（每秒查询数）用于终端。

--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 目录表名称由用户提供。

--index-subtype IndexSubtype

    指数的子类型。 支持的值：FULL_TEXT、HYBRID、VECTOR

--json JSON

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

--name string

    AI搜索索引的名称。

全局标志

DataBricks AI-Search Delete-Endpoint

删除 AI 搜索终结点。

databricks ai-search delete-endpoint NAME [flags]

Arguments

NAME

    要删除端点的完整资源名。 格式：workspaces/{workspace_id}/endpoints/{endpoint_id}

选项

全局标志

Databricks AI-搜索删除-索引

删除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-搜索查询-索引

查询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-Search remove-data

从AI搜索索引中移除数据。

databricks ai-search remove-data NAME [flags]

Arguments

NAME

    索引的完整资源名称。 一定是直接访问索引。 格式：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 更新-端点

更新AI搜索端点。

databricks ai-search update-endpoint NAME UPDATE_MASK ENDPOINT_TYPE [flags]

Arguments

NAME

    AI 搜索终结点的名称。 输出的完整资源路径（格式： 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 搜索终结点的名称。

--replica-count int

    终端所需的副本数量。

--target-qps int

    目标QPS（每秒查询数）用于终端。

--usage-policy-id string

    使用策略ID应用到了终端。

全局标志

Databricks AI-Search upsert-data

将数据上溯到AI搜索索引中。

databricks ai-search upsert-data NAME INPUTS_JSON [flags]

Arguments

NAME

    索引的完整资源名称。 一定是直接访问索引。 格式：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 字符串

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