class Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2Intent

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](https:// cloud.google.com/dialogflow/docs/intents-overview).

Attributes

action[RW]

Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces. Corresponds to the JSON property `action` @return [String]

default_response_platforms[RW]

Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform). Corresponds to the JSON property `defaultResponsePlatforms` @return [Array<String>]

display_name[RW]

Required. The name of this intent. Corresponds to the JSON property `displayName` @return [String]

end_interaction[RW]

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. Corresponds to the JSON property `endInteraction` @return [Boolean]

end_interaction?[RW]

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. Corresponds to the JSON property `endInteraction` @return [Boolean]

events[RW]

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. Corresponds to the JSON property `events` @return [Array<String>]

followup_intent_info[RW]

Output only. Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output. Corresponds to the JSON property `followupIntentInfo` @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2IntentFollowupIntentInfo>]

input_context_names[RW]

Optional. The list of context names required for this intent to be triggered. Format: `projects//agent/sessions/-/contexts/`. Corresponds to the JSON property `inputContextNames` @return [Array<String>]

is_fallback[RW]

Optional. Indicates whether this is a fallback intent. Corresponds to the JSON property `isFallback` @return [Boolean]

is_fallback?[RW]

Optional. Indicates whether this is a fallback intent. Corresponds to the JSON property `isFallback` @return [Boolean]

live_agent_handoff[RW]

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. Corresponds to the JSON property `liveAgentHandoff` @return [Boolean]

live_agent_handoff?[RW]

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. Corresponds to the JSON property `liveAgentHandoff` @return [Boolean]

messages[RW]

Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console. Corresponds to the JSON property `messages` @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2IntentMessage>]

ml_disabled[RW]

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. Corresponds to the JSON property `mlDisabled` @return [Boolean]

ml_disabled?[RW]

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. Corresponds to the JSON property `mlDisabled` @return [Boolean]

name[RW]

Optional. The unique identifier of this intent. Required for Intents. UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/ intents/`. Corresponds to the JSON property `name` @return [String]

output_contexts[RW]

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//agent/sessions/-/contexts/`. Corresponds to the JSON property `outputContexts` @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2Context>]

parameters[RW]

Optional. The collection of parameters associated with the intent. Corresponds to the JSON property `parameters` @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2IntentParameter>]

parent_followup_intent_name[RW]

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/ /agent/intents/`. Corresponds to the JSON property `parentFollowupIntentName` @return [String]

priority[RW]

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. Corresponds to the JSON property `priority` @return [Fixnum]

reset_contexts[RW]

Optional. Indicates whether to delete all contexts in the current session when this intent is matched. Corresponds to the JSON property `resetContexts` @return [Boolean]

reset_contexts?[RW]

Optional. Indicates whether to delete all contexts in the current session when this intent is matched. Corresponds to the JSON property `resetContexts` @return [Boolean]

root_followup_intent_name[RW]

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//agent/ intents/`. Corresponds to the JSON property `rootFollowupIntentName` @return [String]

training_phrases[RW]

Optional. The collection of examples that the agent is trained on. Corresponds to the JSON property `trainingPhrases` @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2IntentTrainingPhrase>]

webhook_state[RW]

Optional. Indicates whether webhooks are enabled for the intent. Corresponds to the JSON property `webhookState` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/dialogflow_v2beta1/classes.rb, line 5741
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/dialogflow_v2beta1/classes.rb, line 5746
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)
  @end_interaction = args[:end_interaction] if args.key?(:end_interaction)
  @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)
  @live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff)
  @messages = args[:messages] if args.key?(:messages)
  @ml_disabled = args[:ml_disabled] if args.key?(:ml_disabled)
  @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