Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::Intent (v0.18.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::Intent.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#description

def description() -> ::String
Returns
  • (::String) — Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
Returns
  • (::String) — Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. The human-readable name of the intent, unique within the agent.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. The human-readable name of the intent, unique within the agent.
Returns
  • (::String) — Required. The human-readable name of the intent, unique within the agent.

#is_fallback

def is_fallback() -> ::Boolean
Returns
  • (::Boolean) — 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.

#is_fallback=

def is_fallback=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::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.
Returns
  • (::Google::Protobuf::Map{::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.

#name

def name() -> ::String
Returns
  • (::String) — The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.
Returns
  • (::String) — The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

#parameters

def parameters() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::Intent::Parameter>
Returns

#parameters=

def parameters=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::Intent::Parameter>
Parameter
Returns

#priority

def priority() -> ::Integer
Returns
  • (::Integer) —

    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.

#priority=

def priority=(value) -> ::Integer
Parameter
  • value (::Integer) —

    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.
Returns
  • (::Integer) —

    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.

#training_phrases

def training_phrases() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase>
Returns

#training_phrases=

def training_phrases=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase>
Parameter
Returns