Adding Samples in Batches
Function
This API is used to add samples in batches.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
dataset_id |
Yes |
String |
Dataset ID. |
project_id |
Yes |
String |
Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
final_annotation |
No |
Boolean |
Whether to directly import to the final result. Options:
|
label_format |
No |
LabelFormat object |
Label format. This parameter is used only for text datasets. |
samples |
No |
Array of Sample objects |
Sample list. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
label_type |
No |
String |
Label type of text classification. Options:
|
text_label_separator |
No |
String |
Separator between labels. By default, a comma (,) is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: !@#$%^&*_=|?/':.;, |
text_sample_separator |
No |
String |
Separator between the text and label. By default, the Tab key is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: !@#$%^&*_=|?/':.;, |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
data |
No |
Object |
Byte data of sample files. The type is java.nio.ByteBuffer. When this parameter is called, the string converted from the byte data is uploaded. |
data_source |
No |
DataSource object |
Data source. |
encoding |
No |
String |
Encoding type of sample files, which is used to upload .txt or .csv files. The value can be UTF-8, GBK, or GB2312. The default value is UTF-8. |
labels |
No |
Array of SampleLabel objects |
Sample label list. |
metadata |
No |
SampleMetadata object |
Key-value pair of the sample metadata attribute. |
name |
No |
String |
Name of sample files. The value contains 0 to 1,024 characters and cannot contain special characters (!<>=&"'). |
sample_type |
No |
Integer |
Sample type. Options:
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
data_path |
No |
String |
Data source path. |
data_type |
No |
Integer |
Data type. Options:
|
schema_maps |
No |
Array of SchemaMap objects |
Schema mapping information corresponding to the table data. |
source_info |
No |
SourceInfo object |
Information required for importing a table data source. |
with_column_header |
No |
Boolean |
Whether the first row in the file is a column name. This field is valid for the table dataset. Options:
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
dest_name |
No |
String |
Name of the destination column. |
src_name |
No |
String |
Name of the source column. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
cluster_id |
No |
String |
MRS cluster ID. You can log in to the MRS console to view the information. |
cluster_mode |
No |
String |
Running mode of an MRS cluster. Options:
|
cluster_name |
No |
String |
MRS cluster name You can log in to the MRS console to view the information. |
database_name |
No |
String |
Name of the database to which the table dataset is imported. |
input |
No |
String |
HDFS path of the table data set. For example, /datasets/demo. |
ip |
No |
String |
IP address of your GaussDB(DWS) cluster. |
port |
No |
String |
Port number of your GaussDB(DWS) cluster. |
queue_name |
No |
String |
DLI queue name of a table dataset. |
subnet_id |
No |
String |
Subnet ID of an MRS cluster. |
table_name |
No |
String |
Name of the table to which a table dataset is imported. |
user_name |
No |
String |
Username, which is mandatory for GaussDB(DWS) data. |
user_password |
No |
String |
User password, which is mandatory for GaussDB(DWS) data. |
vpc_id |
No |
String |
ID of the VPC where an MRS cluster resides. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
annotated_by |
No |
String |
Video labeling method, which is used to distinguish whether a video is labeled manually or automatically. Options:
|
id |
No |
String |
Label ID. |
name |
No |
String |
Label name. |
property |
No |
SampleLabelProperty object |
Attribute key-value pair of the sample label, such as the object shape and shape feature. |
score |
No |
Float |
Confidence. The value range is [0,1]. |
type |
No |
Integer |
Label type. Options:
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
@modelarts:content |
No |
String |
Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points). |
@modelarts:end_index |
No |
Integer |
End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of end_index. Example:
|
@modelarts:end_time |
No |
String |
Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of hh:mm:ss.SSS. (hh indicates hour; mm indicates minute; ss indicates second; and SSS indicates millisecond.) |
@modelarts:feature |
No |
Object |
Shape feature, which is a default attribute dedicated to the object detection label, with type of List. The upper left corner of the image is used as the coordinate origin [0, 0]. Each coordinate point is represented by [x, y], where x indicates the horizontal coordinate and y indicates the vertical coordinate (both x and y are >=0). The format of each shape is as follows:
|
@modelarts:from |
No |
String |
ID of the head entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. |
@modelarts:hard |
No |
String |
Sample labeled as a hard sample or not, which is a default attribute. Options:
|
@modelarts:hard_coefficient |
No |
String |
Coefficient of difficulty of each label level, which is a default attribute. The value range is [0,1]. |
@modelarts:hard_reasons |
No |
String |
Reasons that the sample is a hard sample, which is a default attribute. Use a hyphen (-) to separate every two hard sample reason IDs, for example, 3-20-21-19. Options:
|
@modelarts:shape |
No |
String |
Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. Options:
|
@modelarts:source |
No |
String |
Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator. |
@modelarts:start_index |
No |
Integer |
Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of start_index. |
@modelarts:start_time |
No |
String |
Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of hh:mm:ss.SSS. (hh indicates hour; mm indicates minute; ss indicates second; and SSS indicates millisecond.) |
@modelarts:to |
No |
String |
ID of the tail entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
@modelarts:import_origin |
No |
Integer |
Sample source, which is a built-in attribute. |
@modelarts:hard |
No |
Double |
Whether the sample is labeled as a hard sample, which is a default attribute. Options:
|
@modelarts:hard_coefficient |
No |
Double |
Coefficient of difficulty of each sample level, which is a default attribute. The value range is [0,1]. |
@modelarts:hard_reasons |
No |
Array of integers |
ID of a hard sample reason, which is a default attribute. Options:
|
@modelarts:size |
No |
Array of objects |
Image size (width, height, and depth of the image), which is a default attribute, with type of List<Integer>. In the list, the first number indicates the width (pixels), the second number indicates the height (pixels), and the third number indicates the depth (the depth can be left blank and the default value is 3). For example, [100,200,3] and [100,200] are both valid. Note: This parameter is mandatory only when the sample label list contains the object detection label. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
results |
Array of UploadSampleResp objects |
Response list for adding samples in batches. |
success |
Boolean |
Whether the operation is successful. Options:
|
Example Requests
Adding Samples in Batches
{ "samples" : [ { "name" : "2.jpg", "data" : "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAA1AJUDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL" } ] }
Example Responses
Status code: 200
OK
{ "success" : true, "results" : [ { "success" : true, "name" : "/test-obs/classify/input/animals/2.jpg", "info" : "960585877c92d63911ba555ab3129d36" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot