批量添加样本
功能介绍
批量添加样本。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
dataset_id |
是 |
String |
数据集ID。 |
|
project_id |
是 |
String |
用户项目ID。获取方法请参见获取项目ID和名称。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
final_annotation |
否 |
Boolean |
是否直接导入到最终结果。可选值如下:
|
|
label_format |
否 |
LabelFormat object |
标签格式,此参数仅文本类数据集使用。 |
|
samples |
否 |
Array of Sample objects |
样本列表。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
label_type |
否 |
String |
文本分类的标签类型。可选值如下:
|
|
text_label_separator |
否 |
String |
标签与标签之间的分隔符,默认为逗号分隔,分隔符需转义。分隔符仅支持一个字符,必须为大小写字母,数字和“!@#$%^&*_=|?/':.;,”其中的某一字符。 |
|
text_sample_separator |
否 |
String |
文本与标签之间的分隔符,默认为Tab键分隔,分隔符需转义。分隔符仅支持一个字符,必须为大小写字母,数字和“!@#$%^&*_=|?/':.;,”其中的某一字符。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
data |
否 |
Object |
样本文件的字节数据。类型为java.nio.ByteBuffer,前台调用时传字节数据转换后的字符串。 |
|
data_source |
否 |
DataSource object |
数据来源。 |
|
encoding |
否 |
String |
样本文件的编码类型,用于文本类型(txt/csv)的文件上传。取值有UTF-8、GBK、GB2312等,默认为UTF-8编码。 |
|
labels |
否 |
Array of SampleLabel objects |
样本标签列表。 |
|
metadata |
否 |
SampleMetadata object |
样本metadata属性键值对。 |
|
name |
否 |
String |
样本文件名称,名称不能包含!<>=&"'特殊字符,长度为0-1024位。 |
|
sample_type |
否 |
Integer |
样本类型。可选值如下:
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
data_path |
否 |
String |
数据源所在路径。 |
|
data_type |
否 |
Integer |
数据类型。可选值如下:
|
|
schema_maps |
否 |
Array of SchemaMap objects |
表格数据对应的schema映射信息。 |
|
source_info |
否 |
SourceInfo object |
导入表格数据源所需的信息。 |
|
with_column_header |
否 |
Boolean |
文件中首行是否是列名,用于表格数据集。可选值如下:
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
cluster_id |
否 |
String |
MRS集群ID。可登录MRS控制台查看。 |
|
cluster_mode |
否 |
String |
MRS集群运行模式。可选值如下:
|
|
cluster_name |
否 |
String |
MRS集群名称。可登录MRS控制台查看。 |
|
database_name |
否 |
String |
导入表格数据集,数据库名字。 |
|
input |
否 |
String |
表格数据集,HDFS路径。例如/datasets/demo。 |
|
ip |
否 |
String |
用户GaussDB(DWS)集群的IP地址。 |
|
port |
否 |
String |
用户GaussDB(DWS)集群的端口。 |
|
queue_name |
否 |
String |
表格数据集,DLI队列名。 |
|
subnet_id |
否 |
String |
MRS集群的子网ID。 |
|
table_name |
否 |
String |
导入表格数据集,表名。 |
|
user_name |
否 |
String |
用户名,GaussDB(DWS)数据需提供此参数。 |
|
user_password |
否 |
String |
用户密码,GaussDB(DWS)数据需提供此参数。 |
|
vpc_id |
否 |
String |
MRS集群所在的vpc的ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
annotated_by |
否 |
String |
视频标注途径,用于区分标签是人工标注的还是自动标注的。可选值如下:
|
|
id |
否 |
String |
标签ID。 |
|
name |
否 |
String |
标签名。 |
|
property |
否 |
SampleLabelProperty object |
样本标签的属性键值对,如物体形状、形状特征等。 |
|
score |
否 |
Float |
置信度,取值范围为[0,1] |
|
type |
否 |
Integer |
标签类型。可选值如下:
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
@modelarts:content |
否 |
String |
语音标签(包含语音内容和语音起止点)专用内置属性:语音文本内容。 |
|
@modelarts:end_index |
否 |
Integer |
命名实体标签专用内置属性:文本的结束位置,但不包括end_index所指的字符。例如:
|
|
@modelarts:end_time |
否 |
String |
语音起止点标签专用内置属性:语音的结束时间,格式“hh:mm:ss.SSS”(其中hh表示小时,mm表示分钟,ss表示秒,SSS表示毫秒)。 |
|
@modelarts:feature |
否 |
Object |
物体检测标签专用内置属性:形状特征,类型为List。以图片的左上角为坐标原点[0, 0],每个坐标点的表示方法为[x, y],x表示横坐标,y表示纵坐标(x和y均>=0)。每种形状的格式如下:
|
|
@modelarts:from |
否 |
String |
三元组关系标签专用内置属性:三元组关系标签的起始实体ID。 |
|
@modelarts:hard |
否 |
String |
内置属性:标签级别是否难例。可选值为:
|
|
@modelarts:hard_coefficient |
否 |
String |
内置属性:标签级别难度系数。范围为[0,1]。 |
|
@modelarts:hard_reasons |
否 |
String |
内置属性:标签级别难例原因。通过中划线间隔单个难例原因ID,例如:“3-20-21-19”。难例原因ID可选值如下:
|
|
@modelarts:shape |
否 |
String |
物体检测标签专用内置属性:物体形状,默认为空。可选值如下:
|
|
@modelarts:source |
否 |
String |
语音起止点标签专用内置属性:语音来源(例如说话人/旁白等)。 |
|
@modelarts:start_index |
否 |
Integer |
命名实体标签专用内置属性:文本的起始位置,值从0开始,包括start_index所指的字符。 |
|
@modelarts:start_time |
否 |
String |
语音起止点标签专用内置属性:语音的起始时间,格式“hh:mm:ss.SSS”(其中hh表示小时,mm表示分钟,ss表示秒,SSS表示毫秒)。 |
|
@modelarts:to |
否 |
String |
三元组关系标签专用内置属性:三元组关系标签的指向实体ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
@modelarts:import_origin |
否 |
Integer |
内置属性:样本来源。 |
|
@modelarts:hard |
否 |
Double |
内置属性:样本级别是否难例。可选值为:
|
|
@modelarts:hard_coefficient |
否 |
Double |
内置属性:样本级别难度系数。范围为[0,1]。 |
|
@modelarts:hard_reasons |
否 |
Array of integers |
内置属性:样本级别难例原因ID列表。难例原因ID可选值如下:
|
|
@modelarts:size |
否 |
Array of objects |
内置属性:图像尺寸(图像的宽度、高度、深度),类型为List[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]。列表中的第一个数字为宽度(像素),第二个数字为高度(像素),第三个数字为深度(深度可以没有,默认为3),如[100,200,3]和[100,200]均合法。 说明:只有当样本的标签列表包含物体检测标签时,此字段必选。 |
响应参数
状态码: 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
操作失败的错误码。 |
|
error_msg |
String |
操作失败的错误信息。 |
|
results |
Array of UploadSampleResp objects |
批量添加样本的响应列表。 |
|
success |
Boolean |
操作是否执行成功。可选值如下:
|
请求示例
批量添加样本
{
"samples" : [ {
"name" : "2.jpg",
"data" : "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAA1AJUDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL"
} ]
}
响应示例
状态码: 200
OK
{
"success" : true,
"results" : [ {
"success" : true,
"name" : "/test-obs/classify/input/animals/2.jpg",
"info" : "960585877c92d63911ba555ab3129d36"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
错误码
请参见错误码。