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

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

An intent represents a user's intent to interact with a conversational agent.

You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.

Defined Under Namespace

Classes: LabelsEntry, Parameter, TrainingPhrase

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ ::String

Returns Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.

Returns:

  • (::String) —

    Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/intent.rb', line 86

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

  # Represents an example that the agent is trained on to identify the intent.
  # @!attribute [rw] id
  #   @return [::String]
  #     Output only. The unique identifier of the training phrase.
  # @!attribute [rw] parts
  #   @return [::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
  #     {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part#text 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.
  # @!attribute [rw] repeat_count
  #   @return [::Integer]
  #     Indicates how many times this example was added to the intent.
  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

  # Represents an intent parameter.
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. The unique identifier of the parameter. This field
  #     is used by [training
  #     phrases][google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase] to annotate
  #     their {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part parts}.
  # @!attribute [rw] entity_type
  #   @return [::String]
  #     Required. The entity type of the parameter.
  #     Format:
  #     `projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID>` for
  #     system entity types (for example,
  #     `projects/-/locations/-/agents/-/entityTypes/sys.date`), or
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`
  #     for developer entity types.
  # @!attribute [rw] is_list
  #   @return [::Boolean]
  #     Indicates whether the parameter represents a list of values.
  # @!attribute [rw] redact
  #   @return [::Boolean]
  #     Indicates whether the parameter content should be redacted in log. If
  #     redaction is enabled, the parameter content will be replaced by parameter
  #     name during logging.
  #     Note: the parameter content is subject to redaction if either parameter
  #     level redaction or [entity type level
  #     redaction][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Required. The human-readable name of the intent, unique within the agent.

Returns:

  • (::String) —

    Required. The human-readable name of the intent, unique within the agent.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/intent.rb', line 86

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

  # Represents an example that the agent is trained on to identify the intent.
  # @!attribute [rw] id
  #   @return [::String]
  #     Output only. The unique identifier of the training phrase.
  # @!attribute [rw] parts
  #   @return [::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
  #     {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part#text 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.
  # @!attribute [rw] repeat_count
  #   @return [::Integer]
  #     Indicates how many times this example was added to the intent.
  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

  # Represents an intent parameter.
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. The unique identifier of the parameter. This field
  #     is used by [training
  #     phrases][google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase] to annotate
  #     their {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part parts}.
  # @!attribute [rw] entity_type
  #   @return [::String]
  #     Required. The entity type of the parameter.
  #     Format:
  #     `projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID>` for
  #     system entity types (for example,
  #     `projects/-/locations/-/agents/-/entityTypes/sys.date`), or
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`
  #     for developer entity types.
  # @!attribute [rw] is_list
  #   @return [::Boolean]
  #     Indicates whether the parameter represents a list of values.
  # @!attribute [rw] redact
  #   @return [::Boolean]
  #     Indicates whether the parameter content should be redacted in log. If
  #     redaction is enabled, the parameter content will be replaced by parameter
  #     name during logging.
  #     Note: the parameter content is subject to redaction if either parameter
  #     level redaction or [entity type level
  #     redaction][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#is_fallback ⇒ ::Boolean

Returns Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.

