删除样本
更新时间：2024-09-23
注意：为提升开发者使用体验，平台升级了数据集管理接口。推荐使用数据集管理V2版本接口，功能更全面、且接口更规范，详见数据集管理API列表；V1版本相关接口不再升级，本文档于2024年8月30日迁移至历史文档；由于V1版本接口后续可能下线停止服务，为避免影响使用，建议接入V2版本接口。
功能介绍
本接口用于删除样本。
SDK调用
使用说明
调用本文API，需使用安全认证AK/SK鉴权，调用流程及鉴权介绍详见SDK安装及使用流程。
调用示例
import os
from qianfan.resources import Data
# 使用安全认证AK/SK鉴权，通过环境变量方式初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
resp = Data.delete_an_entity(
dataset_id="ds-7pkzh1exthpuy10n",
entity_ids=["f9bc93825e856358886bbc6ad28c7032955b54d171ae8b47587a0346c604139f_7951870f3cd747b497d32f3814xxxxx"]
)
print(resp)返回示例
QfResponse(
code=200,
headers={...},
body={
"log_id": "k1wa616k266sayt1",
"result": {
"failedOnes": None
},
"status": 200,
"success": True,
},
)请求参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| dataset_id | string | 是 | 数据集版本ID，说明： （1）可以通过以下任一方式获取该字段值： · 方式一，通过调用创建数据集接口，返回的datasetId字段获取 · 方式二，在控制台-数据集管理列表页面，点击详情，在版本信息页查看，如下图所示  （2） 该字段新增支持string类型，如果之前使用的是int类型，建议变更为string类型，后续可能将逐步废弃int类型；例如之前是通过调用创建数据集接口，返回的id字段获取，请替换为接口返回的datasetId字段获取 |
| entity_ids | List[string] | 是 | 样本ID列表，通过调用获取样本列表接口，返回的id字段获取样本ID |
返回参数
| 名称 | 类型 | 描述 |
|---|---|---|
| log_id | string | 操作记录id |
| result | dict | 返回结果 |
| status | int | 状态码 |
| success | bool | 是否操作成功，说明： · true：成功 · false：失败 |
result说明
| 名称 | 类型 | 描述 |
|---|---|---|
| failedOnes | string[] | 删除失败的样本列表 |
HTTP调用
鉴权说明
调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。
请求说明
- 基本信息
请求地址：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"
}更多错误码，请查看错误码说明。