请求地址

权限

updateDocument
确保调用该接口使用的个人令牌开通了updateDocument权限，详细信息参考鉴权方式。

接口说明

调用接口修改知识库文件名称和更新策略。

Authorization

Bearer $Access_Token

用于验证客户端身份的访问令牌。你可以在扣子编程中生成访问令牌，详细信息，参考准备工作。

Content-Type

application/json

请求正文的方式。

Agw-Js-Conv

str

防止丢失数字类型参数的精度。

document_id

String

可选

738694205603010****

待修改的知识库文件 ID。

document_name

String

可选

cozeoverview

知识库文件的新名称。

update_rule

Object of UpdateRule

可选

{“update_type”:1,“update_interval”:1}

在线网页的更新配置。

update_type

Integer

可选

1

在线网页是否自动更新。取值包括：

• 0：（默认）不自动更新
• 1：自动更新

update_interval

Integer

可选

24

在线网页自动更新的频率。单位为小时，最小值为 24。

document_info

Object of DocumentInfo

-

deprecated 兼容老接口，更新内容时会返回。

code

Long

0

状态码。
0 代表调用成功。

msg

String

“”

状态信息。API 调用失败时可通过此字段查看详细错误信息。
状态码为 0 时，msg 默认为空。

detail

Object of ResponseDetail

{“logid”:“20241210152726467C48D89D6DB2****”}

包含请求的详细信息的对象，主要用于记录请求的日志 ID 以便于排查问题。

char_count

Integer

4

文件内容的总字符数量。

chunk_strategy

Object of ChunkStrategy

{ “chunk_type”: 1, “max_tokens”: 800, “remove_extra_spaces”: false, “remove_urls_emails”: false, “separator”: “#” }

分段规则。

create_time

Integer

1719907964

文件的上传时间，格式为 10 位的 Unixtime 时间戳。

document_id

String

738694205603010****

文件的 ID。

format_type

Integer

0

文件的格式类型。取值包括：

• 0：文档类型，例如 txt 、pdf 、在线网页等格式均属于文档类型。
• 1：表格类型，例如 xls 表格等格式属于表格类型。
• 2：照片类型，例如 png 图片等格式属于照片类型。

hit_count

Integer

0

被对话命中的次数。

name

String

Coze.pdf

文件的名称。

size

Integer

14164

文件的大小，单位为字节。

slice_count

Integer

1

文件的分段数量。

source_type

Integer

0

文件的上传方式。取值包括：

• 0：上传本地文件。
• 1：上传在线网页。

status

Integer

1

文件的处理状态。取值包括：

• 0：处理中
• 1：处理完毕
• 9：处理失败，建议重新上传

type

String

pdf

本地文件格式，即文件后缀，例如 txt。格式支持 pdf、txt、doc、docx 类型。

update_interval

Integer

0

在线网页自动更新的频率。单位为小时。

update_time

Integer

1719907969

文件的最近一次修改时间，格式为 10 位的 Unixtime 时间戳。

update_type

Integer

0

在线网页是否自动更新。取值包括：

• 0：不自动更新
• 1：自动更新

tos_uri

String

FileBizType.BIZ_BOT_DATASET/847077809337655_1727579972975689529_0ytrdq****.docx

上传的本地文档的唯一标识。

chunk_type

Integer

0

分段设置。取值包括：

• 0：自动分段与清洗。采用扣子编程预置规则进行数据分段与处理。
• 1：自定义。此时需要通过 separator、max_tokens、remove_extra_spaces 和 remove_urls_emails 分段规则细节。

separator

String

分段标识符。
在 chunk_type=1 时必选。

max_tokens

Long

800

最大分段长度，取值范围为 100~2000。
在 chunk_type=1 时必选。

remove_extra_spaces

Boolean

true

是否自动过滤连续的空格、换行符和制表符。取值包括：

• true：自动过滤
• false：（默认）不自动过滤

在 chunk_type=1 时生效。

remove_urls_emails

Boolean

true

是否自动过滤所有 URL 和电子邮箱地址。取值包括：

• true：自动过滤
• false：（默认）不自动过滤

在 chunk_type=1 时生效。

caption_type

Integer

0

图片知识库的标注方式：

• 0：（默认）系统自动标注描述信息
• 1：手工标注。上传图片后需要再次调用 API 更新知识库图片描述来手动设置标注。

logid

String

20241210152726467C48D89D6DB2****

本次请求的日志 ID。如果遇到异常报错场景，且反复重试仍然报错，可以根据此 logid 及错误码联系扣子团队获取帮助。详细说明可参考获取帮助和技术支持。