Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::Intent (v0.16.0)

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

An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification.

For more information, see the intent guide.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#action

def action() -> ::String
Returns
  • (::String) — Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.

#action=

def action=(value) -> ::String
Parameter
  • value (::String) — Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.
Returns
  • (::String) — Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.

#default_response_platforms

def default_response_platforms() -> ::Array<::Google::Cloud::Dialogflow::V2::Intent::Message::Platform>
Returns

#default_response_platforms=

def default_response_platforms=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::Intent::Message::Platform>
Parameter
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. The name of this intent.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. The name of this intent.
Returns
  • (::String) — Required. The name of this intent.

#end_interaction

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

#end_interaction=

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

#events

def events() -> ::Array<::String>
Returns
  • (::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. Event names are limited to 150 characters.

#events=

def events=(value) -> ::Array<::String>
Parameter
  • value (::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. Event names are limited to 150 characters.
Returns
  • (::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. Event names are limited to 150 characters.

#followup_intent_info

def followup_intent_info() -> ::Array<::Google::Cloud::Dialogflow::V2::Intent::FollowupIntentInfo>
Returns

#input_context_names

def input_context_names() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. The list of context names required for this intent to be triggered. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

#input_context_names=

def input_context_names=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. The list of context names required for this intent to be triggered. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.
Returns
  • (::Array<::String>) — Optional. The list of context names required for this intent to be triggered. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

#is_fallback

def is_fallback() -> ::Boolean
Returns
  • (::Boolean) — Optional. Indicates whether this is a fallback intent.

#is_fallback=

def is_fallback=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Indicates whether this is a fallback intent.
Returns
  • (::Boolean) — Optional. Indicates whether this is a fallback intent.

#live_agent_handoff

def live_agent_handoff() -> ::Boolean
Returns
  • (::Boolean) — Optional. Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false.

#live_agent_handoff=

def live_agent_handoff=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false.
Returns
  • (::Boolean) — Optional. Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false.

#messages

def messages() -> ::Array<::Google::Cloud::Dialogflow::V2::Intent::Message>
Returns

#messages=

def messages=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::Intent::Message>
Parameter
Returns

#ml_disabled

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

#ml_disabled=

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

#name

def name() -> ::String
Returns

#name=

def name=(value) -> ::String
Parameter
Returns

#output_contexts

def output_contexts() -> ::Array<::Google::Cloud::Dialogflow::V2::Context>
Returns
  • (::Array<::Google::Cloud::Dialogflow::V2::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>.

#output_contexts=

def output_contexts=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::Context>
Parameter
  • value (::Array<::Google::Cloud::Dialogflow::V2::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>.
Returns
  • (::Array<::Google::Cloud::Dialogflow::V2::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>.

#parameters

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

#parameters=

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

#parent_followup_intent_name

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

#parent_followup_intent_name=

def parent_followup_intent_name=(value) -> ::String
Parameter
  • value (::String) — 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>.

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

#priority

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

    Optional. 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) —

    Optional. 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) —

    Optional. 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.

#reset_contexts

def reset_contexts() -> ::Boolean
Returns
  • (::Boolean) — Optional. Indicates whether to delete all contexts in the current session when this intent is matched.

#reset_contexts=

def reset_contexts=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Indicates whether to delete all contexts in the current session when this intent is matched.
Returns
  • (::Boolean) — Optional. Indicates whether to delete all contexts in the current session when this intent is matched.

#root_followup_intent_name

def root_followup_intent_name() -> ::String
Returns
  • (::String) — Output only. 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>.

#training_phrases

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

#training_phrases=

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

#webhook_state

def webhook_state() -> ::Google::Cloud::Dialogflow::V2::Intent::WebhookState
Returns

#webhook_state=

def webhook_state=(value) -> ::Google::Cloud::Dialogflow::V2::Intent::WebhookState
Parameter
Returns