Google Cloud Dialogflow V2 Client - Class Intent (1.14.0)

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

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

Parameters
Name Description
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>.

Returns
Type Description
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>.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Required. The name of this intent.

Returns
Type Description
string

setDisplayName

Required. The name of this intent.

Parameter
Name Description
var string
Returns
Type Description
$this

getWebhookState

Optional. Indicates whether webhooks are enabled for the intent.

Returns
Type Description
int

setWebhookState

Optional. Indicates whether webhooks are enabled for the intent.

Parameter
Name Description
var int
Returns
Type Description
$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.
Returns
Type Description
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.
Parameter
Name Description
var int
Returns
Type Description
$this

getIsFallback

Optional. Indicates whether this is a fallback intent.

Returns
Type Description
bool

setIsFallback

Optional. Indicates whether this is a fallback intent.

Parameter
Name Description
var bool
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var bool
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var bool
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getInputContextNames

Optional. The list of context names required for this intent to be triggered.

Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

Returns
Type Description
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>.

Parameter
Name Description
var string[]
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getTrainingPhrases

Optional. The collection of examples that the agent is trained on.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTrainingPhrases

Optional. The collection of examples that the agent is trained on.

Parameter
Name Description
var array<Google\Cloud\Dialogflow\V2\Intent\TrainingPhrase>
Returns
Type Description
$this

getAction

Optional. The name of the action associated with the intent.

Note: The action name must not contain whitespaces.

Returns
Type Description
string

setAction

Optional. The name of the action associated with the intent.

Note: The action name must not contain whitespaces.

Parameter
Name Description
var string
Returns
Type Description
$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>.

Returns
Type Description
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>.

Parameter
Name Description
var array<Google\Cloud\Dialogflow\V2\Context>
Returns
Type Description
$this

getResetContexts

Optional. Indicates whether to delete all contexts in the current session when this intent is matched.

Returns
Type Description
bool

setResetContexts

Optional. Indicates whether to delete all contexts in the current session when this intent is matched.

Parameter
Name Description
var bool
Returns
Type Description
$this

getParameters

Optional. The collection of parameters associated with the intent.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setParameters

Optional. The collection of parameters associated with the intent.

Parameter
Name Description
var array<Google\Cloud\Dialogflow\V2\Intent\Parameter>
Returns
Type Description
$this

getMessages

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setMessages

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

Parameter
Name Description
var array<Google\Cloud\Dialogflow\V2\Intent\Message>
Returns
Type Description
$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).

Returns
Type Description
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).

Parameter
Name Description
var int[]
Returns
Type Description
$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>.

Returns
Type Description
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>.

Parameter
Name Description
var string
Returns
Type Description
$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>.

Returns
Type Description
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>.

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var array<Google\Cloud\Dialogflow\V2\Intent\FollowupIntentInfo>
Returns
Type Description
$this