DocumentEnable - 文档生效启停用
更新时间：2026-05-15
API访问域名
| 字段 | 值 |
|---|---|
| 请求方式 | POST |
| base url | https://keyue.cloud.baidu.com |
| 后缀接口 | /open/v1/api/v2/llm/document/enable |
说明
用于批量设置文档启用状态与生失效时间，兼容旧 enable 接口语义。
请求参数
Header参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| Content-Type | string | 是 | 内容类型 | 固定值：application/json |
| token | string | 是 | API KEY | /open/v1/** 路由使用，详细获取方式参考：准备工作 |
| uid | string | 否 | 用户ID | /open/v1/** 路由代码读取该请求头，详细获取方式参考：准备工作 |
| username | string | 否 | 用户名 | /open/v1/** 路由代码读取该请求头，详细获取方式参考：准备工作 |
| Authorization | string | 否 | 鉴权信息 | /open/v2/** 路由代码显式要求的签名鉴权请求头，同token |
| agentId | string | 否 | 机器人ID | 代码中通过请求上下文读取；私有知识库场景可能使用该字段 |
| adminId | string | 否 | 管理员ID | 代码中通过请求上下文读取 |
Body参数
| 名称 | 类型 | 必填 | 中文名 | 说明 |
|---|---|---|---|---|
| dataList | list | 是 | 批量更新数据 | 至少传一条；为空时返回请求错误。详见dataList子数据 |
| dirId | string | 否 | 目录ID | 文档目录ID |
| knowledgePublic | integer | 否 | 知识库类型 | 0-agent内部知识； 1-公共知识 |
| i18n | integer | 否 | 国际化标记 | 0-非国际化；1-国际化 |
dataList子数据
| 名称 | 类型 | 必填 | 中文名 | 说明 |
|---|---|---|---|---|
| id | string | 是 | 文档ID | 文档唯一标识；为空时返回请求错误 |
| available | integer | 否 | 启用状态 | 1 启用，0 停用；不传时表示本次请求不更新该字段 |
| labels | string | 否 | 标签 | 文档标签 |
| effectStartTime | string | 否 | 生效时间 | 时间格式：yyyy-MM-dd HH:mm:ss |
| effectEndTime | string | 否 | 失效时间 | 时间格式：yyyy-MM-dd HH:mm:ss； 若与 effectStartTime 同时传入且开始时间晚于结束时间，则返回请求错误 |
| publishTime | string | 否 | 发布时间 | 时间格式：yyyy-MM-dd HH:mm:ss |
响应参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| time | long | 否 | 响应时间 | 响应时间戳 |
| data | object | 否 | 响应数据 | null |
| code | integer | 是 | 响应码 | 200-成功； 400-Authorization格式错误； 4002012-请求错误； 4002800-已提交审核； 4002801-审核自动通过； 4007282-下游请求失败； 4007288-应用发布中禁止操作； 4008651-open接口token为空； 4008652-open接口机器人不存在； 4009602-公共知识重名冲突 |
| msg | string | 是 | 响应信息 | 成功时通常为OK，失败时返回对应错误信息 |
请求示例
Bash
1curl -X POST "https://keyue.cloud.baidu.com/open/v1/api/v2/llm/document/enable" \
2 -H "Content-Type: application/json" \
3 -H "token: XXXXXXXXXX" \
4 -d '{
5 "dirId": 0,
6 "dataList": [
7 {
8 "id": "a2fecae7-972d-42a9-bf70-03d94b86161e",
9 "available": 1,
10 "publishTime": "2024-06-04 04:04:04",
11 "effectStartTime": "2000-01-01 00:00:00",
12 "effectEndTime": "2099-12-31 23:59:59"
13 },
14 {
15 "id": "72917e9a-d5e4-48f6-9e27-48b35bce65be",
16 "available": 1,
17 "publishTime": "2024-06-04 04:04:04",
18 "effectStartTime": "2000-01-01 00:00:00",
19 "effectEndTime": "2099-12-31 23:59:59"
20 },
21 {
22 "id": "02b9e001-a5c2-47ec-b0fa-f1cef371e5ef",
23 "available": 1,
24 "publishTime": "2024-06-04 04:04:04",
25 "effectStartTime": "2000-01-01 00:00:00",
26 "effectEndTime": "2099-12-31 23:59:59"
27 }
28 ]
29 }'
30响应示例
1{
2 "time": 1778728714710,
3 "data": null,
4 "code": 200,
5 "msg": "OK"
6}1{
2 "time": "代码中未体现",
3 "data": null,
4 "code": 4002012,
5 "msg": "代码中未体现"
6}评价此篇文章