Skip to main content

知识分类管理

知识分类用于组织知识库,分类 code 填入知识库的 classifyCode。它不是知识库内文件目录,也不是自定义元数据字段。

所有请求使用平台 API Key。查询要求 knowledge_category=READ,写入要求 WRITE。对象完整字段见 KnowledgeCategory

分页查询分类

GET /openapi/paas/v1/knowledge/category/list

按名称或父编码查询分类,使用 Query 参数。

权限:knowledge_category=READ

请求参数

参数JSON/表单类型必填说明
pageNointeger当前页,默认 1
pageSizeinteger每页条数,默认 10
namestring名称模糊查询
parentCodestring父分类 code,默认 0

请求示例

curl --get --request GET "${BASE_URL}/openapi/paas/v1/knowledge/category/list" \
--header "Authorization: Bearer ${AIS_API_KEY}" \
--data-urlencode "parentCode=0" \
--data-urlencode "pageNo=1" \
--data-urlencode "pageSize=10"

响应字段

顶层使用 分页响应

字段JSON 类型说明
dataarray[object]字段完整定义见 响应数据字典;示例只保留业务所需字段
data[].idinteger分类主键,更新/删除时使用
data[].codestring分类编码,知识库 classifyCode 使用
data[].namestring分类名称
data[].parentCodestring父分类编码
data[].gradeinteger / null分类层级
data[].childrenarray[object] / null子分类,递归复用同一对象

响应示例

{
"code": 8200,
"message": "SUCCESS",
"pageNo": 1,
"pageSize": 10,
"total": 1,
"totalPage": 1,
"data": [
{
"id": 11,
"code": "category_product",
"name": "产品资料",
"parentCode": "0",
"grade": 1,
"children": []
}
]
}

未匹配时返回空分页。保存 code 供知识库分类关联,保存 id 供修改和删除。

创建分类

POST /openapi/paas/v1/knowledge/category/add

新增知识分类。

权限:knowledge_category=WRITE

请求参数

参数JSON/表单类型必填说明
namestring分类名称
parentCodestring建议填写父分类 code,顶级为 0

请求示例

curl --request POST "${BASE_URL}/openapi/paas/v1/knowledge/category/add" \
--header "Authorization: Bearer ${AIS_API_KEY}" \
--header "Content-Type: application/json" \
--data '{
"name": "产品资料",
"parentCode": "0"
}'

响应字段

顶层使用 普通响应

字段JSON 类型说明
datastring操作结果;成功时可以为空字符串,不包含新资源对象

响应示例

{
"code": 8200,
"message": "SUCCESS",
"data": ""
}

成功 data 为结果字符串,不是新建分类对象;通过分类列表回查 code 和 id。

查询分类详情

GET /openapi/paas/v1/knowledge/category/queryById

读取一个分类对象。

权限:knowledge_category=READ

请求参数

参数JSON/表单类型必填说明
idinteger分类数字主键,Query 参数

请求示例

curl --get --request GET "${BASE_URL}/openapi/paas/v1/knowledge/category/queryById" \
--header "Authorization: Bearer ${AIS_API_KEY}" \
--data-urlencode "id=11"

响应字段

顶层使用 普通响应

字段JSON 类型说明
dataobject字段完整定义见 响应数据字典;示例只保留业务所需字段
data.idinteger分类主键,更新/删除时使用
data.codestring分类编码,知识库 classifyCode 使用
data.namestring分类名称
data.parentCodestring父分类编码
data.gradeinteger / null分类层级
data.childrenarray[object] / null子分类,递归复用同一对象

响应示例

{
"code": 8200,
"message": "SUCCESS",
"data": {
"id": 11,
"code": "category_product",
"name": "产品资料",
"parentCode": "0",
"grade": 1,
"children": []
}
}

数字 id 与分类 code 不可混用。不存在时按错误响应处理。

更新分类

PUT /openapi/paas/v1/knowledge/category/update

更新分类名称,不通过本接口移动文件。

权限:knowledge_category=WRITE

请求参数

参数JSON/表单类型必填说明
idinteger分类数字主键
namestring新分类名称

请求示例

curl --request PUT "${BASE_URL}/openapi/paas/v1/knowledge/category/update" \
--header "Authorization: Bearer ${AIS_API_KEY}" \
--header "Content-Type: application/json" \
--data '{
"id": 11,
"name": "产品与部署资料"
}'

响应字段

顶层使用 普通响应

字段JSON 类型说明
datastring操作结果;成功时可以为空字符串,不包含新资源对象

响应示例

{
"code": 8200,
"message": "SUCCESS",
"data": ""
}

成功 data 为结果字符串,详情需重新查询。

删除分类

DELETE /openapi/paas/v1/knowledge/category/delete

删除指定分类前,核对关联知识库和子分类。具体可删除条件由服务端业务校验决定。

权限:knowledge_category=WRITE

请求参数

参数JSON/表单类型必填说明
idinteger分类数字主键,Query 参数

请求示例

curl --get --request DELETE "${BASE_URL}/openapi/paas/v1/knowledge/category/delete" \
--header "Authorization: Bearer ${AIS_API_KEY}" \
--data-urlencode "id=11"

响应字段

顶层使用 普通响应

字段JSON 类型说明
datastring操作结果;成功时可以为空字符串,不包含新资源对象

响应示例

{
"code": 8200,
"message": "SUCCESS",
"data": ""
}

不要假定分类删除等同于删除知识库,也不要自动级联删除其他资源来绕过校验。超时后先回查分类状态。