Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1Intent
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1Intent
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dialogflow_v2/classes.rb,
generated/google/apis/dialogflow_v2/representations.rb,
generated/google/apis/dialogflow_v2/representations.rb
Overview
Represents an intent. Intents convert a number of user expressions or patterns into an action. An action is an extraction of a user command or sentence semantics.
Instance Attribute Summary collapse
-
#action ⇒ String
Optional.
-
#default_response_platforms ⇒ Array<String>
Optional.
-
#display_name ⇒ String
Required.
-
#end_interaction ⇒ Boolean
(also: #end_interaction?)
Optional.
-
#events ⇒ Array<String>
Optional.
-
#followup_intent_info ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo>
Read-only.
-
#input_context_names ⇒ Array<String>
Optional.
-
#is_fallback ⇒ Boolean
(also: #is_fallback?)
Optional.
-
#messages ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessage>
Optional.
-
#ml_disabled ⇒ Boolean
(also: #ml_disabled?)
Optional.
-
#ml_enabled ⇒ Boolean
(also: #ml_enabled?)
Optional.
-
#name ⇒ String
The unique identifier of this intent.
-
#output_contexts ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1Context>
Optional.
-
#parameters ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentParameter>
Optional.
-
#parent_followup_intent_name ⇒ String
Read-only after creation.
-
#priority ⇒ Fixnum
Optional.
-
#reset_contexts ⇒ Boolean
(also: #reset_contexts?)
Optional.
-
#root_followup_intent_name ⇒ String
Read-only.
-
#training_phrases ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentTrainingPhrase>
Optional.
-
#webhook_state ⇒ String
Optional.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1Intent
constructor
A new instance of GoogleCloudDialogflowV2beta1Intent.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1Intent
Returns a new instance of GoogleCloudDialogflowV2beta1Intent
2857 2858 2859 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2857 def initialize(**args) update!(**args) end |
Instance Attribute Details
#action ⇒ String
Optional. The name of the action associated with the intent.
Note: The action name must not contain whitespaces.
Corresponds to the JSON property action
2713 2714 2715 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2713 def action @action end |
#default_response_platforms ⇒ Array<String>
Optional. The list of platforms for which the first response will be
taken from among the messages assigned to the DEFAULT_PLATFORM.
Corresponds to the JSON property defaultResponsePlatforms
2719 2720 2721 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2719 def default_response_platforms @default_response_platforms end |
#display_name ⇒ String
Required. The name of this intent.
Corresponds to the JSON property displayName
2724 2725 2726 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2724 def display_name @display_name end |
#end_interaction ⇒ Boolean Also known as: end_interaction?
Optional. Indicates that this intent ends an interaction. Some integrations
(e.g., Actions on Google or Dialogflow phone gateway) use this information
to close interaction with an end user. Default is false.
Corresponds to the JSON property endInteraction
2731 2732 2733 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2731 def end_interaction @end_interaction end |
#events ⇒ Array<String>
Optional. The collection of event names that trigger the intent.
If the collection of input contexts is not empty, all of the contexts must
be present in the active user session for an event to trigger this intent.
Corresponds to the JSON property events
2739 2740 2741 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2739 def events @events end |
#followup_intent_info ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo>
Read-only. Information about all followup intents that have this intent as
a direct or indirect parent. We populate this field only in the output.
Corresponds to the JSON property followupIntentInfo
2745 2746 2747 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2745 def followup_intent_info @followup_intent_info end |
#input_context_names ⇒ Array<String>
Optional. The list of context names required for this intent to be
triggered.
Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
.
Corresponds to the JSON property inputContextNames
2752 2753 2754 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2752 def input_context_names @input_context_names end |
#is_fallback ⇒ Boolean Also known as: is_fallback?
Optional. Indicates whether this is a fallback intent.
Corresponds to the JSON property isFallback
2757 2758 2759 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2757 def is_fallback @is_fallback end |
#messages ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessage>
Optional. The collection of rich messages corresponding to the
Response
field in the Dialogflow console.
Corresponds to the JSON property messages
2764 2765 2766 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2764 def @messages end |
#ml_disabled ⇒ Boolean Also known as: ml_disabled?
Optional. Indicates whether Machine Learning is disabled for the intent.
Note: If ml_disabled
setting is set to true, then this intent is not
taken into account during inference in ML ONLY
match mode. Also,
auto-markup in the UI is turned off.
Corresponds to the JSON property mlDisabled
2772 2773 2774 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2772 def ml_disabled @ml_disabled end |
#ml_enabled ⇒ Boolean Also known as: ml_enabled?
Optional. Indicates whether Machine Learning is enabled for the intent.
Note: If ml_enabled
setting is set to false, then this intent is not
taken into account during inference in ML ONLY
match mode. Also,
auto-markup in the UI is turned off.
DEPRECATED! Please use ml_disabled
field instead.
NOTE: If both ml_enabled
and ml_disabled
are either not set or false,
then the default value is determined as follows:
- Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true.
- After April 15th, 2018 the default is:
ml_enabled = true / ml_disabled = false.
Corresponds to the JSON property
mlEnabled
2788 2789 2790 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2788 def ml_enabled @ml_enabled end |
#name ⇒ String
The unique identifier of this intent.
Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
methods.
Format: projects/<Project ID>/agent/intents/<Intent ID>
.
Corresponds to the JSON property name
2797 2798 2799 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2797 def name @name end |
#output_contexts ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1Context>
Optional. The collection of contexts that are activated when the intent
is matched. Context messages in this collection should not set the
parameters field. Setting the lifespan_count
to 0 will reset the context
when the intent is matched.
Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
.
Corresponds to the JSON property outputContexts
2806 2807 2808 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2806 def output_contexts @output_contexts end |
#parameters ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentParameter>
Optional. The collection of parameters associated with the intent.
Corresponds to the JSON property parameters
2811 2812 2813 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2811 def parameters @parameters end |
#parent_followup_intent_name ⇒ String
Read-only after creation. The unique identifier of the parent intent in the
chain of followup intents. You can set this field when creating an intent,
for example with CreateIntent or BatchUpdateIntents, in order to
make this intent a followup intent.
It identifies the parent followup intent.
Format: projects/<Project ID>/agent/intents/<Intent ID>
.
Corresponds to the JSON property parentFollowupIntentName
2821 2822 2823 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2821 def parent_followup_intent_name @parent_followup_intent_name end |
#priority ⇒ Fixnum
Optional. The priority of this intent. Higher numbers represent higher
priorities. If this is zero or unspecified, we use the default
priority 500000.
Negative numbers mean that the intent is disabled.
Corresponds to the JSON property priority
2829 2830 2831 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2829 def priority @priority end |
#reset_contexts ⇒ Boolean Also known as: reset_contexts?
Optional. Indicates whether to delete all contexts in the current
session when this intent is matched.
Corresponds to the JSON property resetContexts
2835 2836 2837 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2835 def reset_contexts @reset_contexts end |
#root_followup_intent_name ⇒ String
Read-only. The unique identifier of the root intent in the chain of
followup intents. It identifies the correct followup intents chain for
this intent. We populate this field only in the output.
Format: projects/<Project ID>/agent/intents/<Intent ID>
.
Corresponds to the JSON property rootFollowupIntentName
2844 2845 2846 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2844 def root_followup_intent_name @root_followup_intent_name end |
#training_phrases ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentTrainingPhrase>
Optional. The collection of examples that the agent is
trained on.
Corresponds to the JSON property trainingPhrases
2850 2851 2852 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2850 def training_phrases @training_phrases end |
#webhook_state ⇒ String
Optional. Indicates whether webhooks are enabled for the intent.
Corresponds to the JSON property webhookState
2855 2856 2857 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2855 def webhook_state @webhook_state end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2862 def update!(**args) @action = args[:action] if args.key?(:action) @default_response_platforms = args[:default_response_platforms] if args.key?(:default_response_platforms) @display_name = args[:display_name] if args.key?(:display_name) @end_interaction = args[:end_interaction] if args.key?(:end_interaction) @events = args[:events] if args.key?(:events) @followup_intent_info = args[:followup_intent_info] if args.key?(:followup_intent_info) @input_context_names = args[:input_context_names] if args.key?(:input_context_names) @is_fallback = args[:is_fallback] if args.key?(:is_fallback) @messages = args[:messages] if args.key?(:messages) @ml_disabled = args[:ml_disabled] if args.key?(:ml_disabled) @ml_enabled = args[:ml_enabled] if args.key?(:ml_enabled) @name = args[:name] if args.key?(:name) @output_contexts = args[:output_contexts] if args.key?(:output_contexts) @parameters = args[:parameters] if args.key?(:parameters) @parent_followup_intent_name = args[:parent_followup_intent_name] if args.key?(:parent_followup_intent_name) @priority = args[:priority] if args.key?(:priority) @reset_contexts = args[:reset_contexts] if args.key?(:reset_contexts) @root_followup_intent_name = args[:root_followup_intent_name] if args.key?(:root_followup_intent_name) @training_phrases = args[:training_phrases] if args.key?(:training_phrases) @webhook_state = args[:webhook_state] if args.key?(:webhook_state) end |