Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DataLabelingJob

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1DataLabelingJob

Returns a new instance of GoogleCloudAiplatformV1beta1DataLabelingJob.



13403
13404
13405
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13403

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#active_learning_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ActiveLearningConfig

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. Corresponds to the JSON property activeLearningConfig

Returns:



13288
13289
13290
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13288

def active_learning_config
  @active_learning_config
end

#annotation_labels ⇒ Hash<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. Corresponds to the JSON property annotationLabels

Returns:

  • (Hash<String,String>) 


13298
13299
13300
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13298

def annotation_labels
  @annotation_labels
end

#create_time ⇒ String

Output only. Timestamp when this DataLabelingJob was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


13303
13304
13305
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13303

def create_time
  @create_time
end

#current_spend ⇒ Google::Apis::AiplatformV1beta1::GoogleTypeMoney

Represents an amount of money with its currency type. Corresponds to the JSON property currentSpend

Returns:



13308
13309
13310
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13308

def current_spend
  @current_spend
end

#datasets ⇒ Array<String>

Required. Dataset resource names. Right now we only support labeling from a single Dataset. Format: projects/project/locations/location/datasets/ dataset` Corresponds to the JSON propertydatasets`

Returns:

  • (Array<String>) 


13315
13316
13317
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13315

def datasets
  @datasets
end

#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. Corresponds to the JSON property displayName

Returns:

  • (String) 


13322
13323
13324
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13322

def display_name
  @display_name
end

#encryption_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EncryptionSpec

Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. Corresponds to the JSON property encryptionSpec

Returns:



13328
13329
13330
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13328

def encryption_spec
  @encryption_spec
end

#error ⇒ Google::Apis::AiplatformV1beta1::GoogleRpcStatus

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. Corresponds to the JSON property error

Returns:



13338
13339
13340
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13338

def error
  @error
end

#inputs ⇒ Object

Required. Input config parameters for the DataLabelingJob. Corresponds to the JSON property inputs

Returns:

  • (Object) 


13343
13344
13345
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13343

def inputs
  @inputs
end

#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. Corresponds to the JSON property inputsSchemaUri

Returns:

  • (String) 


13351
13352
13353
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13351

def inputs_schema_uri
  @inputs_schema_uri
end

#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. Corresponds to the JSON property instructionUri

Returns:

  • (String) 


13358
13359
13360
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13358

def instruction_uri
  @instruction_uri
end

#labeler_count ⇒ Fixnum

Required. Number of labelers to work on each DataItem. Corresponds to the JSON property labelerCount

Returns:

  • (Fixnum) 


13363
13364
13365
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13363

def labeler_count
  @labeler_count
end

#labeling_progress ⇒ Fixnum

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

Returns:

  • (Fixnum) 


13369
13370
13371
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13369

def labeling_progress
  @labeling_progress
end

#labels ⇒ Hash<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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


13381
13382
13383
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13381

def labels
  @labels
end

#name ⇒ String

Output only. Resource name of the DataLabelingJob. Corresponds to the JSON property name

Returns:

  • (String) 


13386
13387
13388
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13386

def name
  @name
end

#specialist_pools ⇒ Array<String>

The SpecialistPools' resource names associated with this job. Corresponds to the JSON property specialistPools

Returns:

  • (Array<String>) 


13391
13392
13393
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13391

def specialist_pools
  @specialist_pools
end

#state ⇒ String

Output only. The detailed state of the job. Corresponds to the JSON property state

Returns:

  • (String) 


13396
13397
13398
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13396

def state
  @state
end

#update_time ⇒ String

Output only. Timestamp when this DataLabelingJob was updated most recently. Corresponds to the JSON property updateTime

Returns:

  • (String) 


13401
13402
13403
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13401

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13408

def update!(**args)
  @active_learning_config = args[:active_learning_config] if args.key?(:active_learning_config)
  @annotation_labels = args[:annotation_labels] if args.key?(:annotation_labels)
  @create_time = args[:create_time] if args.key?(:create_time)
  @current_spend = args[:current_spend] if args.key?(:current_spend)
  @datasets = args[:datasets] if args.key?(:datasets)
  @display_name = args[:display_name] if args.key?(:display_name)
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
  @error = args[:error] if args.key?(:error)
  @inputs = args[:inputs] if args.key?(:inputs)
  @inputs_schema_uri = args[:inputs_schema_uri] if args.key?(:inputs_schema_uri)
  @instruction_uri = args[:instruction_uri] if args.key?(:instruction_uri)
  @labeler_count = args[:labeler_count] if args.key?(:labeler_count)
  @labeling_progress = args[:labeling_progress] if args.key?(:labeling_progress)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @specialist_pools = args[:specialist_pools] if args.key?(:specialist_pools)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
end