Console
    Contact Us Start free

    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 
 
) 
 } 
 , 
 "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 
 
) 
 } 
 , 
 "satisfiesPzs" 
 : 
 boolean 
 , 
 "satisfiesPzi" 
 : 
 boolean 
 }
    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.

    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.

    satisfiesPzs

    boolean

    Optional. Output only. A read only boolean field reflecting Zone Separation status of the agent.

    satisfiesPzi

    boolean

    Optional. Output only. A read only boolean field reflecting Zone Isolation status of the agent.

    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.

    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" } .

    SynthesizeSpeechConfig

    Configuration of how speech should be synthesized.

    JSON representation 
     { 
 "speakingRate" 
 : 
 number 
 , 
 "pitch" 
 : 
 number 
 , 
 "volumeGainDb" 
 : 
 number 
 , 
 "effectsProfileId" 
 : 
 [ 
 string 
 ] 
 , 
 "voice" 
 : 
 { 
 object (  VoiceSelectionParams 
 
) 
 } 
 }
    Fields
    speakingRate

    number

    Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
    pitch

    number

    Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
    volumeGainDb

    number

    Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
    effectsProfileId[]

    string

    Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
    voice

    object ( VoiceSelectionParams )

    Optional. The desired voice of the synthesized audio.

    VoiceSelectionParams

    Description of which voice to use for speech synthesis.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "ssmlGender" 
 : 
 enum (  SsmlVoiceGender 
 
) 
 }
    Fields
    name

    string

    Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as languageCode and ssmlGender .

    For the list of available voices, please refer to Supported voices and languages .
    ssmlGender

    enum ( SsmlVoiceGender )

    Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as languageCode and name . Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer substitutes a voice with a different gender rather than failing the request.

    SsmlVoiceGender

    Gender of the voice as described in SSML voice element .

    Enums
    SSML_VOICE_GENDER_UNSPECIFIED An unspecified gender, which means that the client doesn't care which gender the selected voice will have.
    SSML_VOICE_GENDER_MALE A male voice.
    SSML_VOICE_GENDER_FEMALE A female voice.
    SSML_VOICE_GENDER_NEUTRAL A gender-neutral voice.

    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.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: