Method: projects.datasets.image.label

Starts a labeling task for image. The type of image labeling task is configured by feature in the request.

HTTP request

POST https://datalabeling.googleapis.com/v1beta1/{parent=projects/*/datasets/*}/image:label

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

Authorization requires the following Google IAM permission on the specified resource parent:

  • datalabeling.annotateddatasets.label

Request body

The request body contains data with the following structure:

JSON representation
{
  "basicConfig": {
    object (HumanAnnotationConfig)
  },
  "feature": enum (Feature),

  // Union field request_config can be only one of the following:
  "imageClassificationConfig": {
    object (ImageClassificationConfig)
  },
  "boundingPolyConfig": {
    object (BoundingPolyConfig)
  },
  "polylineConfig": {
    object (PolylineConfig)
  },
  "segmentationConfig": {
    object (SegmentationConfig)
  }
  // End of list of possible types for union field request_config.
}
Fields
basicConfig

object (HumanAnnotationConfig)

Required. Basic human annotation config.

feature

enum (Feature)

Required. The type of image labeling task.

Union field request_config. Required. Config for labeling tasks. The type of request config must match the selected feature. request_config can be only one of the following:
imageClassificationConfig

object (ImageClassificationConfig)

Configuration for image classification task. One of imageClassificationConfig, boundingPolyConfig, polylineConfig and segmentationConfig are required.

boundingPolyConfig

object (BoundingPolyConfig)

Configuration for bounding box and bounding poly task. One of imageClassificationConfig, boundingPolyConfig, polylineConfig and segmentationConfig are required.

polylineConfig

object (PolylineConfig)

Configuration for polyline task. One of imageClassificationConfig, boundingPolyConfig, polylineConfig and segmentationConfig are required.

segmentationConfig

object (SegmentationConfig)

Configuration for segmentation task. One of imageClassificationConfig, boundingPolyConfig, polylineConfig and segmentationConfig are required.

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Feature

Image labeling task feature.

Enums
FEATURE_UNSPECIFIED
CLASSIFICATION Label whole image with one or more of labels.
BOUNDING_BOX Label image with bounding boxes for labels.
ORIENTED_BOUNDING_BOX Label oriented bounding box. The box does not have to be parallel to horizontal line.
BOUNDING_POLY Label images with bounding poly. A bounding poly is a plane figure that is bounded by a finite chain of straight line segments closing in a loop.
POLYLINE Label images with polyline. Polyline is formed by connected line segments which are not in closed form.
SEGMENTATION Label images with segmentation. Segmentation is different from bounding poly since it is more fine-grained, pixel level annotation.