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
- (::String) — Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.
#action=
def action=(value) -> ::String
- value (::String) — Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.
- (::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>
- (::Array<::Google::Cloud::Dialogflow::V2::Intent::Message::Platform>) — Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
#default_response_platforms=
def default_response_platforms=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::Intent::Message::Platform>
- value (::Array<::Google::Cloud::Dialogflow::V2::Intent::Message::Platform>) — Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
- (::Array<::Google::Cloud::Dialogflow::V2::Intent::Message::Platform>) — Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
#display_name
def display_name() -> ::String
- (::String) — Required. The name of this intent.
#display_name=
def display_name=(value) -> ::String
- value (::String) — Required. The name of this intent.
- (::String) — Required. The name of this intent.
#end_interaction
def end_interaction() -> ::Boolean
- (::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
- 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.
- (::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>
- (::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>
- 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.
- (::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>
- (::Array<::Google::Cloud::Dialogflow::V2::Intent::FollowupIntentInfo>) — 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.
#input_context_names
def input_context_names() -> ::Array<::String>
-
(::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>
-
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>
.
-
(::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
- (::Boolean) — Optional. Indicates whether this is a fallback intent.
#is_fallback=
def is_fallback=(value) -> ::Boolean
- value (::Boolean) — Optional. Indicates whether this is a fallback intent.
- (::Boolean) — Optional. Indicates whether this is a fallback intent.
#live_agent_handoff
def live_agent_handoff() -> ::Boolean
- (::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
- 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.
- (::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>
-
(::Array<::Google::Cloud::Dialogflow::V2::Intent::Message>) — Optional. The collection of rich messages corresponding to the
Response
field in the Dialogflow console.
#messages=
def messages=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::Intent::Message>
-
value (::Array<::Google::Cloud::Dialogflow::V2::Intent::Message>) — Optional. The collection of rich messages corresponding to the
Response
field in the Dialogflow console.
-
(::Array<::Google::Cloud::Dialogflow::V2::Intent::Message>) — Optional. The collection of rich messages corresponding to the
Response
field in the Dialogflow console.
#ml_disabled
def ml_disabled() -> ::Boolean
-
(::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 inML ONLY
match mode. Also, auto-markup in the UI is turned off.
#ml_disabled=
def ml_disabled=(value) -> ::Boolean
-
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 inML ONLY
match mode. Also, auto-markup in the UI is turned off.
-
(::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 inML ONLY
match mode. Also, auto-markup in the UI is turned off.
#name
def name() -> ::String
-
(::String) — Optional. The unique identifier of this intent.
Required for
Intents.UpdateIntent and
Intents.BatchUpdateIntents
methods.
Format:
projects/<Project ID>/agent/intents/<Intent ID>
.
#name=
def name=(value) -> ::String
-
value (::String) — Optional. The unique identifier of this intent.
Required for
Intents.UpdateIntent and
Intents.BatchUpdateIntents
methods.
Format:
projects/<Project ID>/agent/intents/<Intent ID>
.
-
(::String) — Optional. The unique identifier of this intent.
Required for
Intents.UpdateIntent and
Intents.BatchUpdateIntents
methods.
Format:
projects/<Project ID>/agent/intents/<Intent ID>
.
#output_contexts
def output_contexts() -> ::Array<::Google::Cloud::Dialogflow::V2::Context>
-
(::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>
-
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>
.
-
(::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>
- (::Array<::Google::Cloud::Dialogflow::V2::Intent::Parameter>) — Optional. The collection of parameters associated with the intent.
#parameters=
def parameters=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::Intent::Parameter>
- value (::Array<::Google::Cloud::Dialogflow::V2::Intent::Parameter>) — Optional. The collection of parameters associated with the intent.
- (::Array<::Google::Cloud::Dialogflow::V2::Intent::Parameter>) — Optional. The collection of parameters associated with the intent.
#parent_followup_intent_name
def parent_followup_intent_name() -> ::String
-
(::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
-
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>
.
-
(::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
-
(::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.
- If the supplied value is unspecified or 0, the service
translates the value to 500,000, which corresponds to the
#priority=
def priority=(value) -> ::Integer
-
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.
- If the supplied value is unspecified or 0, the service
translates the value to 500,000, which corresponds to the
-
(::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.
- If the supplied value is unspecified or 0, the service
translates the value to 500,000, which corresponds to the
#reset_contexts
def reset_contexts() -> ::Boolean
- (::Boolean) — Optional. Indicates whether to delete all contexts in the current session when this intent is matched.
#reset_contexts=
def reset_contexts=(value) -> ::Boolean
- value (::Boolean) — Optional. Indicates whether to delete all contexts in the current session when this intent is matched.
- (::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
-
(::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>
- (::Array<::Google::Cloud::Dialogflow::V2::Intent::TrainingPhrase>) — Optional. The collection of examples that the agent is trained on.
#training_phrases=
def training_phrases=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::Intent::TrainingPhrase>
- value (::Array<::Google::Cloud::Dialogflow::V2::Intent::TrainingPhrase>) — Optional. The collection of examples that the agent is trained on.
- (::Array<::Google::Cloud::Dialogflow::V2::Intent::TrainingPhrase>) — Optional. The collection of examples that the agent is trained on.
#webhook_state
def webhook_state() -> ::Google::Cloud::Dialogflow::V2::Intent::WebhookState
- (::Google::Cloud::Dialogflow::V2::Intent::WebhookState) — Optional. Indicates whether webhooks are enabled for the intent.
#webhook_state=
def webhook_state=(value) -> ::Google::Cloud::Dialogflow::V2::Intent::WebhookState
- value (::Google::Cloud::Dialogflow::V2::Intent::WebhookState) — Optional. Indicates whether webhooks are enabled for the intent.
- (::Google::Cloud::Dialogflow::V2::Intent::WebhookState) — Optional. Indicates whether webhooks are enabled for the intent.