Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v2/classes.rb,
lib/google/apis/dialogflow_v2/representations.rb,
lib/google/apis/dialogflow_v2/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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2Intent

Returns a new instance of GoogleCloudDialogflowV2Intent.



12129
12130
12131
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12129

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

Returns:

  • (String) 


11995
11996
11997
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11995

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

Returns:

  • (Array<String>) 


12001
12002
12003
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12001

def default_response_platforms
  @default_response_platforms
end

#display_name ⇒ String

Required. The name of this intent. Corresponds to the JSON property displayName

Returns:

  • (String) 


12006
12007
12008
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12006

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

Returns:

  • (Boolean) 


12013
12014
12015
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12013

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

Returns:

  • (Array<String>) 


12022
12023
12024
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12022

def events
  @events
end

#followup_intent_info ⇒ Array<Google::Apis::DialogflowV2::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

Returns:



12029
12030
12031
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12029

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

Returns:

  • (Array<String>) 


12035
12036
12037
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12035

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

Returns:

  • (Boolean) 


12040
12041
12042
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12040

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

Returns:

  • (Boolean) 


12048
12049
12050
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12048

def live_agent_handoff
  @live_agent_handoff
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

Returns:



12055
12056
12057
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12055

def messages
  @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

Returns:

  • (Boolean) 


12063
12064
12065
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12063

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

Returns:

  • (String) 


12071
12072
12073
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12071

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//agent/sessions/-/contexts/. Corresponds to the JSON property outputContexts

Returns:



12079
12080
12081
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12079

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

Returns:



12084
12085
12086
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12084

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

Returns:

  • (String) 


12093
12094
12095
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12093

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

Returns:

  • (Fixnum) 


12102
12103
12104
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12102

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

Returns:

  • (Boolean) 


12108
12109
12110
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12108

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

Returns:

  • (String) 


12117
12118
12119
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12117

def root_followup_intent_name
  @root_followup_intent_name
end

#training_phrases ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentTrainingPhrase>

Optional. The collection of examples that the agent is trained on. Corresponds to the JSON property trainingPhrases

Returns:



12122
12123
12124
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12122

def training_phrases
  @training_phrases
end

#webhook_state ⇒ String

Optional. Indicates whether webhooks are enabled for the intent. Corresponds to the JSON property webhookState

Returns:

  • (String) 


12127
12128
12129
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12127

def webhook_state
  @webhook_state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12134

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