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.



2329
2330
2331
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2329

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

Instance Attribute Details

#nameString

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

Returns:

  • (String)


2297
2298
2299
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2297

def name
  @name
end

#partsArray<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


2315
2316
2317
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2315

def parts
  @parts
end

#times_added_countFixnum

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)


2322
2323
2324
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2322

def times_added_count
  @times_added_count
end

#typeString

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

Returns:

  • (String)


2327
2328
2329
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2327

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2334
2335
2336
2337
2338
2339
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2334

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