Updated on 2024-05-30 GMT+08:00

Reviewing Team Labeling Results

Function

This API is used to review team labeling results.

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}/workforce-tasks/{workforce_task_id}/data-annotations/review

Table 1 Path Parameters

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.

workforce_task_id

Yes

String

ID of a labeling task.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

comments

No

Array of SampleComment objects

Review comment list.

Table 3 SampleComment

Parameter

Mandatory

Type

Description

accept

Yes

Boolean

Whether the submitted sample review comments are passed. Options:

  • true: passed

  • false: not passed

comment

No

String

Review comment, which contains 0 to 256 characters, excluding special characters (!<>=&"'').

sample_id

No

String

Sample ID, which can be obtained by invoking the API for querying the sample list.

score

No

String

Review score, whose value can be A, B, C, or D, in descending order.

worker_id

No

String

Annotation member ID, which can be obtained by invoking the annotation member list interface.

Response Parameters

None

Example Requests

The following is an example of how to review team labeling results. accept has been set to true and score has been set to A.

{
  "comments" : [ {
    "worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f",
    "sample_id" : "0d43f9811d3808a3146c673257d4a1dbhh",
    "accept" : true,
    "comment" : "",
    "score" : "A"
  } ]
}

Example Responses

Status code: 200

OK

{ }

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.