parent STRING Required

Required. The agent to create a intent for. Format: projects/<Project ID>/agent

intentView ENUMERATION

Optional. The resource view to apply to the returned intent

languageCode STRING

Optional. The language of training phrases, parameters and rich messages defined in intent. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used

outputContexts[] OBJECT

Represents a context

outputContexts[].lifespanCount INTEGER

Optional. The number of conversational query requests after which the context expires. If set to 0 (the default) the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries

outputContexts[].name STRING

Required. The unique identifier of the context. Format: projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>.

The Context ID is always converted to lowercase, may only contain characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long

outputContexts[].parameters OBJECT

Optional. The collection of parameters associated with this context. Refer to this doc for syntax

outputContexts[].parameters.customKey.value ANY Required

Optional. The collection of parameters associated with this context. Refer to this doc for syntax

defaultResponsePlatforms[] ENUMERATION

action STRING

Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces

name STRING

The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: projects/<Project ID>/agent/intents/<Intent ID>

messages[] OBJECT

Corresponds to the Response field in the Dialogflow console

messages[].listSelect OBJECT

The card for presenting a list of options to select from

messages[].listSelect.items[] OBJECT

An item in the list

messages[].listSelect.title STRING

Optional. The overall title of the list

messages[].quickReplies OBJECT

The quick replies response message

messages[].quickReplies.quickReplies[] STRING

messages[].quickReplies.title STRING

Optional. The title of the collection of quick replies

messages[].card OBJECT

The card response message

messages[].card.title STRING

Optional. The title of the card

messages[].card.buttons[] OBJECT

Optional. Contains information about a button

messages[].card.subtitle STRING

Optional. The subtitle of the card

messages[].card.imageUri STRING

Optional. The public URI to an image file for the card

messages[].basicCard OBJECT

The basic card message. Useful for displaying information

messages[].basicCard.title STRING

Optional. The title of the card

messages[].basicCard.image OBJECT

The image response message

messages[].basicCard.image.imageUri STRING

Optional. The public URI to an image file

messages[].basicCard.image.accessibilityText STRING

Optional. A text description of the image to be used for accessibility, e.g., screen readers

messages[].basicCard.formattedText STRING

Required, unless image is present. The body text of the card

messages[].basicCard.buttons[] OBJECT

The button object that appears at the bottom of a card

messages[].basicCard.subtitle STRING

Optional. The subtitle of the card

messages[].carouselSelect OBJECT

The card for presenting a carousel of options to select from

messages[].carouselSelect.items[] OBJECT

An item in the carousel

messages[].linkOutSuggestion OBJECT

The suggestion chip message that allows the user to jump out to the app or website associated with this agent

messages[].linkOutSuggestion.destinationName STRING

Required. The name of the app or site this chip is linking to

messages[].linkOutSuggestion.uri STRING

Required. The URI of the app or site to open when the user taps the suggestion chip

messages[].simpleResponses OBJECT

The collection of simple response candidates. This message in QueryResult.fulfillment_messages and WebhookResponse.fulfillment_messages should contain only one SimpleResponse

messages[].simpleResponses.simpleResponses[] OBJECT

The simple response message containing speech or text

messages[].image OBJECT

The image response message

messages[].image.imageUri STRING

Optional. The public URI to an image file

messages[].image.accessibilityText STRING

Optional. A text description of the image to be used for accessibility, e.g., screen readers

messages[].payload OBJECT

Returns a response containing a custom, platform-specific payload. See the Intent.Message.Platform type for a description of the structure that may be required for your platform

messages[].payload.customKey.value ANY Required

Returns a response containing a custom, platform-specific payload. See the Intent.Message.Platform type for a description of the structure that may be required for your platform

messages[].text OBJECT

The text response message

messages[].text.text[] STRING

messages[].platform ENUMERATION

Optional. The platform that this message is intended for

messages[].suggestions OBJECT

The collection of suggestions

messages[].suggestions.suggestions[] OBJECT

The suggestion chip message that the user can tap to quickly post a reply to the conversation

inputContextNames[] STRING

webhookState ENUMERATION

Optional. Indicates whether webhooks are enabled for the intent

followupIntentInfo[] OBJECT

Represents a single followup intent in the chain

followupIntentInfo[].followupIntentName STRING

The unique identifier of the followup intent. Format: projects/<Project ID>/agent/intents/<Intent ID>

