Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1Intent

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

Returns a new instance of GoogleCloudDialogflowV2beta1Intent.



16829
16830
16831
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16829

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) 


16683
16684
16685
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16683

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>) 


16689
16690
16691
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16689

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) 


16694
16695
16696
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16694

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) 


16701
16702
16703
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16701

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>) 


16710
16711
16712
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16710

def events
  @events
end

#followup_intent_info ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo>

Output 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:



16716
16717
16718
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16716

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. Formats: - projects//agent/sessions/-/contexts/ - projects//locations// agent/sessions/-/contexts/ Corresponds to the JSON property inputContextNames

Returns:

  • (Array<String>) 


16723
16724
16725
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16723

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) 


16728
16729
16730
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16728

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) 


16736
16737
16738
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16736

def live_agent_handoff
  @live_agent_handoff
end

#messages ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessage>

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console. Corresponds to the JSON property messages

Returns:



16743
16744
16745
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16743

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) 


16751
16752
16753
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16751

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

Returns:

  • (Boolean) 


16764
16765
16766
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16764

def ml_enabled
  @ml_enabled
end

#name ⇒ String

Optional. The unique identifier of this intent. Required for Intents. UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - projects//agent/intents/ - projects//locations//agent/intents/ Corresponds to the JSON property name

Returns:

  • (String) 


16772
16773
16774
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16772

def name
  @name
end

#output_contexts ⇒ Array<Google::Apis::DialogflowV3beta1::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//agent/sessions/-/contexts/. Corresponds to the JSON property outputContexts

Returns:



16780
16781
16782
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16780

def output_contexts
  @output_contexts
end

#parameters ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentParameter>

Optional. The collection of parameters associated with the intent. Corresponds to the JSON property parameters

Returns:



16785
16786
16787
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16785

def parameters
  @parameters
end

#parent_followup_intent_name ⇒ String

Optional. 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) 


16794
16795
16796
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16794

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) 


16803
16804
16805
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16803

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) 


16809
16810
16811
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16809

def reset_contexts
  @reset_contexts
end

#root_followup_intent_name ⇒ String

Output only. 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//agent/intents/. Corresponds to the JSON property rootFollowupIntentName

Returns:

  • (String) 


16817
16818
16819
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16817

def root_followup_intent_name
  @root_followup_intent_name
end

#training_phrases ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentTrainingPhrase>

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

Returns:



16822
16823
16824
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16822

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) 


16827
16828
16829
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16827

def webhook_state
  @webhook_state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16834
16835
16836
16837
16838
16839
16840
16841
16842
16843
16844
16845
16846
16847
16848
16849
16850
16851
16852
16853
16854
16855
16856
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 16834

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)
  @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