Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class Intent.
An intent represents a user's intent to interact with a conversational agent.
You can provide information for the Dialogflow API to use to match user input
to an intent by adding training phrases (i.e., examples of user input) to
your intent.
Generated from protobuf messagegoogle.cloud.dialogflow.cx.v3.Intent
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
The unique identifier of the intent. Required for theIntents.UpdateIntentmethod.Intents.CreateIntentpopulates the name automatically. Format:projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>.
↳ display_name
string
Required. The human-readable name of the intent, unique within the agent.
The collection of parameters associated with the intent.
↳ priority
int
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 theNormalpriority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.
↳ is_fallback
bool
Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * * sys-head * * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent.
↳ description
string
Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
getName
The unique identifier of the intent.
Required for theIntents.UpdateIntentmethod.Intents.CreateIntentpopulates the name automatically.
Format:projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>.
Returns
Type
Description
string
setName
The unique identifier of the intent.
Required for theIntents.UpdateIntentmethod.Intents.CreateIntentpopulates the name automatically.
Format:projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDisplayName
Required. The human-readable name of the intent, unique within the agent.
Returns
Type
Description
string
setDisplayName
Required. The human-readable name of the intent, unique within the agent.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getTrainingPhrases
The collection of training phrases the agent is trained on to identify the
intent.
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 theNormalpriority in the console.
If the supplied value is negative, the intent is ignored
in runtime detect intent requests.
Returns
Type
Description
int
setPriority
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 theNormalpriority 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
Indicates whether this is a fallback intent. Currently only default
fallback intent is allowed in the agent, which is added upon agent
creation.
Adding training phrases to fallback intent is useful in the case of
requests that are mistakenly matched, since training phrases assigned to
fallback intents act as negative examples that triggers no-match event.
Returns
Type
Description
bool
setIsFallback
Indicates whether this is a fallback intent. Currently only default
fallback intent is allowed in the agent, which is added upon agent
creation.
Adding training phrases to fallback intent is useful in the case of
requests that are mistakenly matched, since training phrases assigned to
fallback intents act as negative examples that triggers no-match event.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getLabels
The key/value metadata to label an intent. Labels can contain
lowercase letters, digits and the symbols '-' and '_'. International
characters are allowed, including letters from unicase alphabets. Keys must
start with a letter. Keys and values can be no longer than 63 characters
and no more than 128 bytes.
Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed
Dialogflow defined labels include:
sys-head
sys-contextual
The above labels do not require value. "sys-head" means the intent is a
head intent. "sys.contextual" means the intent is a contextual intent.
The key/value metadata to label an intent. Labels can contain
lowercase letters, digits and the symbols '-' and '_'. International
characters are allowed, including letters from unicase alphabets. Keys must
start with a letter. Keys and values can be no longer than 63 characters
and no more than 128 bytes.
Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed
Dialogflow defined labels include:
sys-head
sys-contextual
The above labels do not require value. "sys-head" means the intent is a
head intent. "sys.contextual" means the intent is a contextual intent.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dialogflow Cx V3 Client - Class Intent (0.8.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.8.1 (latest)](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Intent)\n- [0.8.0](/php/docs/reference/cloud-dialogflow-cx/0.8.0/V3.Intent)\n- [0.7.2](/php/docs/reference/cloud-dialogflow-cx/0.7.2/V3.Intent)\n- [0.6.0](/php/docs/reference/cloud-dialogflow-cx/0.6.0/V3.Intent)\n- [0.5.2](/php/docs/reference/cloud-dialogflow-cx/0.5.2/V3.Intent)\n- [0.4.1](/php/docs/reference/cloud-dialogflow-cx/0.4.1/V3.Intent)\n- [0.3.4](/php/docs/reference/cloud-dialogflow-cx/0.3.4/V3.Intent)\n- [0.2.1](/php/docs/reference/cloud-dialogflow-cx/0.2.1/V3.Intent)\n- [0.1.1](/php/docs/reference/cloud-dialogflow-cx/0.1.1/V3.Intent) \nReference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class Intent.\n\nAn intent represents a user's intent to interact with a conversational agent.\n\nYou can provide information for the Dialogflow API to use to match user input\nto an intent by adding training phrases (i.e., examples of user input) to\nyour intent.\n\nGenerated from protobuf message `google.cloud.dialogflow.cx.v3.Intent`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dialogflow \\\\ Cx \\\\ V3\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nThe unique identifier of the intent.\n\nRequired for the\n[Intents.UpdateIntent](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Client.IntentsClient#_Google_Cloud_Dialogflow_Cx_V3_Client_IntentsClient__updateIntent__)\nmethod.\n[Intents.CreateIntent](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Client.IntentsClient#_Google_Cloud_Dialogflow_Cx_V3_Client_IntentsClient__createIntent__)\npopulates the name automatically.\nFormat:\n`projects/\u003cProjectID\u003e/locations/\u003cLocationID\u003e/agents/\u003cAgentID\u003e/intents/\u003cIntentID\u003e`.\n\n### setName\n\nThe unique identifier of the intent.\n\nRequired for the\n[Intents.UpdateIntent](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Client.IntentsClient#_Google_Cloud_Dialogflow_Cx_V3_Client_IntentsClient__updateIntent__)\nmethod.\n[Intents.CreateIntent](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Client.IntentsClient#_Google_Cloud_Dialogflow_Cx_V3_Client_IntentsClient__createIntent__)\npopulates the name automatically.\nFormat:\n`projects/\u003cProjectID\u003e/locations/\u003cLocationID\u003e/agents/\u003cAgentID\u003e/intents/\u003cIntentID\u003e`.\n\n### getDisplayName\n\nRequired. The human-readable name of the intent, unique within the agent.\n\n### setDisplayName\n\nRequired. The human-readable name of the intent, unique within the agent.\n\n### getTrainingPhrases\n\nThe collection of training phrases the agent is trained on to identify the\nintent.\n\n### setTrainingPhrases\n\nThe collection of training phrases the agent is trained on to identify the\nintent.\n\n### getParameters\n\nThe collection of parameters associated with the intent.\n\n### setParameters\n\nThe collection of parameters associated with the intent.\n\n### getPriority\n\nThe priority of this intent. Higher numbers represent higher\npriorities.\n\n- 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.\n- If the supplied value is negative, the intent is ignored in runtime detect intent requests.\n\n### setPriority\n\nThe priority of this intent. Higher numbers represent higher\npriorities.\n\n- 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.\n- If the supplied value is negative, the intent is ignored in runtime detect intent requests.\n\n### getIsFallback\n\nIndicates whether this is a fallback intent. Currently only default\nfallback intent is allowed in the agent, which is added upon agent\ncreation.\n\nAdding training phrases to fallback intent is useful in the case of\nrequests that are mistakenly matched, since training phrases assigned to\nfallback intents act as negative examples that triggers no-match event.\n\n### setIsFallback\n\nIndicates whether this is a fallback intent. Currently only default\nfallback intent is allowed in the agent, which is added upon agent\ncreation.\n\nAdding training phrases to fallback intent is useful in the case of\nrequests that are mistakenly matched, since training phrases assigned to\nfallback intents act as negative examples that triggers no-match event.\n\n### getLabels\n\nThe key/value metadata to label an intent. Labels can contain\nlowercase letters, digits and the symbols '-' and '_'. International\ncharacters are allowed, including letters from unicase alphabets. Keys must\nstart with a letter. Keys and values can be no longer than 63 characters\nand no more than 128 bytes.\n\nPrefix \"sys-\" is reserved for Dialogflow defined labels. Currently allowed\nDialogflow defined labels include:\n\n- sys-head\n- sys-contextual The above labels do not require value. \"sys-head\" means the intent is a head intent. \"sys.contextual\" means the intent is a contextual intent.\n\n### setLabels\n\nThe key/value metadata to label an intent. Labels can contain\nlowercase letters, digits and the symbols '-' and '_'. International\ncharacters are allowed, including letters from unicase alphabets. Keys must\nstart with a letter. Keys and values can be no longer than 63 characters\nand no more than 128 bytes.\n\nPrefix \"sys-\" is reserved for Dialogflow defined labels. Currently allowed\nDialogflow defined labels include:\n\n- sys-head\n- sys-contextual The above labels do not require value. \"sys-head\" means the intent is a head intent. \"sys.contextual\" means the intent is a contextual intent.\n\n### getDescription\n\nHuman readable description for better understanding an intent like its\nscope, content, result etc. Maximum character limit: 140 characters.\n\n### setDescription\n\nHuman readable description for better understanding an intent like its\nscope, content, result etc. Maximum character limit: 140 characters."]]
