跳到导航

更新文档

更新文档的名称、内容和/或自动同步设置。

路径参数

documentation_idstring必需

知识库中文档的 ID。添加文档时返回此值。

请求头

xi-api-keystring可选

请求

This endpoint expects an object.
namestring or null可选>=1 character

文档的自定义易读名称。

contentstring or null可选

文档的更新内容。仅支持文本文档、已禁用自动同步的 URL 文档,以及未从外部来源同步的文件文档。

enable_auto_syncboolean or null可选

文档或文件夹是否自动刷新。仅适用于 URL 文档、文件夹和外部同步文件。留空以保留当前值。

auto_removeboolean or null可选

来源不再可用时是否自动移除文档。仅在启用自动同步时适用。留空以保留当前值。

minimum_frequency_daysinteger or null可选1-180

文档刷新的最短频率(以天为单位)。实际间隔可能更短,但不会更长。仅在启用自动同步时适用。留空以保留当前值。

tighten_onlyboolean可选默认为 false

仅适用于文件夹。为 true 时,文件夹中现有项目只会收紧设置,以确保至少与文件夹同样严格,并保留比文件夹更严格的设置。为 false 时,将完全采用文件夹的自动同步设置。外部同步文件夹会忽略此项,其内容始终遵循文件夹的计划。

响应

成功响应

urlobject
OR
fileobject
OR
textobject
OR
folderobject

错误

422
Unprocessable Entity Error