Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/representations.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.
Instance Attribute Summary collapse
-
#description ⇒ String
Human readable description for better understanding an intent like its scope, content, result etc.
-
#display_name ⇒ String
Required.
-
#is_fallback ⇒ Boolean
(also: #is_fallback?)
Indicates whether this is a fallback intent.
-
#labels ⇒ Hash<String,String>
The key/value metadata to label an intent.
-
#name ⇒ String
The unique identifier of the intent.
-
#parameters ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3IntentParameter>
The collection of parameters associated with the intent.
-
#priority ⇒ Fixnum
The priority of this intent.
-
#training_phrases ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3IntentTrainingPhrase>
The collection of training phrases the agent is trained on to identify the intent.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Intent
constructor
A new instance of GoogleCloudDialogflowCxV3Intent.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Intent
Returns a new instance of GoogleCloudDialogflowCxV3Intent.
4017 4018 4019 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4017 def initialize(**args) update!(**args) end |
Instance Attribute Details
#description ⇒ String
Human readable description for better understanding an intent like its scope,
content, result etc. Maximum character limit: 140 characters.
Corresponds to the JSON property description
3961 3962 3963 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3961 def description @description end |
#display_name ⇒ String
Required. The human-readable name of the intent, unique within the agent.
Corresponds to the JSON property displayName
3966 3967 3968 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3966 def display_name @display_name end |
#is_fallback ⇒ Boolean Also known as: is_fallback?
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.
Corresponds to the JSON property isFallback
3975 3976 3977 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3975 def is_fallback @is_fallback end |
#labels ⇒ Hash<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.
Corresponds to the JSON property labels
3988 3989 3990 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3988 def labels @labels end |
#name ⇒ String
The unique identifier of the intent. Required for the Intents.UpdateIntent
method. Intents.CreateIntent populates the name automatically. Format:
projects//locations//agents//intents/
.
Corresponds to the JSON property name
3995 3996 3997 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3995 def name @name end |
#parameters ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3IntentParameter>
The collection of parameters associated with the intent.
Corresponds to the JSON property parameters
4000 4001 4002 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4000 def parameters @parameters end |
#priority ⇒ Fixnum
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.
Corresponds to the JSON property priority
4009 4010 4011 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4009 def priority @priority end |
#training_phrases ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3IntentTrainingPhrase>
The collection of training phrases the agent is trained on to identify the
intent.
Corresponds to the JSON property trainingPhrases
4015 4016 4017 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4015 def training_phrases @training_phrases end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4022 def update!(**args) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @is_fallback = args[:is_fallback] if args.key?(:is_fallback) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @parameters = args[:parameters] if args.key?(:parameters) @priority = args[:priority] if args.key?(:priority) @training_phrases = args[:training_phrases] if args.key?(:training_phrases) end |