Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentTrainingPhrase

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 example that the agent is trained on.

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

Returns a new instance of GoogleCloudDialogflowV2IntentTrainingPhrase



1759
1760
1761
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 1759

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

Instance Attribute Details

#name ⇒ String

Output only. The unique identifier of this training phrase. Corresponds to the JSON property name

Returns:

  • (String) 


1727
1728
1729
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 1727

def name
  @name
end

#parts ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentTrainingPhrasePart>

Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways:

  • Part.text is set to a part of the phrase that has no parameters.
  • Part.text is set to a part of the phrase that you want to annotate, and the entity_type, alias, and user_defined fields are all set. Corresponds to the JSON property parts

Returns:



1745
1746
1747
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 1745

def parts
  @parts
end

#times_added_count ⇒ Fixnum

Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased. Corresponds to the JSON property timesAddedCount

Returns:

  • (Fixnum) 


1752
1753
1754
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 1752

def times_added_count
  @times_added_count
end

#type ⇒ String

Required. The type of the training phrase. Corresponds to the JSON property type

Returns:

  • (String) 


1757
1758
1759
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 1757

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1764
1765
1766
1767
1768
1769
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 1764

def update!(**args)
  @name = args[:name] if args.key?(:name)
  @parts = args[:parts] if args.key?(:parts)
  @times_added_count = args[:times_added_count] if args.key?(:times_added_count)
  @type = args[:type] if args.key?(:type)
end