Skip to main content
PUT

Authorizations

Authorization
string
header
required

每个请求都通过 API Key 认证:Authorization: Bearer {API_KEY}。应用接口使用应用 API Key,知识库接口使用知识库 API Key(快速开始)。

API Key 应保存在服务端,切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401(unauthorized)。

Path Parameters

knowledge_base_id
string<uuid>
required

知识库 ID:即知识库 API 访问 对话框中所示服务 API 端点的最后一段(…/knowledge-fs/spaces/<knowledge base ID>),也是地址栏中 /datasets/new/ 之后的那一段。

source_id
string<uuid>
required

数据源 ID,通过 获取数据源列表 获取。

Body

application/json
enabled
boolean
required

是否运行定时同步。mode: manual 时必须为 false。

expectedRevision
integer
required

定时同步当前的 revision,取自 获取同步策略。数据源尚无定时同步时传 0。每次定时同步启动时该值也会递增,因此应在更新前立即读取。值已过时则返回 409,不做任何更改。

Required range: x >= 0
expectedSourceVersion
integer
required

数据源当前的 version,取自 获取数据源 或 获取数据源列表。每次调用 更新数据源 以及每次导入完成后,该值都会变化,因此应在更新前立即读取。值已过时则返回 409,不做任何更改。

Required range: x >= 1
mode
enum<string>
required

manual 关闭定时同步,interval 每 24 小时同步一次,custom 按 customIntervalSeconds 的间隔同步。

Available options:
manual,
interval,
custom
customIntervalSeconds
integer

两次定时同步之间的秒数,取值为 1 小时~30 天。mode: custom 时必填,其他模式下传入会被拒绝。

Required range: 3600 <= x <= 2592000

Response

保存后的定时同步设置。mode: manual 或 enabled: false 时,next_run_at 为 null。

created_at
string

创建时间,ISO 8601 格式。

custom_interval_seconds
integer | null

mode: custom 时的同步间隔,单位为秒。其他模式为 null。

enabled
boolean

是否运行定时同步。mode: manual 时始终为 false。

expected_source_version
integer

定时同步绑定的数据源 version。

id
string

同步策略 ID,更新后保持不变。

knowledge_space_id
string

知识库的内部 ID,并非路径中的知识库 ID。

mode
string

manual(不安排定时同步)、interval(每 24 小时)或 custom(按 custom_interval_seconds 的间隔)。

next_run_at
string | null

下次定时同步的时间,ISO 8601 格式。没有安排时为 null。

revision
integer

定时同步的修订版本。调用 更新同步策略 时将其作为 expectedRevision 传入。每次更新以及每次定时同步开始时都会递增。

source_id
string

定时同步所属的数据源。

updated_at
string

最后变更时间,ISO 8601 格式。定时同步开始时也会更新。