Class: Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/cx/v3/intent.rb

Overview

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

Defined Under Namespace

Classes: Part

Instance Attribute Summary collapse

Instance Attribute Details

#id ⇒ ::String

Returns Output only. The unique identifier of the training phrase.

Returns:

  • (::String) —

    Output only. The unique identifier of the training phrase.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/intent.rb', line 119

class TrainingPhrase
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents a part of a training phrase.
  # @!attribute [rw] text
  #   @return [::String]
  #     Required. The text for this part.
  # @!attribute [rw] parameter_id
  #   @return [::String]
  #     The {::Google::Cloud::Dialogflow::CX::V3::Intent::Parameter parameter} used to
  #     annotate this part of the training phrase. This field is required for
  #     annotated parts of the training phrase.
  class Part
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#parts ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part>

Returns 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.


119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/intent.rb', line 119

class TrainingPhrase
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents a part of a training phrase.
  # @!attribute [rw] text
  #   @return [::String]
  #     Required. The text for this part.
  # @!attribute [rw] parameter_id
  #   @return [::String]
  #     The {::Google::Cloud::Dialogflow::CX::V3::Intent::Parameter parameter} used to
  #     annotate this part of the training phrase. This field is required for
  #     annotated parts of the training phrase.
  class Part
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#repeat_count ⇒ ::Integer

Returns Indicates how many times this example was added to the intent.

Returns:

  • (::Integer) —

    Indicates how many times this example was added to the intent.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/intent.rb', line 119

class TrainingPhrase
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents a part of a training phrase.
  # @!attribute [rw] text
  #   @return [::String]
  #     Required. The text for this part.
  # @!attribute [rw] parameter_id
  #   @return [::String]
  #     The {::Google::Cloud::Dialogflow::CX::V3::Intent::Parameter parameter} used to
  #     annotate this part of the training phrase. This field is required for
  #     annotated parts of the training phrase.
  class Part
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end