Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent

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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1Intent

Returns a new instance of GoogleCloudDialogflowV2beta1Intent



3070
3071
3072
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3070

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) 


2926
2927
2928
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2926

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


2932
2933
2934
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2932

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) 


2937
2938
2939
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2937

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) 


2944
2945
2946
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2944

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

Returns:

  • (Array<String>) 


2952
2953
2954
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2952

def events
  @events
end

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

Returns:



2958
2959
2960
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2958

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

Returns:

  • (Array<String>) 


2965
2966
2967
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2965

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) 


2970
2971
2972
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2970

def is_fallback
  @is_fallback
end

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

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

Returns:



2977
2978
2979
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2977

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) 


2985
2986
2987
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2985

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) 


3001
3002
3003
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3001

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

Returns:

  • (String) 


3010
3011
3012
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3010

def name
  @name
end

#output_contexts ⇒ Array<Google::Apis::DialogflowV2beta1::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

Returns:



3019
3020
3021
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3019

def output_contexts
  @output_contexts
end

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

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

Returns:



3024
3025
3026
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3024

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

Returns:

  • (String) 


3034
3035
3036
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3034

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

Returns:

  • (Fixnum) 


3042
3043
3044
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3042

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) 


3048
3049
3050
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3048

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

Returns:

  • (String) 


3057
3058
3059
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3057

def root_followup_intent_name
  @root_followup_intent_name
end

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

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

Returns:



3063
3064
3065
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3063

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) 


3068
3069
3070
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3068

def webhook_state
  @webhook_state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3075

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