REST Resource: projects.locations.agent.intents

Resource: Intent

An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification.

For more information, see the intent guide.

JSON representation 
{
  "name": string,
  "displayName": string,
  "webhookState": enum (WebhookState),
  "priority": integer,
  "isFallback": boolean,
  "mlEnabled": boolean,
  "mlDisabled": boolean,
  "liveAgentHandoff": boolean,
  "endInteraction": boolean,
  "inputContextNames": [
    string
  ],
  "events": [
    string
  ],
  "trainingPhrases": [
    {
      object (TrainingPhrase)
    }
  ],
  "action": string,
  "outputContexts": [
    {
      object (Context)
    }
  ],
  "resetContexts": boolean,
  "parameters": [
    {
      object (Parameter)
    }
  ],
  "messages": [
    {
      object (Message)
    }
  ],
  "defaultResponsePlatforms": [
    enum (Platform)
  ],
  "rootFollowupIntentName": string,
  "parentFollowupIntentName": string,
  "followupIntentInfo": [
    {
      object (FollowupIntentInfo)
    }
  ]
}
Fields
name

string

Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats:

  • projects/<Project ID>/agent/intents/<Intent ID>
  • projects/<Project ID>/locations/<Location ID>/agent/intents/<Intent ID>
displayName

string

Required. The name of this intent.
webhookState

enum (WebhookState)

Optional. Indicates whether webhooks are enabled for the intent.
priority

integer

Optional. 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 Normal priority in the console.
  • If the supplied value is negative, the intent is ignored in runtime detect intent requests.
isFallback

boolean

Optional. Indicates whether this is a fallback intent.
mlEnabled
(deprecated)

boolean

Optional. Indicates whether Machine Learning is enabled for the intent. Note: If mlEnabled setting is set to false, then this intent is not taken into account during inference in ML ONLY match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use mlDisabled field instead. NOTE: If both mlEnabled and mlDisabled are either not set or false, then the default value is determined as follows:

  • Before April 15th, 2018 the default is: mlEnabled = false / mlDisabled = true.
  • After April 15th, 2018 the default is: mlEnabled = true / mlDisabled = false.
mlDisabled

boolean

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

boolean

Optional. Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set endInteraction to true as well. Default is false.
endInteraction

boolean

Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.
inputContextNames[]

string

Optional. The list of context names required for this intent to be triggered. Formats:

  • projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
  • projects/<Project ID>/locations/<Location ID>/agent/sessions/-/contexts/<Context ID>
events[]

string

Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.
trainingPhrases[]

object (TrainingPhrase)

Optional. The collection of examples that the agent is trained on.
action

string

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

object (Context)

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespanCount to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.
resetContexts

boolean

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

object (Parameter)

Optional. The collection of parameters associated with the intent.
messages[]

object (Message)

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.
defaultResponsePlatforms[]

enum (Platform)

Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
rootFollowupIntentName

string

Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent.

Format: projects/<Project ID>/agent/intents/<Intent ID>.
parentFollowupIntentName

string

Optional. 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 intents.create or intents.batchUpdate, in order to make this intent a followup intent.

It identifies the parent followup intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.
followupIntentInfo[]

object (FollowupIntentInfo)

Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

Methods

batchDelete

 Deletes intents in the specified agent.

batchUpdate

 Updates/Creates multiple intents in the specified agent.

create

 Creates an intent in the specified agent.

delete

 Deletes the specified intent and its direct or indirect followup intents.

get

 Retrieves the specified intent.

list

 Returns the list of all intents in the specified agent.

patch

 Updates the specified intent.