Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowV2Intent
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV3::GoogleCloudDialogflowV2Intent
- 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 categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the intent guide.
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::DialogflowV3::GoogleCloudDialogflowV2IntentFollowupIntentInfo>
Output only.
-
#input_context_names ⇒ Array<String>
Optional.
-
#is_fallback ⇒ Boolean
(also: #is_fallback?)
Optional.
-
#live_agent_handoff ⇒ Boolean
(also: #live_agent_handoff?)
Optional.
-
#messages ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessage>
Optional.
-
#ml_disabled ⇒ Boolean
(also: #ml_disabled?)
Optional.
-
#name ⇒ String
Optional.
-
#output_contexts ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2Context>
Optional.
-
#parameters ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentParameter>
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
Output only.
-
#training_phrases ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentTrainingPhrase>
Optional.
-
#webhook_state ⇒ String
Optional.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowV2Intent
constructor
A new instance of GoogleCloudDialogflowV2Intent.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowV2Intent
Returns a new instance of GoogleCloudDialogflowV2Intent.
12692 12693 12694 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12692 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
12558 12559 12560 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12558 def action @action end |
#default_response_platforms ⇒ Array<String>
Optional. The list of platforms for which the first responses will be copied
from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
Corresponds to the JSON property defaultResponsePlatforms
12564 12565 12566 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12564 def default_response_platforms @default_response_platforms end |
#display_name ⇒ String
Required. The name of this intent.
Corresponds to the JSON property displayName
12569 12570 12571 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12569 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
12576 12577 12578 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12576 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. Event names
are limited to 150 characters.
Corresponds to the JSON property events
12585 12586 12587 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12585 def events @events end |
#followup_intent_info ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentFollowupIntentInfo>
Output only. 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
12592 12593 12594 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12592 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//agent/sessions/-/contexts/
.
Corresponds to the JSON property inputContextNames
12598 12599 12600 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12598 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
12603 12604 12605 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12603 def is_fallback @is_fallback end |
#live_agent_handoff ⇒ Boolean Also known as: live_agent_handoff?
Optional. Indicates that a live agent should be brought in to handle the
interaction with the user. In most cases, when you set this flag to true, you
would also want to set end_interaction to true as well. Default is false.
Corresponds to the JSON property liveAgentHandoff
12611 12612 12613 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12611 def live_agent_handoff @live_agent_handoff end |
#messages ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessage>
Optional. The collection of rich messages corresponding to the Response
field in the Dialogflow console.
Corresponds to the JSON property messages
12618 12619 12620 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12618 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
12626 12627 12628 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12626 def ml_disabled @ml_disabled end |
#name ⇒ String
Optional. The unique identifier of this intent. Required for Intents.
UpdateIntent and Intents.BatchUpdateIntents methods. Format: projects//agent/
intents/
.
Corresponds to the JSON property name
12634 12635 12636 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12634 def name @name end |
#output_contexts ⇒ Array<Google::Apis::DialogflowV3::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//agent/sessions/-/contexts/
.
Corresponds to the JSON property outputContexts
12642 12643 12644 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12642 def output_contexts @output_contexts end |
#parameters ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentParameter>
Optional. The collection of parameters associated with the intent.
Corresponds to the JSON property parameters
12647 12648 12649 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12647 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/
/agent/intents/
.
Corresponds to the JSON property parentFollowupIntentName
12656 12657 12658 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12656 def parent_followup_intent_name @parent_followup_intent_name end |
#priority ⇒ Fixnum
Optional. 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
12665 12666 12667 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12665 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
12671 12672 12673 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12671 def reset_contexts @reset_contexts end |
#root_followup_intent_name ⇒ String
Output only. 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//agent/
intents/
.
Corresponds to the JSON property rootFollowupIntentName
12680 12681 12682 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12680 def root_followup_intent_name @root_followup_intent_name end |
#training_phrases ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentTrainingPhrase>
Optional. The collection of examples that the agent is trained on.
Corresponds to the JSON property trainingPhrases
12685 12686 12687 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12685 def training_phrases @training_phrases end |
#webhook_state ⇒ String
Optional. Indicates whether webhooks are enabled for the intent.
Corresponds to the JSON property webhookState
12690 12691 12692 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12690 def webhook_state @webhook_state end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
12697 12698 12699 12700 12701 12702 12703 12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12697 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) @live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff) @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 |