Returns:

  • (::Boolean) —

    Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/intent.rb', line 86

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

  # Represents an example that the agent is trained on to identify the intent.
  # @!attribute [rw] id
  #   @return [::String]
  #     Output only. The unique identifier of the training phrase.
  # @!attribute [rw] parts
  #   @return [::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
  #     {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part#text 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.
  # @!attribute [rw] repeat_count
  #   @return [::Integer]
  #     Indicates how many times this example was added to the intent.
  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

  # Represents an intent parameter.
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. The unique identifier of the parameter. This field
  #     is used by [training
  #     phrases][google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase] to annotate
  #     their {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part parts}.
  # @!attribute [rw] entity_type
  #   @return [::String]
  #     Required. The entity type of the parameter.
  #     Format:
  #     `projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID>` for
  #     system entity types (for example,
  #     `projects/-/locations/-/agents/-/entityTypes/sys.date`), or
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`
  #     for developer entity types.
  # @!attribute [rw] is_list
  #   @return [::Boolean]
  #     Indicates whether the parameter represents a list of values.
  # @!attribute [rw] redact
  #   @return [::Boolean]
  #     Indicates whether the parameter content should be redacted in log. If
  #     redaction is enabled, the parameter content will be replaced by parameter
  #     name during logging.
  #     Note: the parameter content is subject to redaction if either parameter
  #     level redaction or [entity type level
  #     redaction][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes.

Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include:

  • sys-head
  • sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes.

    Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include:

    • sys-head
    • sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent.


86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/intent.rb', line 86

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

  # Represents an example that the agent is trained on to identify the intent.
  # @!attribute [rw] id
  #   @return [::String]
  #     Output only. The unique identifier of the training phrase.
  # @!attribute [rw] parts
  #   @return [::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
  #     {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part#text 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.
  # @!attribute [rw] repeat_count
  #   @return [::Integer]
  #     Indicates how many times this example was added to the intent.
  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

  # Represents an intent parameter.
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. The unique identifier of the parameter. This field
  #     is used by [training
  #     phrases][google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase] to annotate
  #     their {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part parts}.
  # @!attribute [rw] entity_type
  #   @return [::String]
  #     Required. The entity type of the parameter.
  #     Format:
  #     `projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID>` for
  #     system entity types (for example,
  #     `projects/-/locations/-/agents/-/entityTypes/sys.date`), or
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`
  #     for developer entity types.
  # @!attribute [rw] is_list
  #   @return [::Boolean]
  #     Indicates whether the parameter represents a list of values.
  # @!attribute [rw] redact
  #   @return [::Boolean]
  #     Indicates whether the parameter content should be redacted in log. If
  #     redaction is enabled, the parameter content will be replaced by parameter
  #     name during logging.
  #     Note: the parameter content is subject to redaction if either parameter
  #     level redaction or [entity type level
  #     redaction][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>.

Returns:

  • (::String) —

    The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/intent.rb', line 86

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

  # Represents an example that the agent is trained on to identify the intent.
  # @!attribute [rw] id
  #   @return [::String]
  #     Output only. The unique identifier of the training phrase.
  # @!attribute [rw] parts
  #   @return [::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
  #     {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part#text 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.
  # @!attribute [rw] repeat_count
  #   @return [::Integer]
  #     Indicates how many times this example was added to the intent.
  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

  # Represents an intent parameter.
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. The unique identifier of the parameter. This field
  #     is used by [training
  #     phrases][google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase] to annotate
  #     their {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part parts}.
  # @!attribute [rw] entity_type
  #   @return [::String]
  #     Required. The entity type of the parameter.
  #     Format:
  #     `projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID>` for
  #     system entity types (for example,
  #     `projects/-/locations/-/agents/-/entityTypes/sys.date`), or
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`
  #     for developer entity types.
  # @!attribute [rw] is_list
  #   @return [::Boolean]
  #     Indicates whether the parameter represents a list of values.
  # @!attribute [rw] redact
  #   @return [::Boolean]
  #     Indicates whether the parameter content should be redacted in log. If
  #     redaction is enabled, the parameter content will be replaced by parameter
  #     name during logging.
  #     Note: the parameter content is subject to redaction if either parameter
  #     level redaction or [entity type level
  #     redaction][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#parameters ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::Intent::Parameter>

Returns The collection of parameters associated with the intent.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/intent.rb', line 86

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

  # Represents an example that the agent is trained on to identify the intent.
  # @!attribute [rw] id
  #   @return [::String]
  #     Output only. The unique identifier of the training phrase.
  # @!attribute [rw] parts
  #   @return [::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
  #     {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part#text 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.
  # @!attribute [rw] repeat_count
  #   @return [::Integer]
  #     Indicates how many times this example was added to the intent.
  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

  # Represents an intent parameter.
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. The unique identifier of the parameter. This field
  #     is used by [training
  #     phrases][google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase] to annotate
  #     their {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part parts}.
  # @!attribute [rw] entity_type
  #   @return [::String]
  #     Required. The entity type of the parameter.
  #     Format:
  #     `projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID>` for
  #     system entity types (for example,
  #     `projects/-/locations/-/agents/-/entityTypes/sys.date`), or
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`
  #     for developer entity types.
  # @!attribute [rw] is_list
  #   @return [::Boolean]
  #     Indicates whether the parameter represents a list of values.
  # @!attribute [rw] redact
  #   @return [::Boolean]
  #     Indicates whether the parameter content should be redacted in log. If
  #     redaction is enabled, the parameter content will be replaced by parameter
  #     name during logging.
  #     Note: the parameter content is subject to redaction if either parameter
  #     level redaction or [entity type level
  #     redaction][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#priority ⇒ ::Integer

