Intent
Stay organized with collections
Save and categorize content based on your preferences.
Intents map open-ended user input to structured objects. Spoken phrases are matched to intents with Google's Natural Language Understanding (NLU). Intent matches can trigger events in your conversation design to progress the user's conversation. The intent name is specified in the name of the file.
| YAML representation |
parameters:
- object (IntentParameter)
trainingPhrases:
- string |
| Fields |
parameters[] |
object (IntentParameter)
The list of parameters within the training phrases. All parameters must be defined here to be used in the training phrase.
|
trainingPhrases[] |
string
Training phrases allow Google’s NLU to automatically match intents with user input. The more unique phrases that are provided, the better chance this intent will be matched. The following is the format of training phrase part which are annotated. Note that auto field is optional and the default behavior when auto is not specified is equivalent to auto=false. ($<paramName> '<sample text>' auto=<true or false>) auto = true means the part was auto annotated by NLU. auto = false means the part was annotated by the user. This is the default when auto is not specified. Example: "Book a flight from ($source 'San Francisco' auto=false) to ($dest 'Vancouver')"
|
IntentParameter
Definition of a parameter which can be used inside training phrases.
| YAML representation |
name: string
# Union field parameter_type can be only one of the following:
type:
object (ClassReference)
entitySetReferences:
object (EntitySetReferences)
# End of list of possible types for union field parameter_type. |
| Fields |
name |
string
Required. Unique name of the intent parameter. Can be used in conditions and responses to reference intent parameters extracted by NLU with $intent.params.[name].resolved
|
Union field parameter_type. The type of the intent parameter. parameter_type can be only one of the following: |
type |
object (ClassReference)
Optional. Declares the data type of this parameter. This should not be set for built-in intents.
|
entitySetReferences |
object (EntitySetReferences)
Optional. References to the sets of allowed entities for this intent parameter. Only valid for parameters of a built-in intent. These references point to entity sets in the 'custom/entitySets' directory.
|
EntitySetReferences
Entity set references for an intent parameter.
| Fields |
entitySetReferences[] |
object (EntitySetReference)
Required. Entity set references for an intent parameter.
|
EntitySetReference
A reference to the set of allowed entities for this intent parameter.
| YAML representation |
entitySet: string |
| Fields |
entitySet |
string
Required. Identifies the specific collection of entities to be considered for a given parameter. The corresponding entity set definition should be present in the custom/entitySets/ directory.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eIntents utilize Google's Natural Language Understanding (NLU) to match spoken phrases with user input, triggering events within a conversation design.\u003c/p\u003e\n"],["\u003cp\u003eIntent parameters are defined within training phrases, specifying data types and referencing allowed entities for built-in intents.\u003c/p\u003e\n"],["\u003cp\u003eEntity set references identify specific collections of entities for a given parameter, linking to definitions in the custom/entitySets/ directory.\u003c/p\u003e\n"],["\u003cp\u003eTraining phrases, incorporating parameters and entity references, enable Google's NLU to accurately match intents with user input, improving the conversational experience.\u003c/p\u003e\n"]]],[],null,["- [YAML representation](#SCHEMA_REPRESENTATION)\n- [IntentParameter](#IntentParameter)\n - [YAML representation](#IntentParameter.SCHEMA_REPRESENTATION)\n- [EntitySetReferences](#EntitySetReferences)\n - [YAML representation](#EntitySetReferences.SCHEMA_REPRESENTATION)\n- [EntitySetReference](#EntitySetReference)\n - [YAML representation](#EntitySetReference.SCHEMA_REPRESENTATION)\n\nIntents map open-ended user input to structured objects. Spoken phrases are matched to intents with Google's Natural Language Understanding (NLU). Intent matches can trigger events in your conversation design to progress the user's conversation. The intent name is specified in the name of the file.\n\n| YAML representation ||\n|-----------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` parameters: - object (/assistant/actionssdk/reference/rest/Shared.Types/Intent#IntentParameter) trainingPhrases: - string ``` |\n\n| Fields ||\n|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parameters[]` | `object (`[IntentParameter](/assistant/actionssdk/reference/rest/Shared.Types/Intent#IntentParameter)`)` The list of parameters within the training phrases. All parameters must be defined here to be used in the training phrase. |\n| `trainingPhrases[]` | `string` Training phrases allow Google's NLU to automatically match intents with user input. The more unique phrases that are provided, the better chance this intent will be matched. The following is the format of training phrase part which are annotated. Note that `auto` field is optional and the default behavior when `auto` is not specified is equivalent to `auto=false`. `($\u003cparamName\u003e '\u003csample text\u003e' auto=\u003ctrue or false\u003e)` `auto = true` means the part was auto annotated by NLU. `auto = false` means the part was annotated by the user. This is the default when auto is not specified. Example: \"Book a flight from ($source 'San Francisco' auto=false) to ($dest 'Vancouver')\" |\n\nIntentParameter Definition of a parameter which can be used inside training phrases.\n\n| YAML representation ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` name: string # Union field `parameter_type` can be only one of the following: type: object (/assistant/actionssdk/reference/rest/Shared.Types/ClassReference) entitySetReferences: object (/assistant/actionssdk/reference/rest/Shared.Types/Intent#EntitySetReferences) # End of list of possible types for union field `parameter_type`. ``` |\n\n| Fields ||\n|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| `name` | `string` Required. Unique name of the intent parameter. Can be used in conditions and responses to reference intent parameters extracted by NLU with $intent.params.\\[name\\].resolved |\n| Union field `parameter_type`. The type of the intent parameter. `parameter_type` can be only one of the following: |||\n| `type` | `object (`[ClassReference](/assistant/actionssdk/reference/rest/Shared.Types/ClassReference)`)` Optional. Declares the data type of this parameter. This should not be set for built-in intents. |\n| `entitySetReferences` | `object (`[EntitySetReferences](/assistant/actionssdk/reference/rest/Shared.Types/Intent#EntitySetReferences)`)` Optional. References to the sets of allowed entities for this intent parameter. Only valid for parameters of a built-in intent. These references point to entity sets in the 'custom/entitySets' directory. |\n\nEntitySetReferences Entity set references for an intent parameter.\n\n| YAML representation ||\n|---------------------------------------------------------------------------------------------------------------------|---|\n| ``` entitySetReferences: - object (/assistant/actionssdk/reference/rest/Shared.Types/Intent#EntitySetReference) ``` |\n\n| Fields ||\n|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `entitySetReferences[]` | `object (`[EntitySetReference](/assistant/actionssdk/reference/rest/Shared.Types/Intent#EntitySetReference)`)` Required. Entity set references for an intent parameter. |\n\nEntitySetReference A reference to the set of allowed entities for this intent parameter.\n\n| YAML representation ||\n|---------------------------|---|\n| ``` entitySet: string ``` |\n\n| Fields ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `entitySet` | `string` Required. Identifies the specific collection of entities to be considered for a given parameter. The corresponding entity set definition should be present in the custom/entitySets/ directory. |"]]
