Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::DataLabelingJob (v0.47.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
Returns
  • (::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
Parameter
  • 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.
Returns
  • (::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}
Returns
  • (::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}
Parameter
  • 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.

Returns
  • (::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
Returns

#current_spend

def current_spend() -> ::Google::Type::Money
Returns
  • (::Google::Type::Money) — Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to date.

#datasets

def datasets() -> ::Array<::String>
Returns
  • (::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>
Parameter
  • value (::Array<::String>) — Required. Dataset resource names. Right now we only support labeling from a single Dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}
Returns
  • (::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
Returns
  • (::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.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#encryption_spec

def encryption_spec() -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec
Returns
  • (::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
Parameter
  • 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.

Returns
  • (::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
Returns
  • (::Google::Rpc::Status) — Output only. DataLabelingJob errors. It is only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

#inputs

def inputs() -> ::Google::Protobuf::Value
Returns

#inputs=

def inputs=(value) -> ::Google::Protobuf::Value
Parameter
Returns

#inputs_schema_uri

def inputs_schema_uri() -> ::String
Returns
  • (::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
Parameter
  • 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.
Returns
  • (::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
Returns
  • (::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
Parameter
  • 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.
Returns
  • (::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
Returns
  • (::Integer) — Required. Number of labelers to work on each DataItem.

#labeler_count=

def labeler_count=(value) -> ::Integer
Parameter
  • value (::Integer) — Required. Number of labelers to work on each DataItem.
Returns
  • (::Integer) — Required. Number of labelers to work on each DataItem.

#labeling_progress

def labeling_progress() -> ::Integer
Returns
  • (::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}
Returns
  • (::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}
Parameter
  • 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.
Returns
  • (::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
Returns
  • (::String) — Output only. Resource name of the DataLabelingJob.

#specialist_pools

def specialist_pools() -> ::Array<::String>
Returns
  • (::Array<::String>) — The SpecialistPools' resource names associated with this job.

#specialist_pools=

def specialist_pools=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — The SpecialistPools' resource names associated with this job.
Returns
  • (::Array<::String>) — The SpecialistPools' resource names associated with this job.

#state

def state() -> ::Google::Cloud::AIPlatform::V1::JobState
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns