更新时间:2025-03-12 GMT+08:00
分享

删除知识库

功能介绍

该接口用于删除知识库。

调用方法

请参见如何调用API

URI

DELETE https://aiae.appstage.myhuaweicloud.com/v1/knowledge-bases/{knowledge_base_id}

表1 路径参数

参数

是否必选

参数类型

描述

knowledge_base_id

String

参数解释:

知识库id。获取方式:

1.从创建知识库接口返回获取。

2.进入AI原生应用引擎,在左侧导航栏选择“知识中心 > 知识库”,可从页面知识库id栏获取。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

参数解释:

鉴权信息。获取平台API Key,并为API Key添加前缀Bearer,得到标准鉴权信息,例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data

DeleteResult object

参数解释:

知识数据集删除结果。

取值范围:

不涉及。

表4 DeleteResult

参数

参数类型

描述

id

String

参数解释:

知识库id。

取值范围:

由数字、字母和中划线组成,长度36。

name

String

参数解释:

知识库名称。

取值范围:

由中英文、数字、“_”组成,长度为[2-50]。

result

Boolean

参数解释:

知识库删除成功或失败。

取值范围:

true或false。

reason

String

参数解释:

知识库删除失败原因。

取值范围:

不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

异常错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

异常错误信息。

取值范围:

不涉及。

请求示例

响应示例

状态码:200

操作成功,返回删除结果。

{
  "data" : {
    "id" : "djh28e62-xxxxxxxxx-a15be0d63812",
    "name" : "知识库名称",
    "result" : false,
    "reason" : "知识库已启用"
  }
}

状态码:400

请求错误。

{
  "error_code" : "AIAE.40001001",
  "error_msg" : "参数xxxx不合法。"
}

状态码

状态码

描述

200

操作成功,返回删除结果。

400

请求错误。

错误码

请参见错误码

相关文档