data_labeling_jobs

Creates, updates, deletes, gets or lists a data_labeling_jobs resource.

Overview

Name	data_labeling_jobs
Type	Resource
Id	google.aiplatform.data_labeling_jobs

Fields

Name	Datatype	Description
name	string	Output only. Resource name of the DataLabelingJob.
activeLearningConfig	object	Parameters that configure the active learning pipeline. Active learning will label the data incrementally by several iterations. For every iteration, it will select a batch of data based on the sampling strategy.
annotationLabels	object	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.
createTime	string	Output only. Timestamp when this DataLabelingJob was created.
currentSpend	object	Represents an amount of money with its currency type.
datasets	array	Required. Dataset resource names. Right now we only support labeling from a single Dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}
displayName	string	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.
encryptionSpec	object	Represents a customer-managed encryption key spec that can be applied to a top-level resource.
error	object	The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
inputs	any	Required. Input config parameters for the DataLabelingJob.
inputsSchemaUri	string	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.
instructionUri	string	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.
labelerCount	integer	Required. Number of labelers to work on each DataItem.
labelingProgress	integer	Output only. Current labeling job progress percentage scaled in interval [0, 100], indicating the percentage of DataItems that has been finished.
labels	object	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.
specialistPools	array	The SpecialistPools' resource names associated with this job.
state	string	Output only. The detailed state of the job.
updateTime	string	Output only. Timestamp when this DataLabelingJob was updated most recently.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	dataLabelingJobsId, locationsId, projectsId	Gets a DataLabelingJob.
list	SELECT	locationsId, projectsId	Lists DataLabelingJobs in a Location.
create	INSERT	locationsId, projectsId	Creates a DataLabelingJob.
delete	DELETE	dataLabelingJobsId, locationsId, projectsId	Deletes a DataLabelingJob.
cancel	EXEC	dataLabelingJobsId, locationsId, projectsId	Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

SELECT examples

Lists DataLabelingJobs in a Location.

SELECT
name,
activeLearningConfig,
annotationLabels,
createTime,
currentSpend,
datasets,
displayName,
encryptionSpec,
error,
inputs,
inputsSchemaUri,
instructionUri,
labelerCount,
labelingProgress,
labels,
specialistPools,
state,
updateTime
FROM google.aiplatform.data_labeling_jobs
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new data_labeling_jobs resource.

All Properties

/*+ create */
INSERT INTO google.aiplatform.data_labeling_jobs (
locationsId,
projectsId,
datasets,
labelerCount,
instructionUri,
activeLearningConfig,
inputsSchemaUri,
inputs,
encryptionSpec,
annotationLabels,
displayName,
labels,
specialistPools
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ datasets }}',
'{{ labelerCount }}',
'{{ instructionUri }}',
'{{ activeLearningConfig }}',
'{{ inputsSchemaUri }}',
'{{ inputs }}',
'{{ encryptionSpec }}',
'{{ annotationLabels }}',
'{{ displayName }}',
'{{ labels }}',
'{{ specialistPools }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: datasets
      value:
        - string
    - name: labelerCount
      value: integer
    - name: instructionUri
      value: string
    - name: activeLearningConfig
      value:
        - name: maxDataItemPercentage
          value: integer
        - name: trainingConfig
          value:
            - name: timeoutTrainingMilliHours
              value: string
        - name: maxDataItemCount
          value: string
        - name: sampleConfig
          value:
            - name: sampleStrategy
              value: string
            - name: followingBatchSamplePercentage
              value: integer
            - name: initialBatchSamplePercentage
              value: integer
    - name: inputsSchemaUri
      value: string
    - name: inputs
      value: any
    - name: encryptionSpec
      value:
        - name: kmsKeyName
          value: string
    - name: annotationLabels
      value: object
    - name: name
      value: string
    - name: currentSpend
      value:
        - name: currencyCode
          value: string
        - name: units
          value: string
        - name: nanos
          value: integer
    - name: displayName
      value: string
    - name: updateTime
      value: string
    - name: state
      value: string
    - name: labels
      value: object
    - name: createTime
      value: string
    - name: specialistPools
      value:
        - string
    - name: error
      value:
        - name: code
          value: integer
        - name: message
          value: string
        - name: details
          value:
            - object
    - name: labelingProgress
      value: integer

DELETE example

Deletes the specified data_labeling_jobs resource.

/*+ delete */
DELETE FROM google.aiplatform.data_labeling_jobs
WHERE dataLabelingJobsId = '{{ dataLabelingJobsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';