Google Cloud Ai Platform V1 Client - Class DataLabelingJob (1.3.0)

Version 1.3.0

• 1.13.1 (latest)
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class DataLabelingJob.

DataLabelingJob is used to trigger a human labeling job on unlabeled data from the following Dataset:

Generated from protobuf message google.cloud.aiplatform.v1.DataLabelingJob

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Output only. Resource name of the DataLabelingJob.
↳ display_name	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.
↳ datasets	array Required. Dataset resource names. Right now we only support labeling from a single Dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}
↳ annotation_labels	array|Google\Protobuf\Internal\MapField 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.
↳ labeler_count	int Required. Number of labelers to work on each DataItem.
↳ instruction_uri	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.
↳ inputs_schema_uri	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.
↳ inputs	Google\Protobuf\Value Required. Input config parameters for the DataLabelingJob.
↳ state	int Output only. The detailed state of the job.
↳ labeling_progress	int Output only. Current labeling job progress percentage scaled in interval [0, 100], indicating the percentage of DataItems that has been finished.
↳ current_spend	Google\Type\Money Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to date.
↳ create_time	Google\Protobuf\Timestamp Output only. Timestamp when this DataLabelingJob was created.
↳ update_time	Google\Protobuf\Timestamp Output only. Timestamp when this DataLabelingJob was updated most recently.
↳ error	Google\Rpc\Status Output only. DataLabelingJob errors. It is only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
↳ labels	array|Google\Protobuf\Internal\MapField 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.
↳ specialist_pools	array The SpecialistPools' resource names associated with this job.
↳ encryption_spec	Google\Cloud\AIPlatform\V1\EncryptionSpec Customer-managed encryption key spec for a DataLabelingJob. If set, this DataLabelingJob will be secured by this key. Note: Annotations created in the DataLabelingJob are associated with the EncryptionSpec of the Dataset they are exported to.
↳ active_learning_config	Google\Cloud\AIPlatform\V1\ActiveLearningConfig Parameters that configure the active learning pipeline. Active learning will label the data incrementally via several iterations. For every iteration, it will select a batch of data based on the sampling strategy.

getName

Output only. Resource name of the DataLabelingJob.

Returns
Type	Description
string

setName

Output only. Resource name of the DataLabelingJob.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDisplayName

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.

Returns
Type	Description
string

setDisplayName

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDatasets

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

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setDatasets

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

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getAnnotationLabels

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.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setAnnotationLabels

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.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getLabelerCount

Required. Number of labelers to work on each DataItem.

Returns
Type	Description
int

setLabelerCount

Required. Number of labelers to work on each DataItem.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getInstructionUri

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.

Returns
Type	Description
string

setInstructionUri

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getInputsSchemaUri

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.

Returns
Type	Description
string

setInputsSchemaUri

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getInputs

Required. Input config parameters for the DataLabelingJob.

Returns
Type	Description
Google\Protobuf\Value|null

hasInputs

clearInputs

setInputs

Required. Input config parameters for the DataLabelingJob.

Parameter
Name	Description
var	Google\Protobuf\Value

Returns
Type	Description
$this

getState

Output only. The detailed state of the job.

Returns
Type	Description
int

setState

Output only. The detailed state of the job.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getLabelingProgress

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

Returns
Type	Description
int

setLabelingProgress

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

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getCurrentSpend

Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to date.

Returns
Type	Description
Google\Type\Money|null

hasCurrentSpend

clearCurrentSpend

setCurrentSpend

Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to date.

Parameter
Name	Description
var	Google\Type\Money

Returns
Type	Description
$this

getCreateTime

Output only. Timestamp when this DataLabelingJob was created.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this DataLabelingJob was created.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

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

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getError

Output only. DataLabelingJob errors. It is only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

Returns
Type	Description
Google\Rpc\Status|null

hasError

clearError

setError

Output only. DataLabelingJob errors. It is only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

Parameter
Name	Description
var	Google\Rpc\Status

Returns
Type	Description
$this

getLabels

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.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setLabels

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.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getSpecialistPools

The SpecialistPools' resource names associated with this job.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setSpecialistPools

The SpecialistPools' resource names associated with this job.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getEncryptionSpec

Customer-managed encryption key spec for a DataLabelingJob. If set, this DataLabelingJob will be secured by this key.

Note: Annotations created in the DataLabelingJob are associated with the EncryptionSpec of the Dataset they are exported to.

Returns
Type	Description
Google\Cloud\AIPlatform\V1\EncryptionSpec|null

hasEncryptionSpec

clearEncryptionSpec

setEncryptionSpec

Customer-managed encryption key spec for a DataLabelingJob. If set, this DataLabelingJob will be secured by this key.

Note: Annotations created in the DataLabelingJob are associated with the EncryptionSpec of the Dataset they are exported to.

Parameter
Name	Description
var	Google\Cloud\AIPlatform\V1\EncryptionSpec

Returns
Type	Description
$this

getActiveLearningConfig

Parameters that configure the active learning pipeline. Active learning will label the data incrementally via several iterations. For every iteration, it will select a batch of data based on the sampling strategy.

Returns
Type	Description
Google\Cloud\AIPlatform\V1\ActiveLearningConfig|null

hasActiveLearningConfig

clearActiveLearningConfig

setActiveLearningConfig

Parameters that configure the active learning pipeline. Active learning will label the data incrementally via several iterations. For every iteration, it will select a batch of data based on the sampling strategy.

Parameter
Name	Description
var	Google\Cloud\AIPlatform\V1\ActiveLearningConfig

Returns
Type	Description
$this