删除实体
更新时间:2024-01-11
功能介绍
本接口用于删除实体。
注意事项
- 鉴权机制,调用本文API,使用“安全认证/Access Key ”中的Access Key ID 和 Secret Access Key等鉴权,无法使用获取Access Token的方式鉴权,具体鉴权认证机制参考“百度云鉴权认证机制”。
请求说明
基本信息
请求地址:https://qianfan.baidubce.com/wenxinworkshop/entity/delete
请求方式:POST
Header参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Content-Type | string | 是 | 固定值:application/json |
x-bce-date | string | 是 | 当前时间,遵循ISO8601规范,格式如2016-04-06T08:23:49Z |
Authorization | string | 是 | 用于验证请求合法性的认证信息,更多内容请参考鉴权认证机制,签名工具可参考IAM签名工具 |
Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
datasetId | string | 是 | 数据集版本ID,说明: (1)可以通过以下任一方式获取该字段值: · 方式一,通过调用创建数据集接口,返回的datasetId字段获取 · 方式二,在千帆控制台-数据集管理列表页面,点击详情,在版本信息页查看,如下图所示 (2) 该字段新增支持string类型,如果之前使用的是int类型,建议变更为string类型,后续可能将逐步废弃int类型;例如之前是通过调用创建数据集接口,返回的id字段获取,请替换为接口返回的datasetId字段获取 |
id | string[] | 是 | 实体ID列表,通过调用获取实体列表接口,返回的id字段获取实体ID |
响应说明
名称 | 类型 | 描述 |
---|---|---|
log_id | string | 操作记录id |
result | object | 返回结果 |
status | int | 状态码 |
success | bool | 是否操作成功,说明: · true:成功 · false:失败 |
result说明
名称 | 类型 | 描述 |
---|---|---|
failedOnes | string[] | 删除失败的实体列表 |
示例
请求示例
# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/wenxinworkshop/entity/delete'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21a52640015de61bc55ca2e6d8cc23d080016e374525543'\
--header 'x-bce-date: 2023-09-19T13:37:10Z'\
--header 'Content-Type: application/json'\
--data '{
"datasetId": "ds-7pkzh1exthpuy10n",
"id": ["172383aab601a661be32e89bxxxx"]
}'
响应示例
{
"log_id": "d9vkbs591be1u4ms",
"result": {
"failedOnes": null
},
"status": 200,
"success": true
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
error_code | 错误码 |
error_msg | 错误描述信息,帮助理解和解决发生的错误 |
例如参数错误返回:
{
"error_code": 500001,
"error_msg": "param invalid"
}
千帆大模型平台相关错误码,请查看错误码说明。