Returns The priority of this intent. Higher numbers represent higher priorities.

  • If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console.
  • If the supplied value is negative, the intent is ignored in runtime detect intent requests.

Returns:

  • (::Integer) —

    The priority of this intent. Higher numbers represent higher priorities.

    • If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console.
    • If the supplied value is negative, the intent is ignored in runtime detect intent requests.


86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/intent.rb', line 86

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

  # Represents an example that the agent is trained on to identify the intent.
  # @!attribute [rw] id
  #   @return [::String]
  #     Output only. The unique identifier of the training phrase.
  # @!attribute [rw] parts
  #   @return [::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
  #     {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part#text 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.
  # @!attribute [rw] repeat_count
  #   @return [::Integer]
  #     Indicates how many times this example was added to the intent.
  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

  # Represents an intent parameter.
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. The unique identifier of the parameter. This field
  #     is used by [training
  #     phrases][google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase] to annotate
  #     their {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part parts}.
  # @!attribute [rw] entity_type
  #   @return [::String]
  #     Required. The entity type of the parameter.
  #     Format:
  #     `projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID>` for
  #     system entity types (for example,
  #     `projects/-/locations/-/agents/-/entityTypes/sys.date`), or
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`
  #     for developer entity types.
  # @!attribute [rw] is_list
  #   @return [::Boolean]
  #     Indicates whether the parameter represents a list of values.
  # @!attribute [rw] redact
  #   @return [::Boolean]
  #     Indicates whether the parameter content should be redacted in log. If
  #     redaction is enabled, the parameter content will be replaced by parameter
  #     name during logging.
  #     Note: the parameter content is subject to redaction if either parameter
  #     level redaction or [entity type level
  #     redaction][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns The collection of training phrases the agent is trained on to identify the intent.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/intent.rb', line 86

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

  # Represents an example that the agent is trained on to identify the intent.
  # @!attribute [rw] id
  #   @return [::String]
  #     Output only. The unique identifier of the training phrase.
  # @!attribute [rw] parts
  #   @return [::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
  #     {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part#text 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.
  # @!attribute [rw] repeat_count
  #   @return [::Integer]
  #     Indicates how many times this example was added to the intent.
  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

  # Represents an intent parameter.
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. The unique identifier of the parameter. This field
  #     is used by [training
  #     phrases][google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase] to annotate
  #     their {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part parts}.
  # @!attribute [rw] entity_type
  #   @return [::String]
  #     Required. The entity type of the parameter.
  #     Format:
  #     `projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID>` for
  #     system entity types (for example,
  #     `projects/-/locations/-/agents/-/entityTypes/sys.date`), or
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`
  #     for developer entity types.
  # @!attribute [rw] is_list
  #   @return [::Boolean]
  #     Indicates whether the parameter represents a list of values.
  # @!attribute [rw] redact
  #   @return [::Boolean]
  #     Indicates whether the parameter content should be redacted in log. If
  #     redaction is enabled, the parameter content will be replaced by parameter
  #     name during logging.
  #     Note: the parameter content is subject to redaction if either parameter
  #     level redaction or [entity type level
  #     redaction][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end