删除实体
更新时间:2024-01-22
功能介绍
用于删除实体。
注意事项
调用本文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[] | 删除失败的实体列表 |