Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DataLabelingJob

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/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) ⇒ GoogleCloudAiplatformV1DataLabelingJob

Returns a new instance of GoogleCloudAiplatformV1DataLabelingJob.



4346
4347
4348
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4346

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

Instance Attribute Details

#active_learning_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ActiveLearningConfig

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:



4231
4232
4233
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4231

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>) 


4241
4242
4243
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4241

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) 


4246
4247
4248
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4246

def create_time
  @create_time
end

#current_spend ⇒ Google::Apis::AiplatformV1::GoogleTypeMoney

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

Returns:



4251
4252
4253
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4251

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>) 


4258
4259
4260
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4258

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) 


4265
4266
4267
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4265

def display_name
  @display_name
end

#encryption_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EncryptionSpec

Represents a customer-managed encryption key spec that can be applied to a top- level resource. Corresponds to the JSON property encryptionSpec

Returns:



4271
4272
4273
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4271

def encryption_spec
  @encryption_spec
end

#error ⇒ Google::Apis::AiplatformV1::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:



4281
4282
4283
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4281

def error
  @error
end

#inputs ⇒ Object

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

Returns:

  • (Object) 


4286
4287
4288
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4286

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) 


4294
4295
4296
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4294

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) 


4301
4302
4303
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4301

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) 


4306
4307
4308
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4306

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) 


4312
4313
4314
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4312

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>) 


4324
4325
4326
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4324

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


4329
4330
4331
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4329

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>) 


4334
4335
4336
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4334

def specialist_pools
  @specialist_pools
end

#state ⇒ String

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

Returns:

  • (String) 


4339
4340
4341
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4339

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) 


4344
4345
4346
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4344

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4351

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