Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1AnnotatedConversationDataset

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

Overview

Represents an annotated conversation dataset. ConversationDataset can have multiple AnnotatedConversationDataset, each of them represents one result from one annotation task. AnnotatedConversationDataset can only be generated from annotation task, which will be triggered by LabelConversation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1AnnotatedConversationDataset

Returns a new instance of GoogleCloudDialogflowV2beta1AnnotatedConversationDataset



2733
2734
2735
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2733

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

Instance Attribute Details

#completed_example_countFixnum

Output only. Number of examples that have annotations in the annotated conversation dataset. Corresponds to the JSON property completedExampleCount

Returns:

  • (Fixnum)


2694
2695
2696
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2694

def completed_example_count
  @completed_example_count
end

#create_timeString

Output only. Creation time of this annotated conversation dataset. Corresponds to the JSON property createTime

Returns:

  • (String)


2699
2700
2701
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2699

def create_time
  @create_time
end

#descriptionString

Optional. The description of the annotated conversation dataset. Maximum of 10000 bytes. Corresponds to the JSON property description

Returns:

  • (String)


2705
2706
2707
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2705

def description
  @description
end

#display_nameString

Required. The display name of the annotated conversation dataset. It's specified when user starts an annotation task. Maximum of 64 bytes. Corresponds to the JSON property displayName

Returns:

  • (String)


2711
2712
2713
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2711

def display_name
  @display_name
end

#example_countFixnum

Output only. Number of examples in the annotated conversation dataset. Corresponds to the JSON property exampleCount

Returns:

  • (Fixnum)


2716
2717
2718
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2716

def example_count
  @example_count
end

#nameString

Output only. AnnotatedConversationDataset resource name. Format: projects/<Project ID>/conversationDatasets/<Conversation Dataset ID>/annotatedConversationDatasets/<Annotated Conversation Dataset ID> Corresponds to the JSON property name

Returns:

  • (String)


2723
2724
2725
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2723

def name
  @name
end

#question_type_nameString

Output only. Question type name that identifies a labeling task. A question is a single task that a worker answers. A question type is set of related questions. Each question belongs to a particular question type. It can be used in CrowdCompute UI to filter and manage labeling tasks. Corresponds to the JSON property questionTypeName

Returns:

  • (String)


2731
2732
2733
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2731

def question_type_name
  @question_type_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2738
2739
2740
2741
2742
2743
2744
2745
2746
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2738

def update!(**args)
  @completed_example_count = args[:completed_example_count] if args.key?(:completed_example_count)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @example_count = args[:example_count] if args.key?(:example_count)
  @name = args[:name] if args.key?(:name)
  @question_type_name = args[:question_type_name] if args.key?(:question_type_name)
end