Obtaining Details About a Sample
Function
Obtain details about a sample.
Debugging
You can debug this API in which supports automatic authentication. API Explorer can automatically generate SDK code examples and provide the SDK code example debugging.
URI
GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples/{sample_id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| dataset_id | Yes | String | Dataset ID |
| project_id | Yes | String | Project ID. For details, see Obtaining a Project ID and Name. |
| sample_id | Yes | String | Sample ID |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| locale | No | String | Language |
| sample_state | No | String | Sample status. Options: |
| worker_id | No | String | ID of a labeling team member |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| check_accept | Boolean | Whether the acceptance is passed, which is used for team labeling. Options: |
| check_comment | String | Acceptance comment, which is used for team labeling. |
| check_score | String | Acceptance score, which is used for team labeling. |
| deletion_reasons | Array of strings | Reason for deleting a sample, which is used for healthcare. |
| hard_details | Map<String,HardDetail> | Difficult problem details, including description, causes, and suggestions of difficult problems. |
| labelers | Array of Worker objects | Labeling personnel list of sample allocation. The list records the team members receiving the samples, which is used for team labeling. |
| labels | Array of SampleLabel objects | List of sample labels |
| metadata | SampleMetadata object | Attribute key-value pair of the sample metadata |
| review_accept | Boolean | Whether to accept the review, which is used for team labeling. Options: |
| review_comment | String | Review comment, which is used for team labeling. |
| review_score | String | Review score, which is used for team labeling. |
| sample_data | Array of strings | List of sample data |
| sample_dir | String | Path for storing a sample |
| sample_id | String | Sample ID |
| sample_name | String | Sample name |
| sample_size | Long | Sample size or text length, in bytes |
| sample_status | String | Sample status. Options: |
| sample_time | Long | Sample time, when OBS is last modified. |
| sample_type | Integer | Sample type. Options: |
| score | String | Comprehensive score, which is used for team labeling. |
| source | String | Source address of sample data |
| sub_sample_url | String | Subsample URL, which is used for healthcare. |
| worker_id | String | ID of a labeling team member, which is used for team labeling. |
| Parameter | Type | Description |
|---|---|---|
| alo_name | String | Alias |
| id | Integer | Reason ID |
| reason | String | Reason description |
| suggestion | String | Handling suggestion |
| Parameter | Type | Description |
|---|---|---|
| create_time | Long | Worker creation time |
| description | String | Labeling team member description. The value contains 0 to 256 characters. Special characters (^!<>=&"') are not allowed. |
| | String | Email address of a labeling team member |
| role | Integer | Role. Options: |
| status | Integer | Current login status of a labeled member. Options: |
| update_time | Long | Worker update time |
| worker_id | String | ID of a labeling team member |
| workforce_id | String | ID of a labeling team |
| Parameter | Type | Description |
|---|---|---|
| annotated_by | String | Video labeling method, which is used to determine whether a video is labeled manually or automatically. Options: |
| id | String | Label ID |
| name | String | Label name |
| property | SampleLabelProperty object | Attribute key-value pair of the sample label, such as the object shape and shape feature |
| score | Float | Confidence. The value ranges from 0 to 1. |
| type | Integer | Label type. Options: |
Request Example
Run the following command to obtain details about a sample:
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/data-annotations/samples/{sample_id} Response Example
Status code: 200
OK
{
"sample_id" : "012f99f3cf405860130b6ed2350c2228",
"sample_type" : 0,
"labels" : [ {
"name" : "car",
"type" : 0,
"property" : { }
} ],
"source" : "https://test-obs.obs.xxx.com:443/image/aifood/%E5%86%B0%E6%BF%80%E5%87%8C/36502.jpg?AccessKeyId=RciyO7RHmhNTfOZVryUH&Expires=1606297079&Signature=Ju4FYpEu973ii%2FAdUVLTfpLCTbg%3D",
"metadata" : {
"@modelarts:import_origin" : 0
},
"sample_time" : 1589190552106,
"sample_status" : "MANUAL_ANNOTATION",
"labelers" : [ {
"email" : "xxx@xxx.com",
"worker_id" : "5d8d4033b428fed5ac158942c33940a2",
"role" : 0
} ]
} Status Code
| Status Code | Description |
|---|---|
| 200 | OK |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.