Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase (v0.17.0)

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

Represents an example that the agent is trained on to identify the intent.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#id

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

#id=

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

#parts

def parts() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part>
Returns
  • (::Array<::Google::Cloud::Dialogflow::CX::V3::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 parameter_id field is set.

#parts=

def parts=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part>
Parameter
  • value (::Array<::Google::Cloud::Dialogflow::CX::V3::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 parameter_id field is set.
Returns
  • (::Array<::Google::Cloud::Dialogflow::CX::V3::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 parameter_id field is set.

#repeat_count

def repeat_count() -> ::Integer
Returns
  • (::Integer) — Indicates how many times this example was added to the intent.

#repeat_count=

def repeat_count=(value) -> ::Integer
Parameter
  • value (::Integer) — Indicates how many times this example was added to the intent.
Returns
  • (::Integer) — Indicates how many times this example was added to the intent.