Agent

Represents a conversational agent.

JSON representation
{
  "parent": string,
  "displayName": string,
  "defaultLanguageCode": string,
  "supportedLanguageCodes": [
    string
  ],
  "timeZone": string,
  "description": string,
  "avatarUri": string,
  "enableLogging": boolean,
  "matchMode": enum(MatchMode),
  "classificationThreshold": number
}
Fields
parent

string

Required. The project of this agent. Format: projects/<Project ID>.

displayName

string

Required. The name of this agent.

defaultLanguageCode

string

Required. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the Update method.

supportedLanguageCodes[]

string

Optional. The list of all languages supported by this agent (except for the defaultLanguageCode).

timeZone

string

Required. The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.

description

string

Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.

avatarUri

string

Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

enableLogging

boolean

Optional. Determines whether this agent should log conversation queries.

matchMode

enum(MatchMode)

Optional. Determines how intents are detected from user queries.

classificationThreshold

number

Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent is be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.

MatchMode

Match mode determines how intents are detected from user queries.

Enums
MATCH_MODE_UNSPECIFIED Not specified.
MATCH_MODE_HYBRID Best for agents with a small number of examples in intents and/or wide use of templates syntax and composite entities.
MATCH_MODE_ML_ONLY Can be used for agents with a large number of examples in intents, especially the ones using @sys.any or very large developer entities.
Was this page helpful? Let us know how we did:

Send feedback about...

Dialogflow Enterprise Edition