Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3Intent

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



1713
1714
1715
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 1713

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) 


1657
1658
1659
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 1657

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) 


1662
1663
1664
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 1662

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) 


1671
1672
1673
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 1671

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


1684
1685
1686
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 1684

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) 


1691
1692
1693
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 1691

def name
  @name
end

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

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

Returns:



1696
1697
1698
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 1696

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) 


1705
1706
1707
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 1705

def priority
  @priority
end

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

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

Returns:



1711
1712
1713
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 1711

def training_phrases
  @training_phrases
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 1718

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