Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent
- 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.
-
#events ⇒ Array<String>
Optional.
-
#followup_intent_info ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentFollowupIntentInfo>
Optional.
-
#input_context_names ⇒ Array<String>
Optional.
-
#is_fallback ⇒ Boolean
(also: #is_fallback?)
Optional.
-
#messages ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessage>
Optional.
-
#ml_disabled ⇒ Boolean
(also: #ml_disabled?)
Optional.
-
#name ⇒ String
Required for all methods except
create
(create
populates the name automatically. The unique identifier of this intent. Format:projects/<Project ID>/agent/intents/<Intent ID>
. Corresponds to the JSON propertyname
. -
#output_contexts ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context>
Optional.
-
#parameters ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentParameter>
Optional.
-
#parent_followup_intent_name ⇒ String
The unique identifier of the parent intent in the chain of followup intents.
-
#priority ⇒ Fixnum
Optional.
-
#reset_contexts ⇒ Boolean
(also: #reset_contexts?)
Optional.
-
#root_followup_intent_name ⇒ String
The unique identifier of the root intent in the chain of followup intents.
-
#training_phrases ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentTrainingPhrase>
Optional.
-
#webhook_state ⇒ String
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowV2Intent
constructor
A new instance of GoogleCloudDialogflowV2Intent.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowV2Intent
Returns a new instance of GoogleCloudDialogflowV2Intent
939 940 941 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 939 def initialize(**args) update!(**args) end |
Instance Attribute Details
#action ⇒ String
Optional. The name of the action associated with the intent.
Corresponds to the JSON property action
824 825 826 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 824 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
830 831 832 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 830 def default_response_platforms @default_response_platforms end |
#display_name ⇒ String
Required. The name of this intent.
Corresponds to the JSON property displayName
835 836 837 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 835 def display_name @display_name 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
842 843 844 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 842 def events @events end |
#followup_intent_info ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentFollowupIntentInfo>
Optional. Collection of information about all followup intents that have
name of this intent as a root_name.
Corresponds to the JSON property followupIntentInfo
848 849 850 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 848 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
855 856 857 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 855 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
860 861 862 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 860 def is_fallback @is_fallback end |
#messages ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessage>
Optional. The collection of rich messages corresponding to the
Response
field in the Dialogflow console.
Corresponds to the JSON property messages
867 868 869 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 867 def @messages end |
#ml_disabled ⇒ Boolean Also known as: ml_disabled?
Optional. Indicates whether Machine Learning is disabled for the intent.
Note: If ml_diabled
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
875 876 877 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 875 def ml_disabled @ml_disabled end |
#name ⇒ String
Required for all methods except create
(create
populates the name
automatically.
The unique identifier of this intent.
Format: projects/<Project ID>/agent/intents/<Intent ID>
.
Corresponds to the JSON property name
884 885 886 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 884 def name @name end |
#output_contexts ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context>
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
893 894 895 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 893 def output_contexts @output_contexts end |
#parameters ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentParameter>
Optional. The collection of parameters associated with the intent.
Corresponds to the JSON property parameters
898 899 900 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 898 def parameters @parameters end |
#parent_followup_intent_name ⇒ String
The unique identifier of the parent intent in the chain of followup
intents.
It identifies the parent followup intent.
Format: projects/<Project ID>/agent/intents/<Intent ID>
.
Corresponds to the JSON property parentFollowupIntentName
906 907 908 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 906 def parent_followup_intent_name @parent_followup_intent_name end |
#priority ⇒ Fixnum
Optional. The priority of this intent. Higher numbers represent higher
priorities. Zero or negative numbers mean that the intent is disabled.
Corresponds to the JSON property priority
912 913 914 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 912 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
918 919 920 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 918 def reset_contexts @reset_contexts end |
#root_followup_intent_name ⇒ String
The unique identifier of the root intent in the chain of followup intents.
It identifies the correct followup intents chain for this intent.
Format: projects/<Project ID>/agent/intents/<Intent ID>
.
Corresponds to the JSON property rootFollowupIntentName
926 927 928 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 926 def root_followup_intent_name @root_followup_intent_name end |
#training_phrases ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentTrainingPhrase>
Optional. The collection of examples/templates that the agent is
trained on.
Corresponds to the JSON property trainingPhrases
932 933 934 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 932 def training_phrases @training_phrases end |
#webhook_state ⇒ String
Required. Indicates whether webhooks are enabled for the intent.
Corresponds to the JSON property webhookState
937 938 939 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 937 def webhook_state @webhook_state end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 944 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) @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) @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 |