followupIntentInfo[].parentFollowupIntentName STRING

The unique identifier of the followup intent's parent. Format: projects/<Project ID>/agent/intents/<Intent ID>

displayName STRING

Required. The name of this intent

rootFollowupIntentName STRING

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>

mlDisabled BOOLEAN

Optional. Indicates whether Machine Learning is disabled for the intent. Note: If ml_diabled 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

isFallback BOOLEAN

Optional. Indicates whether this is a fallback intent

parameters[] OBJECT

Represents intent parameters

parameters[].entityTypeDisplayName STRING

Optional. The name of the entity type, prefixed with @, that describes values of the parameter. If the parameter is required, this must be provided

parameters[].prompts[] STRING

parameters[].defaultValue STRING

Optional. The default value to use when the value yields an empty result. Default values can be extracted from contexts by using the following syntax: #context_name.parameter_name

parameters[].mandatory BOOLEAN

Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value

parameters[].name STRING

The unique identifier of this parameter

parameters[].isList BOOLEAN

Optional. Indicates whether the parameter represents a list of values

parameters[].value STRING

Optional. The definition of the parameter value. It can be:

• a constant string,
• a parameter value defined as $parameter_name,
• an original parameter value defined as $parameter_name.original,
• a parameter value from some context defined as #context_name.parameter_name.

parameters[].displayName STRING

Required. The name of the parameter

resetContexts BOOLEAN

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

trainingPhrases[] OBJECT

Represents an example that the agent is trained on

trainingPhrases[].timesAddedCount INTEGER

Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased

trainingPhrases[].type ENUMERATION

Required. The type of the training phrase

trainingPhrases[].parts[] OBJECT

Represents a part of a training phrase

trainingPhrases[].parts[].text STRING

Required. The text for this part

trainingPhrases[].parts[].entityType STRING

Optional. The entity type name prefixed with @. This field is required for annotated parts of the training phrase

trainingPhrases[].parts[].alias STRING

Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase

trainingPhrases[].parts[].userDefined BOOLEAN

Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true

trainingPhrases[].name STRING

Output only. The unique identifier of this training phrase

parentFollowupIntentName 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>

events[] STRING

priority INTEGER

Optional. The priority of this intent. Higher numbers represent higher priorities. If this is zero or unspecified, we use the default priority 500000.

Negative numbers mean that the intent is disabled

outputContexts[] OBJECT

Represents a context

outputContexts[].lifespanCount INTEGER

Optional. The number of conversational query requests after which the context expires. If set to 0 (the default) the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries

outputContexts[].name STRING

Required. The unique identifier of the context. Format: projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>.

The Context ID is always converted to lowercase, may only contain characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long

outputContexts[].parameters OBJECT

Optional. The collection of parameters associated with this context. Refer to this doc for syntax

outputContexts[].parameters.customKey.value ANY

Optional. The collection of parameters associated with this context. Refer to this doc for syntax

defaultResponsePlatforms[] ENUMERATION

action STRING

Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces

name STRING

The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: projects/<Project ID>/agent/intents/<Intent ID>

messages[] OBJECT

Corresponds to the Response field in the Dialogflow console

messages[].listSelect OBJECT

The card for presenting a list of options to select from

messages[].listSelect.items[] OBJECT

An item in the list

messages[].listSelect.title STRING

Optional. The overall title of the list

messages[].quickReplies OBJECT

The quick replies response message

messages[].quickReplies.quickReplies[] STRING

messages[].quickReplies.title STRING

Optional. The title of the collection of quick replies

messages[].card OBJECT

The card response message

messages[].card.title STRING

Optional. The title of the card

messages[].card.buttons[] OBJECT

Optional. Contains information about a button

messages[].card.subtitle STRING

Optional. The subtitle of the card

messages[].card.imageUri STRING

Optional. The public URI to an image file for the card

messages[].basicCard OBJECT

The basic card message. Useful for displaying information

messages[].basicCard.title STRING

Optional. The title of the card

messages[].basicCard.image OBJECT

The image response message

messages[].basicCard.image.imageUri STRING

Optional. The public URI to an image file

messages[].basicCard.image.accessibilityText STRING

Optional. A text description of the image to be used for accessibility, e.g., screen readers

messages[].basicCard.formattedText STRING

Required, unless image is present. The body text of the card

messages[].basicCard.buttons[] OBJECT

The button object that appears at the bottom of a card

