Class: Google::Apis::DialogflowV2beta1::Intent

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

Returns a new instance of Intent



936
937
938
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 936

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) 


821
822
823
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 821

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


827
828
829
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 827

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) 


832
833
834
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 832

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


839
840
841
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 839

def events
  @events
end

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

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:



845
846
847
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 845

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


852
853
854
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 852

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) 


857
858
859
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 857

def is_fallback
  @is_fallback
end

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

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

Returns:



864
865
866
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 864

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) 


872
873
874
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 872

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) 


881
882
883
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 881

def name
  @name
end

#output_contexts ⇒ Array<Google::Apis::DialogflowV2beta1::Context>

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:



890
891
892
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 890

def output_contexts
  @output_contexts
end

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

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

Returns:



895
896
897
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 895

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) 


903
904
905
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 903

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) 


909
910
911
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 909

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) 


915
916
917
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 915

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) 


923
924
925
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 923

def root_followup_intent_name
  @root_followup_intent_name
end

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

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

Returns:



929
930
931
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 929

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) 


934
935
936
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 934

def webhook_state
  @webhook_state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 941

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