- 0.53.0 (latest)
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 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.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::DataLabelingJob.
DataLabelingJob is used to trigger a human labeling job on unlabeled data from the following Dataset:
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#active_learning_config
def active_learning_config() -> ::Google::Cloud::AIPlatform::V1::ActiveLearningConfig
- (::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.
#active_learning_config=
def active_learning_config=(value) -> ::Google::Cloud::AIPlatform::V1::ActiveLearningConfig
- value (::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.
- (::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.
#annotation_labels
def annotation_labels() -> ::Google::Protobuf::Map{::String => ::String}
-
(::Google::Protobuf::Map{::String => ::String}) — 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.
#annotation_labels=
def annotation_labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::Map{::String => ::String}) — 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.
-
(::Google::Protobuf::Map{::String => ::String}) — 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.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. Timestamp when this DataLabelingJob was created.
#current_spend
def current_spend() -> ::Google::Type::Money
- (::Google::Type::Money) — Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to date.
#datasets
def datasets() -> ::Array<::String>
-
(::Array<::String>) — Required. Dataset resource names. Right now we only support labeling from a single
Dataset.
Format:
projects/{project}/locations/{location}/datasets/{dataset}
#datasets=
def datasets=(value) -> ::Array<::String>
-
value (::Array<::String>) — Required. Dataset resource names. Right now we only support labeling from a single
Dataset.
Format:
projects/{project}/locations/{location}/datasets/{dataset}
-
(::Array<::String>) — Required. Dataset resource names. Right now we only support labeling from a single
Dataset.
Format:
projects/{project}/locations/{location}/datasets/{dataset}
#display_name
def display_name() -> ::String
- (::String) — Required. The user-defined name of the DataLabelingJob. The name can be up to 128 characters long and can be consist of any UTF-8 characters. Display name of a DataLabelingJob.
#display_name=
def display_name=(value) -> ::String
- value (::String) — Required. The user-defined name of the DataLabelingJob. The name can be up to 128 characters long and can be consist of any UTF-8 characters. Display name of a DataLabelingJob.
- (::String) — Required. The user-defined name of the DataLabelingJob. The name can be up to 128 characters long and can be consist of any UTF-8 characters. Display name of a DataLabelingJob.
#encryption_spec
def encryption_spec() -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec
-
(::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.
#encryption_spec=
def encryption_spec=(value) -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec
-
value (::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.
-
(::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.
#error
def error() -> ::Google::Rpc::Status
-
(::Google::Rpc::Status) — Output only. DataLabelingJob errors. It is only populated when job's state is
JOB_STATE_FAILED
orJOB_STATE_CANCELLED
.
#inputs
def inputs() -> ::Google::Protobuf::Value
- (::Google::Protobuf::Value) — Required. Input config parameters for the DataLabelingJob.
#inputs=
def inputs=(value) -> ::Google::Protobuf::Value
- value (::Google::Protobuf::Value) — Required. Input config parameters for the DataLabelingJob.
- (::Google::Protobuf::Value) — Required. Input config parameters for the DataLabelingJob.
#inputs_schema_uri
def inputs_schema_uri() -> ::String
- (::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_schema_uri=
def inputs_schema_uri=(value) -> ::String
- value (::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.
- (::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.
#instruction_uri
def instruction_uri() -> ::String
- (::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.
#instruction_uri=
def instruction_uri=(value) -> ::String
- value (::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.
- (::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.
#labeler_count
def labeler_count() -> ::Integer
- (::Integer) — Required. Number of labelers to work on each DataItem.
#labeler_count=
def labeler_count=(value) -> ::Integer
- value (::Integer) — Required. Number of labelers to work on each DataItem.
- (::Integer) — Required. Number of labelers to work on each DataItem.
#labeling_progress
def labeling_progress() -> ::Integer
- (::Integer) — Output only. Current labeling job progress percentage scaled in interval [0, 100], indicating the percentage of DataItems that has been finished.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
-
(::Google::Protobuf::Map{::String => ::String}) —
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.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::Map{::String => ::String}) —
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.
-
(::Google::Protobuf::Map{::String => ::String}) —
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.
#name
def name() -> ::String
- (::String) — Output only. Resource name of the DataLabelingJob.
#specialist_pools
def specialist_pools() -> ::Array<::String>
- (::Array<::String>) — The SpecialistPools' resource names associated with this job.
#specialist_pools=
def specialist_pools=(value) -> ::Array<::String>
- value (::Array<::String>) — The SpecialistPools' resource names associated with this job.
- (::Array<::String>) — The SpecialistPools' resource names associated with this job.
#state
def state() -> ::Google::Cloud::AIPlatform::V1::JobState
- (::Google::Cloud::AIPlatform::V1::JobState) — Output only. The detailed state of the job.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. Timestamp when this DataLabelingJob was updated most recently.