REST Resource: projects.agent.intents

Resource: Intent

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.

JSON representation
{
  "name": string,
  "displayName": string,
  "webhookState": enum(WebhookState),
  "priority": number,
  "isFallback": boolean,
  "mlEnabled": boolean,
  "mlDisabled": 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

Required for all methods except create (create populates the name automatically. The unique identifier of this intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

displayName

string

Required. The name of this intent.

webhookState

enum(WebhookState)

Required. Indicates whether webhooks are enabled for the intent.

priority

number

Optional. The priority of this intent. Higher numbers represent higher priorities. Zero or negative numbers mean that the intent is disabled.

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.

inputContextNames[]

string

Optional. The list of context names required for this intent to be triggered. Format: projects/<Project 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.

trainingPhrases[]

object(TrainingPhrase)

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

action

string

Optional. The name of the action associated with the intent.

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 response will be taken from among the messages assigned to the DEFAULT_PLATFORM.

rootFollowupIntentName

string

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

The unique identifier of the parent intent in the chain of followup intents. It identifies the parent followup intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

followupIntentInfo[]

object(FollowupIntentInfo)

Optional. Collection of information about all followup intents that have name of this intent as a root_name.

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.

get

Retrieves the specified intent.

list

Returns the list of all intents in the specified agent.

patch

Updates the specified intent.