Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132661,4471.5 MB
projects

Creates a DataLabelingJob.

post/v1/{+parent}/dataLabelingJobs

Path parameters

parentstring required

Required. The parent of the DataLabelingJob. Format: projects/{project}/locations/{location}

Request body

inputsSchemaUristring

Required. Points to a YAML file stored on Google Cloud Storage describing the config for a specific type of DataLabelingJob. The schema files that can be used here are found in the https://storage.googleapis.com/google-cloud-aiplatform bucket in the /schema/datalabelingjob/inputs/ folder.

annotationLabelsobject

Labels to assign to annotations generated by this DataLabelingJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

displayNamestring

Required. The user-defined name of the DataLabelingJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. Display name of a DataLabelingJob.

instructionUristring

Required. The Google Cloud Storage location of the instruction pdf. This pdf is shared with labelers, and provides detailed description on how to label DataItems in Datasets.

labelingProgressinteger

Output only. Current labeling job progress percentage scaled in interval [0, 100], indicating the percentage of DataItems that has been finished.

specialistPoolsstring[]

The SpecialistPools' resource names associated with this job.

namestring

Output only. Resource name of the DataLabelingJob.

labelerCountinteger

Required. Number of labelers to work on each DataItem.

datasetsstring[]

Required. Dataset resource names. Right now we only support labeling from a single Dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}

labelsobject

The labels with user-defined metadata to organize your DataLabelingJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each DataLabelingJob: * "aiplatform.googleapis.com/schema": output only, its value is the inputs_schema's title.

updateTimestring google-datetime

Output only. Timestamp when this DataLabelingJob was updated most recently.

state'JOB_STATE_UNSPECIFIED' | 'JOB_STATE_QUEUED' | 'JOB_STATE_PENDING' | 'JOB_STATE_RUNNING' | 'JOB_STATE_SUCCEEDED' | 'JOB_STATE_FAILED' | 'JOB_STATE_CANCELLING' | 'JOB_STATE_CANCELLED' | 'JOB_STATE_PAUSED' | 'JOB_STATE_EXPIRED' | 'JOB_STATE_UPDATING' | 'JOB_STATE_PARTIALLY_SUCCEEDED'

Output only. The detailed state of the job.

{"stackTrail":"components:schemas:GoogleCloudAiplatformV1DataLabelingJob:properties:inputs","oasType":"schema","type":"unknown","description":"Required. Input config parameters for the DataLabelingJob."}
createTimestring google-datetime

Output only. Timestamp when this DataLabelingJob was created.

Response

Successful response