Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class 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 .
Generated from protobuf message google.cloud.dialogflow.v2.Intent
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Optional. The unique identifier of this intent. Required for Intents.UpdateIntent
and Intents.BatchUpdateIntents
methods. Format: projects/<Project ID>/agent/intents/<Intent ID>
.
↳ display_name
string
Required. The name of this intent.
↳ webhook_state
int
Optional. Indicates whether webhooks are enabled for the intent.
↳ priority
int
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.
↳ is_fallback
bool
Optional. Indicates whether this is a fallback intent.
↳ ml_disabled
bool
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.
↳ live_agent_handoff
bool
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.
↳ end_interaction
bool
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.
↳ input_context_names
array
Optional. The list of context names required for this intent to be triggered. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
.
↳ events
array
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.
↳ training_phrases
array< Google\Cloud\Dialogflow\V2\Intent\TrainingPhrase
>
Optional. The collection of examples that the agent is trained on.
↳ action
string
Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.
↳ output_contexts
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>
.
↳ reset_contexts
bool
Optional. Indicates whether to delete all contexts in the current session when this intent is matched.
↳ parameters
array< Google\Cloud\Dialogflow\V2\Intent\Parameter
>
Optional. The collection of parameters associated with the intent.
↳ messages
array< Google\Cloud\Dialogflow\V2\Intent\Message
>
Optional. The collection of rich messages corresponding to the Response
field in the Dialogflow console.
↳ default_response_platforms
array
Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
↳ root_followup_intent_name
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>
.
↳ parent_followup_intent_name
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>
.
↳ followup_intent_info
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.
getName
Optional. The unique identifier of this intent.
Required for Intents.UpdateIntent
and Intents.BatchUpdateIntents
methods.
Format: projects/<Project ID>/agent/intents/<Intent ID>
.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OPTIONAL];
string
setName
Optional. The unique identifier of this intent.
Required for Intents.UpdateIntent
and Intents.BatchUpdateIntents
methods.
Format: projects/<Project ID>/agent/intents/<Intent ID>
.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OPTIONAL];
var
string
$this
getDisplayName
Required. The name of this intent.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
string
setDisplayName
Required. The name of this intent.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
var
string
$this
getWebhookState
Optional. Indicates whether webhooks are enabled for the intent.
Generated from protobuf field .google.cloud.dialogflow.v2.Intent.WebhookState webhook_state = 6 [(.google.api.field_behavior) = OPTIONAL];
int
setWebhookState
Optional. Indicates whether webhooks are enabled for the intent.
Generated from protobuf field .google.cloud.dialogflow.v2.Intent.WebhookState webhook_state = 6 [(.google.api.field_behavior) = OPTIONAL];
var
int
$this
getPriority
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.
Generated from protobuf field int32 priority = 3 [(.google.api.field_behavior) = OPTIONAL];
int
setPriority
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.
Generated from protobuf field int32 priority = 3 [(.google.api.field_behavior) = OPTIONAL];
var
int
$this
getIsFallback
Optional. Indicates whether this is a fallback intent.
Generated from protobuf field bool is_fallback = 4 [(.google.api.field_behavior) = OPTIONAL];
bool
setIsFallback
Optional. Indicates whether this is a fallback intent.
Generated from protobuf field bool is_fallback = 4 [(.google.api.field_behavior) = OPTIONAL];
var
bool
$this
getMlDisabled
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.
Generated from protobuf field bool ml_disabled = 19 [(.google.api.field_behavior) = OPTIONAL];
bool
setMlDisabled
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.
Generated from protobuf field bool ml_disabled = 19 [(.google.api.field_behavior) = OPTIONAL];
var
bool
$this
getLiveAgentHandoff
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.
Generated from protobuf field bool live_agent_handoff = 20 [(.google.api.field_behavior) = OPTIONAL];
bool
setLiveAgentHandoff
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.
Generated from protobuf field bool live_agent_handoff = 20 [(.google.api.field_behavior) = OPTIONAL];
var
bool
$this
getEndInteraction
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.
Generated from protobuf field bool end_interaction = 21 [(.google.api.field_behavior) = OPTIONAL];
bool
setEndInteraction
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.
Generated from protobuf field bool end_interaction = 21 [(.google.api.field_behavior) = OPTIONAL];
var
bool
$this
getInputContextNames
Optional. The list of context names required for this intent to be triggered.
Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
.
Generated from protobuf field repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];
Google\Protobuf\Internal\RepeatedField
setInputContextNames
Optional. The list of context names required for this intent to be triggered.
Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
.
Generated from protobuf field repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];
var
string[]
$this
getEvents
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.
Generated from protobuf field repeated string events = 8 [(.google.api.field_behavior) = OPTIONAL];
Google\Protobuf\Internal\RepeatedField
setEvents
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.
Generated from protobuf field repeated string events = 8 [(.google.api.field_behavior) = OPTIONAL];
var
string[]
$this
getTrainingPhrases
Optional. The collection of examples that the agent is trained on.
Generated from protobuf field repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];
Google\Protobuf\Internal\RepeatedField
setTrainingPhrases
Optional. The collection of examples that the agent is trained on.
Generated from protobuf field repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];
$this
getAction
Optional. The name of the action associated with the intent.
Note: The action name must not contain whitespaces.
Generated from protobuf field string action = 10 [(.google.api.field_behavior) = OPTIONAL];
string
setAction
Optional. The name of the action associated with the intent.
Note: The action name must not contain whitespaces.
Generated from protobuf field string action = 10 [(.google.api.field_behavior) = OPTIONAL];
var
string
$this
getOutputContexts
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>
.
Generated from protobuf field repeated .google.cloud.dialogflow.v2.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];
Google\Protobuf\Internal\RepeatedField
setOutputContexts
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>
.
Generated from protobuf field repeated .google.cloud.dialogflow.v2.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];
$this
getResetContexts
Optional. Indicates whether to delete all contexts in the current session when this intent is matched.
Generated from protobuf field bool reset_contexts = 12 [(.google.api.field_behavior) = OPTIONAL];
bool
setResetContexts
Optional. Indicates whether to delete all contexts in the current session when this intent is matched.
Generated from protobuf field bool reset_contexts = 12 [(.google.api.field_behavior) = OPTIONAL];
var
bool
$this
getParameters
Optional. The collection of parameters associated with the intent.
Generated from protobuf field repeated .google.cloud.dialogflow.v2.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];
Google\Protobuf\Internal\RepeatedField
setParameters
Optional. The collection of parameters associated with the intent.
Generated from protobuf field repeated .google.cloud.dialogflow.v2.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];
$this
getMessages
Optional. The collection of rich messages corresponding to the Response
field in the Dialogflow console.
Generated from protobuf field repeated .google.cloud.dialogflow.v2.Intent.Message messages = 14 [(.google.api.field_behavior) = OPTIONAL];
Google\Protobuf\Internal\RepeatedField
setMessages
Optional. The collection of rich messages corresponding to the Response
field in the Dialogflow console.
Generated from protobuf field repeated .google.cloud.dialogflow.v2.Intent.Message messages = 14 [(.google.api.field_behavior) = OPTIONAL];
$this
getDefaultResponsePlatforms
Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
Generated from protobuf field repeated .google.cloud.dialogflow.v2.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];
Google\Protobuf\Internal\RepeatedField
setDefaultResponsePlatforms
Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
Generated from protobuf field repeated .google.cloud.dialogflow.v2.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];
var
int[]
$this
getRootFollowupIntentName
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>
.
Generated from protobuf field string root_followup_intent_name = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
string
setRootFollowupIntentName
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>
.
Generated from protobuf field string root_followup_intent_name = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
string
$this
getParentFollowupIntentName
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>
.
Generated from protobuf field string parent_followup_intent_name = 17;
string
setParentFollowupIntentName
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>
.
Generated from protobuf field string parent_followup_intent_name = 17;
var
string
$this
getFollowupIntentInfo
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.
Generated from protobuf field repeated .google.cloud.dialogflow.v2.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Internal\RepeatedField
setFollowupIntentInfo
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.
Generated from protobuf field repeated .google.cloud.dialogflow.v2.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
$this