Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2Intent

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

Returns a new instance of GoogleCloudDialogflowV2Intent



386
387
388
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 386

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) 


268
269
270
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 268

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


274
275
276
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 274

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) 


279
280
281
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 279

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


286
287
288
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 286

def events
  @events
end

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

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:



292
293
294
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 292

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


299
300
301
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 299

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) 


304
305
306
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 304

def is_fallback
  @is_fallback
end

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

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

Returns:



311
312
313
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 311

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


319
320
321
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 319

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


328
329
330
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 328

def name
  @name
end

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

Returns:



337
338
339
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 337

def output_contexts
  @output_contexts
end

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

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

Returns:



342
343
344
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 342

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) 


352
353
354
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 352

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) 


358
359
360
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 358

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) 


364
365
366
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 364

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) 


373
374
375
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 373

def root_followup_intent_name
  @root_followup_intent_name
end

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

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

Returns:



379
380
381
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 379

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) 


384
385
386
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 384

def webhook_state
  @webhook_state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 391

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