Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1Intent

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



2821
2822
2823
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2821

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#actionString

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)


2677
2678
2679
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2677

def action
  @action
end

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


2683
2684
2685
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2683

def default_response_platforms
  @default_response_platforms
end

#display_nameString

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

Returns:

  • (String)


2688
2689
2690
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2688

def display_name
  @display_name
end

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


2695
2696
2697
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2695

def end_interaction
  @end_interaction
end

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


2703
2704
2705
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2703

def events
  @events
end

#followup_intent_infoArray<Google::Apis::DialogflowV2::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



2709
2710
2711
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2709

def followup_intent_info
  @followup_intent_info
end

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


2716
2717
2718
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2716

def input_context_names
  @input_context_names
end

#is_fallbackBoolean Also known as: is_fallback?

Optional. Indicates whether this is a fallback intent. Corresponds to the JSON property isFallback

Returns:

  • (Boolean)


2721
2722
2723
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2721

def is_fallback
  @is_fallback
end

#messagesArray<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessage>

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



2728
2729
2730
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2728

def messages
  @messages
end

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


2736
2737
2738
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2736

def ml_disabled
  @ml_disabled
end

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


2752
2753
2754
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2752

def ml_enabled
  @ml_enabled
end

#nameString

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)


2761
2762
2763
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2761

def name
  @name
end

#output_contextsArray<Google::Apis::DialogflowV2::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



2770
2771
2772
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2770

def output_contexts
  @output_contexts
end

#parametersArray<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentParameter>

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



2775
2776
2777
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2775

def parameters
  @parameters
end

#parent_followup_intent_nameString

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)


2785
2786
2787
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2785

def parent_followup_intent_name
  @parent_followup_intent_name
end

#priorityFixnum

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)


2793
2794
2795
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2793

def priority
  @priority
end

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


2799
2800
2801
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2799

def reset_contexts
  @reset_contexts
end

#root_followup_intent_nameString

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)


2808
2809
2810
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2808

def root_followup_intent_name
  @root_followup_intent_name
end

#training_phrasesArray<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentTrainingPhrase>

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



2814
2815
2816
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2814

def training_phrases
  @training_phrases
end

#webhook_stateString

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

Returns:

  • (String)


2819
2820
2821
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2819

def webhook_state
  @webhook_state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2826

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