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
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: |
↳ 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 |
↳ 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.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Resource name of the DataLabelingJob.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| 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}
Generated from protobuf field repeated string datasets = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| 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}
Generated from protobuf field repeated string datasets = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| 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.
Generated from protobuf field map<string, string> annotation_labels = 12;
| 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.
Generated from protobuf field map<string, string> annotation_labels = 12;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabelerCount
Required. Number of labelers to work on each DataItem.
Generated from protobuf field int32 labeler_count = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int | |
setLabelerCount
Required. Number of labelers to work on each DataItem.
Generated from protobuf field int32 labeler_count = 4 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field string instruction_uri = 5 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field string instruction_uri = 5 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field string inputs_schema_uri = 6 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field string inputs_schema_uri = 6 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInputs
Required. Input config parameters for the DataLabelingJob.
Generated from protobuf field .google.protobuf.Value inputs = 7 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Value|null | |
hasInputs
clearInputs
setInputs
Required. Input config parameters for the DataLabelingJob.
Generated from protobuf field .google.protobuf.Value inputs = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Value
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The detailed state of the job.
Generated from protobuf field .google.cloud.aiplatform.v1.JobState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The detailed state of the job.
Generated from protobuf field .google.cloud.aiplatform.v1.JobState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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.
Generated from protobuf field int32 labeling_progress = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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.
Generated from protobuf field int32 labeling_progress = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCurrentSpend
Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to date.
Generated from protobuf field .google.type.Money current_spend = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Type\Money|null | |
hasCurrentSpend
clearCurrentSpend
setCurrentSpend
Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to date.
Generated from protobuf field .google.type.Money current_spend = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\Money
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Timestamp when this DataLabelingJob was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this DataLabelingJob was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Timestamp when this DataLabelingJob was updated most recently.
Generated from protobuf field .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this DataLabelingJob was updated most recently.
Generated from protobuf field .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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.
Generated from protobuf field .google.rpc.Status error = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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.
Generated from protobuf field .google.rpc.Status error = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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.
Generated from protobuf field map<string, string> labels = 11;
| 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.
Generated from protobuf field map<string, string> labels = 11;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSpecialistPools
The SpecialistPools' resource names associated with this job.
Generated from protobuf field repeated string specialist_pools = 16;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setSpecialistPools
The SpecialistPools' resource names associated with this job.
Generated from protobuf field repeated string specialist_pools = 16;
| 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.
Generated from protobuf field .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 20;
| 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.
Generated from protobuf field .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 20;
| 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.
Generated from protobuf field .google.cloud.aiplatform.v1.ActiveLearningConfig active_learning_config = 21;
| 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.
Generated from protobuf field .google.cloud.aiplatform.v1.ActiveLearningConfig active_learning_config = 21;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\ActiveLearningConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |