Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::Intent::TrainingPhrase (v0.25.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::Intent::TrainingPhrase.

Represents an example that the agent is trained on.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#name

def name() -> ::String
Returns
  • (::String) — Output only. The unique identifier of this training phrase.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Output only. The unique identifier of this training phrase.
Returns
  • (::String) — Output only. The unique identifier of this training phrase.

#parts

def parts() -> ::Array<::Google::Cloud::Dialogflow::V2::Intent::TrainingPhrase::Part>
Returns
  • (::Array<::Google::Cloud::Dialogflow::V2::Intent::TrainingPhrase::Part>) —

    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.

#parts=

def parts=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::Intent::TrainingPhrase::Part>
Parameter
  • value (::Array<::Google::Cloud::Dialogflow::V2::Intent::TrainingPhrase::Part>) —

    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.
Returns
  • (::Array<::Google::Cloud::Dialogflow::V2::Intent::TrainingPhrase::Part>) —

    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.

#times_added_count

def times_added_count() -> ::Integer
Returns
  • (::Integer) — 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.

#times_added_count=

def times_added_count=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#type

def type() -> ::Google::Cloud::Dialogflow::V2::Intent::TrainingPhrase::Type
Returns

#type=

def type=(value) -> ::Google::Cloud::Dialogflow::V2::Intent::TrainingPhrase::Type
Parameter
Returns