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

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: datalabeling1-beta1 --scope <scope> projects datasets-image-label ...

Required Scalar Argument

  • <parent> (string)
    • Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GoogleCloudDatalabelingV1beta1LabelImageRequest:
  basic-config:
    annotated-dataset-description: string
    annotated-dataset-display-name: string
    contributor-emails: [string]
    instruction: string
    label-group: string
    language-code: string
    question-duration: string
    replica-count: integer
    user-email-address: string
  bounding-poly-config:
    annotation-spec-set: string
    instruction-message: string
  feature: string
  image-classification-config:
    allow-multi-label: boolean
    annotation-spec-set: string
    answer-aggregation-type: string
  polyline-config:
    annotation-spec-set: string
    instruction-message: string
  segmentation-config:
    annotation-spec-set: string
    instruction-message: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .basic-config annotated-dataset-description=ipsum
    • Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long.
  • annotated-dataset-display-name=sed
    • Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .
  • contributor-emails=ut
    • Optional. If you want your own labeling contributors to manage and work on this labeling request, you can set these contributors here. We will give them access to the question types in crowdcompute. Note that these emails must be registered in crowdcompute worker UI: https://crowd-compute.appspot.com/
    • Each invocation of this argument appends the given value to the array.
  • instruction=gubergren
    • Required. Instruction resource name.
  • label-group=rebum.
    • Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression [a-zA-Z\\d_-]{0,128}.
  • language-code=est
    • Optional. The Language of this question, as a BCP-47. Default value is en-US. Only need to set this when task is language related. For example, French text classification.
  • question-duration=ipsum
    • Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.
  • replica-count=51
    • Optional. Replication of questions. Each question will be sent to up to this number of contributors to label. Aggregated answers will be returned. Default is set to 1. For image related labeling, valid values are 1, 3, 5.

  • user-email-address=est

    • Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent.

  • ..bounding-poly-config annotation-spec-set=gubergren

    • Required. Annotation spec set resource name.

  • instruction-message=ea

    • Optional. Instruction message showed on contributors UI.

  • .. feature=dolor

    • Required. The type of image labeling task.
  • image-classification-config allow-multi-label=true
    • Optional. If allow_multi_label is true, contributors are able to choose multiple labels for one image.
  • annotation-spec-set=eos
    • Required. Annotation spec set resource name.

  • answer-aggregation-type=labore

    • Optional. The type of how to aggregate answers.

  • ..polyline-config annotation-spec-set=sed

    • Required. Annotation spec set resource name.

  • instruction-message=duo

    • Optional. Instruction message showed on contributors UI.

  • ..segmentation-config annotation-spec-set=sed

    • Required. Annotation spec set resource name. format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}
  • instruction-message=no
    • Instruction message showed on labelers UI.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").