获取样本列表
更新时间:2024-09-23
注意: 为提升开发者使用体验,本文内容已合并至对应API文档,请查看API鉴权及调用-数据管理-获取样本列表;本文档已于2024年6月28日在平台文档中心下线,内容不再更新。
功能介绍
用于获取样本列表。
注意事项
调用本文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.list_all_entity_in_dataset(
dataset_id="ds-7pkzh1exthpuy10n",
offset=0,
page_size=10,
)
print(resp)
返回示例
QfResponse(
code=200,
headers={...},
body={
"log_id": "kap2pmsw2gh4prik",
"result": {
"totalAll":1,
"total":1,
"items": [{
"id":
"f9bc93825e8563588xxx_7951870f3xxxx2f3814b8f268",
"name": "",
"labels": [],
"url": "https://xxxxx",
"memorySize": 0.01,
"isEncrypted": False,
"textExtra": {
"domainType": "",
"taskType": "",
"wordNum": 0,
"repetitiveCharRatio": 0,
"specialCharRatio": 0,
"flaggedWordRatio": 0,
"langProb": 0,
"perplexity": 0,
}
}],
},
"status": 200,
"success": True,
},
)
参数说明
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
dataset_id | string | 是 | 数据集版本ID,说明: (1)可以通过以下任一方式获取该字段值: · 方式一,通过调用创建数据集接口,返回的datasetId字段获取 · 方式二,在控制台-数据集管理列表页面,点击详情,在版本信息页查看,如下图所示: (2)该字段新增支持string类型,如果之前使用的是int类型,建议变更为string类型,后续可能将逐步废弃int类型;例如之前是通过调用创建数据集接口,返回的id字段获取,请替换为接口返回的datasetId字段获取 |
offset | int | 否 | 分页偏移,默认0 |
page_size | int | 否 | 分页大小,说明: · 范围[1,30],超出最大范围按最大范围处理 · 默认20 |
import_time_closure | List[int] | 否 | 导入日期区间,可以获取该区间数据,说明: 需传入2个日期的时间戳,单位毫秒,分别是开始日期时间戳、结束日期时间戳 |
annotating_time_closure | List[int] | 否 | 标注日期区间,可以获取该区间数据,说明: 需传入2个日期的时间戳,单位毫秒,分别是开始日期时间戳、结束日期时间戳 |
listing_type | EntityListingType | 否 | 可选值如下: · EntityListingType.AnnotatedOnly:已标注 · EntityListingType.NotAnnotatedOnly :未标注 · EntityListingType.All:全部,默认值 |
label_id_str | string | 否 | 标签id,说明: · 多个labelId用英文逗号分开,如1,2 · 仅文生图支持 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
log_id | string | 操作记录id |
result | dict | 返回结果 |
status | int | 状态码 |
success | bool | 是否操作成功,说明: · true:成功 · false:失败 |
result说明
名称 | 类型 | 描述 |
---|---|---|
totalAll | int | 总数量 |
total | int | 筛选后的数量 |
items | dict[] | 样本列表 |
items说明
名称 | 类型 | 描述 |
---|---|---|
id | string | 样本ID |
name | string | 样本名称,图片才有 |
labels | dict[] | 标签列表 |
url | string | 存储地址 |
memorySize | int | 样本大小,单位为MB |
isEncrypted | bool | 是否加密 |
textExtra | dict | 文档附加说明 |
label说明
名称 | 类型 | 描述 |
---|---|---|
label_id | string | 标签id |
name | string | 标签名称 |
color | string | 标签颜色 |
textExtra说明
名称 | 类型 | 描述 |
---|---|---|
domainType | string | 领域类型 |
taskType | string | 任务类型 |
wordNum | int | 词数目 |
repetitiveCharRatio | int | 重复率 |
specialCharRatio | int | 特殊字符 |
flaggedWordRatio | int | 色暴词率 |
langProb | int | 语言概率 |
perplexity | int | 困惑率 |