知识
API 鉴权
NOTE
- 获取 AUTH_TOKEN 的途径，可以查看 授权 - 获取 AUTH_TOKEN 部分信息。
- 请确保所有的 API 请求都在请求头中包含 AUTH_TOKEN，如下所示：
SDK 鉴权
NOTE
- 在进行SDK集成之前，请确保已经获得 APP_ID 和 APP_KEY。
- 获取 APP_ID 和 APP_KEY 的途径，可以查看 授权 - 获取 APP_ID & APP_KEY 部分信息。
知识库
API 请求示例
- 示例
- 字段描述
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| page | Integer | N | 页码（起始值为0） |
| size | Integer | N | 单页返回记录数 |
| keyword | String | N | 关键词 |
API 响应示例
- 示例
- 字段描述
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| pageNum | Integer | Y | 页码（起始值为0） |
| pageSize | Integer | Y | 单页返回记录数 |
| total | Integer | Y | 总记录数 |
| pages | Integer | Y | 总页面数 |
| currentPageTotal | Integer | Y | 当前页记录数量 |
| content | Array<Object> | Y | 知识库列表内容 |
| content.id | Integer | Y | 知识库唯一标识 |
| content.name | String | Y | 知识库 - 名称 |
| content.description | String | Y | 知识库 - 描述 |
| content.status | String | Y | 知识库 - 状态 ENABLED/DISABLED |
| content.totalDoc | Integer | Y | 知识库 - 文档总数 |
| content.totalRecord | Integer | Y | 知识库 - 文档记录数 |
| content.createDatetime | Timestamp | Y | 知识库 - 创建时间 |
| content.updateDatetime | Timestamp | Y | 知识库 - 更新时间 |
知识文档
API 请求示例
- 示例
- 字段描述
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| page | Integer | N | 页码（起始值为0） |
| size | Integer | N | 单页返回记录数 |
| keyword | String | N | 关键词 |
| knowledgeBaseId | Integer | Y | 知识库唯一标识 |
API 响应示例
- 示例
- 字段描述
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| pageNum | Integer | Y | 页码（起始值为0） |
| pageSize | Integer | Y | 单页返回记录数 |
| total | Integer | Y | 总记录数 |
| pages | Integer | Y | 总页面数 |
| currentPageTotal | Integer | Y | 当前页记录数量 |
| content | Array<Object> | Y | 知识库文档列表内容 |
| content.id | Integer | Y | 知识库文档唯一标识 |
| content.name | String | Y | 知识库文档 - 名称 |
| content.type | String | Y | 知识库文档 - 类型 TEXT_PLAIN/MARKDOWN/ APPLICATION_PDF/DOCX |
| content.source | String | Y | 知识库文档 - 来源 LOCAL/ONLINE |
| content.status | String | Y | 知识库文档 - 状态 UN_PROCESS/PROCESSING/ PROCESSING_FAILED/PROCESSED |
| content.totalRecord | Integer | Y | 知识库文档 - 记录数 |
| content.createDatetime | Timestamp | Y | 知识库文档 - 创建时间 |
| content.updateDatetime | Timestamp | Y | 知识库文档 - 更新时间 |
知识文档 上传
API 请求示例
- 示例
- 字段描述
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| knowledgeBaseId | Integer | Y | 知识库唯一标识 |
| document | File | Y | 上传文档 |
API 响应示例
- 示例
- 字段描述
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| id | String | Y | 上传文档 - 临时ID |
知识文档 解析
解析触发
API 请求示例
- 示例
- 字段描述
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| id | Integer | Y | 上传文档 - 临时ID |
| knowledgeBaseId | Integer | Y | 知识库唯一标识 |
| source | String | Y | 文档来源 LOCAL/ONLINE |
| ragStatus | String | N | 是否开启检索增强（RAG） ENABLED/DISABLED |
| segmentIdentifier | String | N | 分段标记 LINE_BREAK/LINE_BREAK_2 |
| segmentSize | Integer | N | 分段长度限制（0 - 2000） |
API 响应示例
- 示例
- 字段描述
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| taskId | Integer | Y | 任务ID |
| status | String | Y | 任务状态 CREATED/IN_PROCESS/FAILED/FINISHED |
| totalNum | Integer | Y | 任务总进度总数量 |
| successNum | Integer | Y | 任务处理成功数量 |
| failureNum | Integer | Y | 任务处理失败数量 |
解析进度
API 请求示例
- 示例
- 字段描述
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| id | Integer | Y | 任务ID |
API 响应示例
- 示例
- 字段描述
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| taskId | Integer | Y | 任务ID |
| status | String | Y | 任务状态 CREATED/IN_PROCESS/FAILED/FINISHED |
| totalNum | Integer | Y | 任务总进度总数量 |
| successNum | Integer | Y | 任务处理成功数量 |
| failureNum | Integer | Y | 任务处理失败数量 |
| data | Object | Y | 任务进度，补充信息 |
知识文档 预览
API 请求示例
- 示例
- 字段描述
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| page | Integer | N | 页码（起始值为0） |
| size | Integer | N | 单页返回记录数 |
| knowledgeBaseId | Integer | Y | 知识库唯一标识 |
| knowledgeDocId | Integer | Y | 知识库文档唯一标识 |
API 响应示例
- 示例
- 字段描述
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| id | Integer | Y | 文档唯一标识 |
| hasMore | Boolean | Y | 是否有更多分段内容 |
| segments | Array<Object> | Y | 分段列表内容 |
| segments.number | Integer | Y | 文档分段编号（起始值为0） |
| segments.tokens | Integer | Y | 文档分段Token预估 |
| segments.raw | String | Y | 文档分段原始数据 |