DocumentList - 查看文档列表
更新时间：2025-01-15
API访问域名
| 请求方式 | GET |
|---|---|
| base url | https://keyue.cloud.baidu.com |
| 后缀接口 | /open/v1/api/v2/llm/document/list |
| Authentication | token为API Key |
说明
无
请求参数
Header参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| Content-Type | string | 是 | 内容类型 | 固定值：application/json |
| token | string | 是 | API KEY | 集成-API-API Key处获取。 详细获取方式参考：准备工作 |
| uid | string | 是 | 用户ID | 鼠标移动至页面右上角账户头像即可获取。 详细获取方式参考：准备工作 |
| username | string | 是 | 用户名 | 鼠标移动至页面右上角账户头像即可获取。 详细获取方式参考：准备工作 |
Parameter参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| pn | integer | 是 | 页码 | 1 |
| ps | integer | 是 | 每页数量 | 5 |
| keyword | string | 否 | 关键字 | "" |
| dirId | string | 是 | 目录id |
Body参数
无
响应参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| time | integer | 是 | 时间 | 1717499666293 |
| data | object | 是 | 数据 | 数据对象 ，详见data子数据 |
| code | integer | 是 | 状态码 | 200 |
| msg | string | 是 | 状态信息 | OK |
data子数据
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| total | integer | 是 | 总数 | 1 |
| pn | integer | 是 | 页码 | 1 |
| ps | integer | 是 | 每页数量 | 20 |
| list | array | 是 | 列表 | 详见list子数据 |
| refresh | boolean | 是 | 刷新 | false |
list子数据
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| _effect | integer | 是 | 生效 | 0 |
| agentId | string | 是 | ||
| id | string | 是 | 文档知识id | |
| name | string | 是 | 名称 | http://fgahjfgah.com |
| size | string | 否 | 大小 | 146.0B |
| wordNumber | string | 是 | 字数 | 0 |
| learnStatus | integer | 是 | 学习状态 | -1学习失败；0学习中；1学习成功；2知识增强中；3抓取中；-2抓取失败 |
| dispatcherStatus | integer | 是 | ||
| fileKey | null | 否 | 文件密钥 | null |
| modelId | string | 是 | ||
| modelFileKey | null | 否 | ||
| datasetId | string | 是 | 数据集ID | 1 |
| dirId | string | 是 | 目录ID | 0 |
| updated | string | 是 | 更新时间 | 2024-06-04 16:08:41 |
| created | string | 是 | 创建时间 | 2024-06-04 16:08:41 |
| createdUserId | string | 是 | 创建用户ID | e1befa4f6e464e24930eba7fc92dd5c2 |
| createdUsername | string | 是 | 创建用户名 | wyl_test7 |
| lastEditId | string | 是 | 最后编辑ID | e1befa4f6e464e24930eba7fc92dd5c2 |
| lastEditUsername | string | 是 | 最后编辑用户名 | wyl_test7 |
| errorMsg | string | 否 | 错误信息 | 模型训练超时:3600s |
| type | integer | 是 | 类型 | 2 |
| available | integer | 是 | 可用性 | 0文档知识；1文档片段；2网页知识 |
| labels | null | 否 | 标签 | null |
| labelList | array | 否 | 标签列表 | [] |
| paramsJson | string | 是 | 参数JSON | {} |
| jobId | string | 是 | ||
| knowledgeEnhancement | integer | 否 | 知识增强 | 0:未增强，1:增强，2:增强但失败 |
| effectStartTime | string | 是 | 生效开始时间 | 2000-01-01 00:00:00 |
| effectEndTime | string | 是 | 生效结束时间 | 2099-12-31 23:59:59 |
| publishTime | null | 否 | 发布时间 | null |
| learntTime | null | 否 | 学习时间 | null |
| enhanceMessage | null | 否 | 增强信息 | null |
| enhanceState | integer | 否 | 增强状态 | 0 |
| webUrl | string | 否 | 网页URL | http://fgahjfgah.com |
| refresh | integer | 否 | 刷新 | 0 |
| refreshTime | null | 否 | 刷新时间 | null |
| knowledgeEnhancementFromJson | boolean | 否 |
请求示例
Bash
1curl --location --request GET 'https://keyue.cloud.baidu.com/open/v1/api/v2/llm/document/list?keyword=&dirId=0&pn=1&ps=20' \
2--header 'token: cdeaa589-2934-478b-9fdd-9a2b00a74124' \
3--header 'Content-Type: application/json' \
4--header 'uid: cf7d9692703d45d1b5517a30ab3efa53' \
5--header 'username: pnstest5'