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 message google.cloud.dialogflow.cx.v3.Intent
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: |
↳ display_name |
string
Required. The human-readable name of the intent, unique within the agent. |
↳ training_phrases |
array<Google\Cloud\Dialogflow\Cx\V3\Intent\TrainingPhrase>
The collection of training phrases the agent is trained on to identify the intent. |
↳ parameters |
array<Google\Cloud\Dialogflow\Cx\V3\Intent\Parameter>
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 the |
↳ 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. |
↳ labels |
array|Google\Protobuf\Internal\MapField
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 the
Intents.UpdateIntent
method.
Intents.CreateIntent
populates the name automatically.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/intents/<Intent ID>.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The unique identifier of the intent.
Required for the
Intents.UpdateIntent
method.
Intents.CreateIntent
populates the name automatically.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/intents/<Intent ID>.
| 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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setTrainingPhrases
The collection of training phrases the agent is trained on to identify the intent.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dialogflow\Cx\V3\Intent\TrainingPhrase>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParameters
The collection of parameters associated with the intent.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setParameters
The collection of parameters associated with the intent.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dialogflow\Cx\V3\Intent\Parameter>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPriority
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
Normalpriority 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 the
Normalpriority 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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |