文档

DeleteKbFile - 删除知识库文件

更新时间:
一键部署

通过 OpenAPI 删除通义灵码知识库文件。

适用版本

企业标准版、企业专属版

服务接入点与授权信息

请求语法

DELETE  https://<domain>/oapi/v1/lingma/organizations/<organizationId>/knowledgeBases/<kbId>/files

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

个人访问令牌。

pt-0fh3****0fbG_35af****0484

请求参数

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

所属企业 ID。

99d1****71d4

kbId

string

path

知识库 ID。

3a41****3eca

fileIds

string

body

待删除文件列表。

请求示例

curl -X 'DELETE' \
  'https://test.rdc.aliyuncs.com/oapi/v1/lingma/organizations/99d1****71d4/knowledgeBases/3a41****3eca/files' \
  -H 'accept: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  -d '{   
  "fileIds": [
    "b3f7****291b"
  ]
}'

返回参数

参数

类型

描述

示例值

fileId

string

文件 ID。

b3f7****291b

operateUserId

string

操作用户 ID。

d402****9ae6

failedMessage

string

失败原因,如果成功则为空。

success

boolean

是否删除成功。

true

返回示例

{
  "fileId": "b3f7****291b",
  "operateUserId": "d402****9ae6",
  "failedMessage": "",
  "success": true
}

错误码

访问错误码中心查看 API 相关错误码。