Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3Intent

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v2beta1/classes.rb,
lib/google/apis/dialogflow_v2beta1/representations.rb,
lib/google/apis/dialogflow_v2beta1/representations.rb

Overview

An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Intent

Returns a new instance of GoogleCloudDialogflowCxV3Intent.



1807
1808
1809
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 1807

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

Instance Attribute Details

#description ⇒ String

Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. Corresponds to the JSON property description

Returns:

  • (String) 


1751
1752
1753
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 1751

def description
  @description
end

#display_name ⇒ String

Required. The human-readable name of the intent, unique within the agent. Corresponds to the JSON property displayName

Returns:

  • (String) 


1756
1757
1758
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 1756

def display_name
  @display_name
end

#is_fallback ⇒ Boolean Also known as: is_fallback?

Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. Corresponds to the JSON property isFallback

Returns:

  • (Boolean) 


1765
1766
1767
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 1765

def is_fallback
  @is_fallback
end

#labels ⇒ Hash<String,String>

The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1778
1779
1780
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 1778

def labels
  @labels
end

#name ⇒ String

The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: projects//locations//agents//intents/. Corresponds to the JSON property name

Returns:

  • (String) 


1785
1786
1787
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 1785

def name
  @name
end

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

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

Returns:



1790
1791
1792
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 1790

def parameters
  @parameters
end

#priority ⇒ Fixnum

The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. Corresponds to the JSON property priority

Returns:

  • (Fixnum) 


1799
1800
1801
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 1799

def priority
  @priority
end

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

The collection of training phrases the agent is trained on to identify the intent. Corresponds to the JSON property trainingPhrases

Returns:



1805
1806
1807
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 1805

def training_phrases
  @training_phrases
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 1812

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @is_fallback = args[:is_fallback] if args.key?(:is_fallback)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @parameters = args[:parameters] if args.key?(:parameters)
  @priority = args[:priority] if args.key?(:priority)
  @training_phrases = args[:training_phrases] if args.key?(:training_phrases)
end