List

Returns the list of all intents in the specified agent

5 variables
50 variables

Returns the list of all intents in the specified agent

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services
  • View, manage and query your Dialogflow agents

Input

This building block consumes 5 input parameters

  = Parameter name
  = Format

parent STRING Required

Required. The agent to list all intents from. Format: projects/<Project ID>/agent

pageToken STRING

Optional. The next_page_token value returned from a previous list request

pageSize INTEGER

Optional. The maximum number of items to return in a single page. By default 100 and at most 1000

intentView ENUMERATION

Optional. The resource view to apply to the returned intent

languageCode STRING

Optional. The language to list training phrases, parameters and rich messages for. 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

Output

This building block provides 50 output parameters

  = Parameter name
  = Format

intents[] OBJECT

Represents an intent. Intents convert a number of user expressions or patterns into an action. An action is an extraction of a user command or sentence semantics

intents[].outputContexts[] OBJECT

Represents a context

intents[].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

intents[].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

intents[].outputContexts[].parameters OBJECT

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

intents[].outputContexts[].parameters.customKey.value ANY

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

intents[].defaultResponsePlatforms[] ENUMERATION

intents[].action STRING

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

intents[].name STRING

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

intents[].messages[] OBJECT

Corresponds to the Response field in the Dialogflow console

intents[].messages[].listSelect OBJECT

The card for presenting a list of options to select from

intents[].messages[].quickReplies OBJECT

The quick replies response message

intents[].messages[].card OBJECT

The card response message

intents[].messages[].basicCard OBJECT

The basic card message. Useful for displaying information

intents[].messages[].carouselSelect OBJECT

The card for presenting a carousel of options to select from

intents[].messages[].linkOutSuggestion OBJECT

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

intents[].messages[].simpleResponses OBJECT

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

intents[].messages[].image OBJECT

The image response message

intents[].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

intents[].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

intents[].messages[].text OBJECT

The text response message

intents[].messages[].platform ENUMERATION

Optional. The platform that this message is intended for

intents[].messages[].suggestions OBJECT

The collection of suggestions

intents[].inputContextNames[] STRING

intents[].webhookState ENUMERATION

Optional. Indicates whether webhooks are enabled for the intent

intents[].followupIntentInfo[] OBJECT

Represents a single followup intent in the chain

intents[].followupIntentInfo[].followupIntentName STRING

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

intents[].followupIntentInfo[].parentFollowupIntentName STRING

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

intents[].displayName STRING

Required. The name of this intent

intents[].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>

intents[].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

intents[].isFallback BOOLEAN

Optional. Indicates whether this is a fallback intent

intents[].parameters[] OBJECT

Represents intent parameters

intents[].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

intents[].parameters[].prompts[] STRING

intents[].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

intents[].parameters[].mandatory BOOLEAN

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

intents[].parameters[].name STRING

The unique identifier of this parameter

intents[].parameters[].isList BOOLEAN

Optional. Indicates whether the parameter represents a list of values

intents[].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.

intents[].parameters[].displayName STRING

Required. The name of the parameter

intents[].resetContexts BOOLEAN

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

intents[].trainingPhrases[] OBJECT

Represents an example that the agent is trained on

intents[].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

intents[].trainingPhrases[].type ENUMERATION

Required. The type of the training phrase

intents[].trainingPhrases[].name STRING

Output only. The unique identifier of this training phrase

intents[].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>

intents[].events[] STRING

intents[].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

nextPageToken STRING

Token to retrieve the next page of results, or empty if there are no more results in the list