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



2335
2336
2337
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2335

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

Returns:

  • (String) 


2220
2221
2222
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2220

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

Returns:

  • (Array<String>) 


2226
2227
2228
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2226

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) 


2231
2232
2233
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2231

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

Returns:

  • (Array<String>) 


2238
2239
2240
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2238

def events
  @events
end

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

Optional. Collection of information about all followup intents that have name of this intent as a root_name. Corresponds to the JSON property followupIntentInfo

Returns:



2244
2245
2246
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2244

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


2251
2252
2253
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2251

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) 


2256
2257
2258
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2256

def is_fallback
  @is_fallback
end

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

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

Returns:



2263
2264
2265
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2263

def messages
  @messages
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. Corresponds to the JSON property mlEnabled

Returns:

  • (Boolean) 


2271
2272
2273
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2271

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

Returns:

  • (String) 


2280
2281
2282
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2280

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:



2289
2290
2291
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2289

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:



2294
2295
2296
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2294

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

Returns:

  • (String) 


2302
2303
2304
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2302

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

Returns:

  • (Fixnum) 


2308
2309
2310
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2308

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) 


2314
2315
2316
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2314

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

Returns:

  • (String) 


2322
2323
2324
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2322

def root_followup_intent_name
  @root_followup_intent_name
end

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

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

Returns:



2328
2329
2330
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2328

def training_phrases
  @training_phrases
end

#webhook_state ⇒ String

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

Returns:

  • (String) 


2333
2334
2335
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2333

def webhook_state
  @webhook_state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2340

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