knowledge-assistants 命令组

Note

此信息适用于 Databricks CLI 版本 0.205 及更高版本。 Databricks CLI 目前处于公共预览阶段。

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

Databricksknowledge-assistants CLI 中的命令组允许管理知识助理和相关资源。

databricks knowledge-assistants create-knowledge-assistant

创建知识助理。

databricks knowledge-assistants create-knowledge-assistant DISPLAY_NAME DESCRIPTION [flags]

参数

DISPLAY_NAME

    知识助手的显示名称,在工作区级别是唯一的。

DESCRIPTION

    此助手可以执行的操作的说明(面向用户)。

选项

--instructions string

    有关代理如何生成答案的其他全局说明。

--json JSON

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

--name string

    知识助手的资源名称。

全局标志

Examples

以下示例创建知识助手:

databricks knowledge-assistants create-knowledge-assistant "Sales Assistant" "Answers questions about sales data"

databricks knowledge-assistants create-knowledge-source

在知识助手下创建知识源。

databricks knowledge-assistants create-knowledge-source PARENT DISPLAY_NAME DESCRIPTION SOURCE_TYPE [flags]

参数

PARENT

    将在其中创建此源的父资源。 格式:knowledge-assistants/{knowledge_assistant_id}

DISPLAY_NAME

    可读知识源的可读显示名称。

DESCRIPTION

    知识源的描述。

SOURCE_TYPE

    源的类型。 支持的值: indexfilesfile_table

选项

--json JSON

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

--name string

    完整资源名称: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}.

全局标志

Examples

以下示例创建知识源:

databricks knowledge-assistants create-knowledge-source knowledge-assistants/my-assistant-id "Sales Docs" "Documentation about sales processes" files

databricks knowledge-assistants delete-knowledge-assistant

删除知识助手。

databricks knowledge-assistants delete-knowledge-assistant NAME [flags]

参数

NAME

    要删除的知识助手的资源名称。 格式:knowledge-assistants/{knowledge_assistant_id}

选项

全局标志

Examples

以下示例删除知识助理:

databricks knowledge-assistants delete-knowledge-assistant knowledge-assistants/my-assistant-id

databricks knowledge-assistants delete-knowledge-source

删除知识源。

databricks knowledge-assistants delete-knowledge-source NAME [flags]

参数

NAME

    要删除的知识源的资源名称。 格式:knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}

选项

全局标志

Examples

以下示例删除知识源:

databricks knowledge-assistants delete-knowledge-source knowledge-assistants/my-assistant-id/knowledge-sources/my-source-id

databricks 知识助手 get-knowledge-assistant

获取知识助理。

databricks knowledge-assistants get-knowledge-assistant NAME [flags]

参数

NAME

    知识助理的资源名称。 格式:knowledge-assistants/{knowledge_assistant_id}

选项

全局标志

Examples

以下示例获取知识助理:

databricks knowledge-assistants get-knowledge-assistant knowledge-assistants/my-assistant-id

databricks knowledge-assistants get-knowledge-source

获取知识源。

databricks knowledge-assistants get-knowledge-source NAME [flags]

参数

NAME

    知识源的资源名称。 格式:knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}

选项

全局标志

Examples

以下示例获取知识源:

databricks knowledge-assistants get-knowledge-source knowledge-assistants/my-assistant-id/knowledge-sources/my-source-id

databricks knowledge-assistants list-knowledge-assistants

列出知识助理。

databricks knowledge-assistants list-knowledge-assistants [flags]

参数

没有

选项

--page-size int

    要返回的知识助理的最大数量。

--page-token string

    从上 list-knowledge-assistants 一次调用收到的页令牌。

全局标志

Examples

以下示例列出了所有知识助理:

databricks knowledge-assistants list-knowledge-assistants

databricks knowledge-assistants list-knowledge-sources

在知识助手下列出知识源。

databricks knowledge-assistants list-knowledge-sources PARENT [flags]

参数

PARENT

    要从中列出父资源。 格式:knowledge-assistants/{knowledge_assistant_id}

选项

--page-size int

    要返回的最大知识源数。

--page-token string

    上一个列表调用中的页面令牌。

全局标志

Examples

以下示例列出了助理的知识源:

databricks knowledge-assistants list-knowledge-sources knowledge-assistants/my-assistant-id

databricks knowledge-assistants sync-knowledge-sources

同步知识助手的所有非索引知识源。 索引源不需要同步。

databricks knowledge-assistants sync-knowledge-sources NAME [flags]

参数

NAME

    知识助手的资源名称。 格式:knowledge-assistants/{knowledge_assistant_id}

选项

全局标志

Examples

以下示例同步助理的所有知识源:

databricks knowledge-assistants sync-knowledge-sources knowledge-assistants/my-assistant-id

databricks knowledge-assistants update-knowledge-assistant

更新知识助手。

databricks knowledge-assistants update-knowledge-assistant NAME UPDATE_MASK DISPLAY_NAME DESCRIPTION [flags]

参数

NAME

    知识助手的资源名称。 格式:knowledge-assistants/{knowledge_assistant_id}

UPDATE_MASK

    要更新的字段的逗号分隔列表。 允许的值:display_namedescriptioninstructions

DISPLAY_NAME

    知识助手的显示名称。

DESCRIPTION

    此助手可以执行的操作的说明。

选项

--instructions string

    有关代理如何生成答案的其他全局说明。

--json JSON

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

--name string

    知识助手的资源名称。

全局标志

Examples

以下示例更新知识助手的显示名称:

databricks knowledge-assistants update-knowledge-assistant knowledge-assistants/my-assistant-id display_name "Updated Sales Assistant" "Answers questions about sales data"

databricks knowledge-assistants update-knowledge-source

更新知识源。

databricks knowledge-assistants update-knowledge-source NAME UPDATE_MASK DISPLAY_NAME DESCRIPTION SOURCE_TYPE [flags]

参数

NAME

    要更新的知识源的资源名称。 格式:knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}

UPDATE_MASK

    要更新的字段的逗号分隔列表。 允许的值:display_namedescription

DISPLAY_NAME

    可读知识源的可读显示名称。

DESCRIPTION

    知识源的描述。

SOURCE_TYPE

    源的类型。 更新时忽略此字段。

选项

--json JSON

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

--name string

    完整资源名称: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}.

全局标志

Examples

以下示例更新知识源:

databricks knowledge-assistants update-knowledge-source knowledge-assistants/my-assistant-id/knowledge-sources/my-source-id display_name "Updated Sales Docs" "Updated documentation about sales" files

全局标志

--debug

  是否启用调试日志记录。

-h--help

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

--log-file 字符串

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

--log-format 格式

    日志格式类型,textjson。 默认值为 text

--log-level 字符串

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

-o, --output 类型

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

-p, --profile 字符串

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

--progress-format 格式

    显示进度日志的格式: defaultappendinplacejson

-t, --target 字符串

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