REST Resource: projects.locations.agents

Resource: Agent

Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way.

After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.

JSON representation 
{
  "name": string,
  "displayName": string,
  "defaultLanguageCode": string,
  "supportedLanguageCodes": [
    string
  ],
  "timeZone": string,
  "description": string,
  "avatarUri": string,
  "speechToTextSettings": {
    object (SpeechToTextSettings)
  },
  "securitySettings": string,
  "enableStackdriverLogging": boolean,
  "enableSpellCorrection": boolean,
  "enableMultiLanguageTraining": boolean,
  "locked": boolean,
  "advancedSettings": {
    object (AdvancedSettings)
  },
  "gitIntegrationSettings": {
    object (GitIntegrationSettings)
  },
  "bigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "textToSpeechSettings": {
    object (TextToSpeechSettings)
  },
  "answerFeedbackSettings": {
    object (AnswerFeedbackSettings)
  },
  "personalizationSettings": {
    object (PersonalizationSettings)
  },
  "clientCertificateSettings": {
    object (ClientCertificateSettings)
  },

  // Union field session_entry_resource can be only one of the following:
  "startFlow": string,
  "startPlaybook": string
  // End of list of possible types for union field session_entry_resource.
  "genAppBuilderSettings": {
    object (GenAppBuilderSettings)
  }
}
Fields
name

string

The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
displayName

string

Required. The human-readable name of the agent, unique within the location.
defaultLanguageCode

string

Required. Immutable. 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 Agents.UpdateAgent method.
supportedLanguageCodes[]

string

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

string

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

string

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

string

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

object (SpeechToTextSettings)

Speech recognition related settings.
securitySettings

string

Name of the SecuritySettings reference for the agent. Format: projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>.
enableStackdriverLogging
(deprecated)

boolean

Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
enableSpellCorrection

boolean

Indicates if automatic spell correction is enabled in detect intent requests.
enableMultiLanguageTraining

boolean

Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
locked

boolean

Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [agents.restore][].
advancedSettings

object (AdvancedSettings)

Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
gitIntegrationSettings

object (GitIntegrationSettings)

Git integration settings for this agent.
bigqueryExportSettings

object (BigQueryExportSettings)

Optional. The BigQuery export settings for this agent. The conversation data will be exported to BigQuery tables if it is enabled. By default, BigQuery export settings will not be exported with agent. You need to set includeBigqueryExportSettings to include it in the exported agent.
textToSpeechSettings

object (TextToSpeechSettings)

Settings on instructing the speech synthesizer on how to generate the output audio content.
answerFeedbackSettings

object (AnswerFeedbackSettings)

Optional. Answer feedback collection settings.
personalizationSettings

object (PersonalizationSettings)

Optional. Settings for end user personalization.
clientCertificateSettings

object (ClientCertificateSettings)

Optional. Settings for custom client certificates.
Union field session_entry_resource. The resource to start the conversations with for the agent. session_entry_resource can be only one of the following:
startFlow

string

Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed.
startPlaybook

string

Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
genAppBuilderSettings

object (GenAppBuilderSettings)

Gen App Builder-related agent-level settings.

SpeechToTextSettings

Settings related to speech recognition.

JSON representation 
{
  "enableSpeechAdaptation": boolean
}
Fields
enableSpeechAdaptation

boolean

Whether to use speech adaptation for speech recognition.

GitIntegrationSettings

Settings for connecting to Git repository for an agent.

JSON representation 
{

  // Union field git_settings can be only one of the following:
  "githubSettings": {
    object (GithubSettings)
  }
  // End of list of possible types for union field git_settings.
}
Fields
Union field git_settings. The git settings to specific systems. git_settings can be only one of the following:
githubSettings

object (GithubSettings)

GitHub settings.

GithubSettings

Settings of integration with GitHub.

JSON representation 
{
  "displayName": string,
  "repositoryUri": string,
  "trackingBranch": string,
  "accessToken": string,
  "branches": [
    string
  ]
}
Fields
displayName

string

The unique repository display name for the GitHub repository.
repositoryUri

string

The GitHub repository URI related to the agent.
trackingBranch

string

The branch of the GitHub repository tracked for this agent.
accessToken

string

The access token used to authenticate the access to the GitHub repository.
branches[]

string

A list of branches configured to be used from Dialogflow.

BigQueryExportSettings

The settings of BigQuery export.

JSON representation 
{
  "enabled": boolean,
  "bigqueryTable": string
}
Fields
enabled

boolean

The field to indicate whether the BigQuery export is enabled.
bigqueryTable

string

The BigQuery table to export. Format: projects/<ProjectID>/datasets/<DatasetID>/tables/<TableID>.

TextToSpeechSettings

Settings related to speech synthesizing.

JSON representation 
{
  "synthesizeSpeechConfigs": {
    string: {
      object (SynthesizeSpeechConfig)
    },
    ...
  }
}
Fields
synthesizeSpeechConfigs

map (key: string, value: object (SynthesizeSpeechConfig))

Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig.

These settings affect:

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

GenAppBuilderSettings

Settings for Gen App Builder.

JSON representation 
{
  "engine": string
}
Fields
engine

string

Required. The full name of the Gen App Builder engine related to this agent if there is one. Format: projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}

AnswerFeedbackSettings

Settings for answer feedback collection.

JSON representation 
{
  "enableAnswerFeedback": boolean
}
Fields
enableAnswerFeedback

boolean

Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.

PersonalizationSettings

Settings for end user personalization.

JSON representation 
{
  "defaultEndUserMetadata": {
    object
  }
}
Fields
defaultEndUserMetadata

object (Struct format)

Optional. Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing.

ClientCertificateSettings

Settings for custom client certificates.

JSON representation 
{
  "sslCertificate": string,
  "privateKey": string,
  "passphrase": string
}
Fields
sslCertificate

string

Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines.
privateKey

string

Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: projects/{project}/secrets/{secret}/versions/{version}
passphrase

string

Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: projects/{project}/secrets/{secret}/versions/{version}

Methods

create

 Creates an agent in the specified location.

delete

 Deletes the specified agent.

export

 Exports the specified agent to a binary file.

get

 Retrieves the specified agent.

getGenerativeSettings

 Gets the generative settings for the agent.

getValidationResult

 Gets the latest agent validation result.

list

 Returns the list of all agents in the specified location.

patch

 Updates the specified agent.

restore

 Restores the specified agent from a binary file.

updateGenerativeSettings

 Updates the generative settings for the agent.

validate

 Validates the specified agent and creates or updates validation results.