Class: Google::Apis::DatalabelingV1beta1::GoogleCloudDatalabelingV1beta1HumanAnnotationConfig

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

Overview

Configuration for how human labeling task should be done.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatalabelingV1beta1HumanAnnotationConfig

Returns a new instance of GoogleCloudDatalabelingV1beta1HumanAnnotationConfig.



2508
2509
2510
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 2508

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

Instance Attribute Details

#annotated_dataset_description ⇒ String

Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long. Corresponds to the JSON property annotatedDatasetDescription

Returns:

  • (String) 


2455
2456
2457
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 2455

def annotated_dataset_description
  @annotated_dataset_description
end

#annotated_dataset_display_name ⇒ String

Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters . Corresponds to the JSON property annotatedDatasetDisplayName

Returns:

  • (String) 


2461
2462
2463
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 2461

def annotated_dataset_display_name
  @annotated_dataset_display_name
end

#contributor_emails ⇒ Array<String>

Optional. If you want your own labeling contributors to manage and work on this labeling request, you can set these contributors here. We will give them access to the question types in crowdcompute. Note that these emails must be registered in crowdcompute worker UI: https://crowd-compute.appspot.com/ Corresponds to the JSON property contributorEmails

Returns:

  • (Array<String>) 


2469
2470
2471
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 2469

def contributor_emails
  @contributor_emails
end

#instruction ⇒ String

Required. Instruction resource name. Corresponds to the JSON property instruction

Returns:

  • (String) 


2474
2475
2476
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 2474

def instruction
  @instruction
end

#label_group ⇒ String

Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression [a-zA-Z\\d_-]0,128`. Corresponds to the JSON propertylabelGroup`

Returns:

  • (String) 


2480
2481
2482
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 2480

def label_group
  @label_group
end

#language_code ⇒ String

Optional. The Language of this question, as a BCP-47. Default value is en-US. Only need to set this when task is language related. For example, French text classification. Corresponds to the JSON property languageCode

Returns:

  • (String) 


2487
2488
2489
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 2487

def language_code
  @language_code
end

#question_duration ⇒ String

Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds. Corresponds to the JSON property questionDuration

Returns:

  • (String) 


2493
2494
2495
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 2493

def question_duration
  @question_duration
end

#replica_count ⇒ Fixnum

Optional. Replication of questions. Each question will be sent to up to this number of contributors to label. Aggregated answers will be returned. Default is set to 1. For image related labeling, valid values are 1, 3, 5. Corresponds to the JSON property replicaCount

Returns:

  • (Fixnum) 


2500
2501
2502
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 2500

def replica_count
  @replica_count
end

#user_email_address ⇒ String

Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent. Corresponds to the JSON property userEmailAddress

Returns:

  • (String) 


2506
2507
2508
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 2506

def user_email_address
  @user_email_address
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 2513

def update!(**args)
  @annotated_dataset_description = args[:annotated_dataset_description] if args.key?(:annotated_dataset_description)
  @annotated_dataset_display_name = args[:annotated_dataset_display_name] if args.key?(:annotated_dataset_display_name)
  @contributor_emails = args[:contributor_emails] if args.key?(:contributor_emails)
  @instruction = args[:instruction] if args.key?(:instruction)
  @label_group = args[:label_group] if args.key?(:label_group)
  @language_code = args[:language_code] if args.key?(:language_code)
  @question_duration = args[:question_duration] if args.key?(:question_duration)
  @replica_count = args[:replica_count] if args.key?(:replica_count)
  @user_email_address = args[:user_email_address] if args.key?(:user_email_address)
end