messages[].basicCard.subtitle STRING

Optional. The subtitle of the card

messages[].carouselSelect OBJECT

The card for presenting a carousel of options to select from

messages[].carouselSelect.items[] OBJECT

An item in the carousel

messages[].linkOutSuggestion OBJECT

The suggestion chip message that allows the user to jump out to the app or website associated with this agent

messages[].linkOutSuggestion.destinationName STRING

Required. The name of the app or site this chip is linking to

messages[].linkOutSuggestion.uri STRING

Required. The URI of the app or site to open when the user taps the suggestion chip

messages[].simpleResponses OBJECT

The collection of simple response candidates. This message in QueryResult.fulfillment_messages and WebhookResponse.fulfillment_messages should contain only one SimpleResponse

messages[].simpleResponses.simpleResponses[] OBJECT

The simple response message containing speech or text

messages[].image OBJECT

The image response message

messages[].image.imageUri STRING

Optional. The public URI to an image file

messages[].image.accessibilityText STRING

Optional. A text description of the image to be used for accessibility, e.g., screen readers

messages[].payload OBJECT

Returns a response containing a custom, platform-specific payload. See the Intent.Message.Platform type for a description of the structure that may be required for your platform

messages[].payload.customKey.value ANY

Returns a response containing a custom, platform-specific payload. See the Intent.Message.Platform type for a description of the structure that may be required for your platform

messages[].text OBJECT

The text response message

messages[].text.text[] STRING

messages[].platform ENUMERATION

Optional. The platform that this message is intended for

messages[].suggestions OBJECT

The collection of suggestions

messages[].suggestions.suggestions[] OBJECT

The suggestion chip message that the user can tap to quickly post a reply to the conversation

inputContextNames[] STRING

webhookState ENUMERATION

Optional. Indicates whether webhooks are enabled for the intent

followupIntentInfo[] OBJECT

Represents a single followup intent in the chain

followupIntentInfo[].followupIntentName STRING

The unique identifier of the followup intent. Format: projects/<Project ID>/agent/intents/<Intent ID>

followupIntentInfo[].parentFollowupIntentName STRING

The unique identifier of the followup intent's parent. Format: projects/<Project ID>/agent/intents/<Intent ID>

displayName STRING

Required. The name of this intent

rootFollowupIntentName STRING

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>

mlDisabled BOOLEAN

Optional. Indicates whether Machine Learning is disabled for the intent. Note: If ml_diabled 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

isFallback BOOLEAN

Optional. Indicates whether this is a fallback intent

parameters[] OBJECT

Represents intent parameters

parameters[].entityTypeDisplayName STRING

Optional. The name of the entity type, prefixed with @, that describes values of the parameter. If the parameter is required, this must be provided

parameters[].prompts[] STRING

parameters[].defaultValue STRING

Optional. The default value to use when the value yields an empty result. Default values can be extracted from contexts by using the following syntax: #context_name.parameter_name

parameters[].mandatory BOOLEAN

Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value

parameters[].name STRING

The unique identifier of this parameter

parameters[].isList BOOLEAN

Optional. Indicates whether the parameter represents a list of values

parameters[].value STRING

Optional. The definition of the parameter value. It can be:

• a constant string,
• a parameter value defined as $parameter_name,
• an original parameter value defined as $parameter_name.original,
• a parameter value from some context defined as #context_name.parameter_name.

parameters[].displayName STRING

Required. The name of the parameter

resetContexts BOOLEAN

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

trainingPhrases[] OBJECT

Represents an example that the agent is trained on

trainingPhrases[].timesAddedCount INTEGER

Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased

trainingPhrases[].type ENUMERATION

Required. The type of the training phrase

trainingPhrases[].parts[] OBJECT

Represents a part of a training phrase

trainingPhrases[].parts[].text STRING

Required. The text for this part

trainingPhrases[].parts[].entityType STRING

Optional. The entity type name prefixed with @. This field is required for annotated parts of the training phrase

trainingPhrases[].parts[].alias STRING

Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase

trainingPhrases[].parts[].userDefined BOOLEAN

Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true

trainingPhrases[].name STRING

Output only. The unique identifier of this training phrase

parentFollowupIntentName 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>

events[] STRING

priority INTEGER

Optional. The priority of this intent. Higher numbers represent higher priorities. If this is zero or unspecified, we use the default priority 500000.

Negative numbers mean that the intent is disabled