Class: Google::Apis::DatalabelingV1beta1::GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig

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

Returns a new instance of GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig.



4887
4888
4889
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 4887

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) 


4834
4835
4836
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 4834

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) 


4840
4841
4842
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 4840

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


4848
4849
4850
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 4848

def contributor_emails
  @contributor_emails
end

#instruction ⇒ String

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

Returns:

  • (String) 


4853
4854
4855
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 4853

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) 


4859
4860
4861
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 4859

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) 


4866
4867
4868
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 4866

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) 


4872
4873
4874
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 4872

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) 


4879
4880
4881
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 4879

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) 


4885
4886
4887
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 4885

def user_email_address
  @user_email_address
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
 
# File 'lib/google/apis/datalabeling_v1beta1/classes.rb', line 4892

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