gcp_dialogflow_agent

advanced_settings

Type: STRUCT
Provider name: advancedSettings
Description: Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

• audio_export_gcs_destination
  Type: STRUCT
  Provider name: audioExportGcsDestination
  Description: If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
  
  • uri
    Type: STRING
    Provider name: uri
    Description: Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: gs://bucket/object-name-or-prefix Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
    
• dtmf_settings
  Type: STRUCT
  Provider name: dtmfSettings
  Description: Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
  
  • enabled
    Type: BOOLEAN
    Provider name: enabled
    Description: If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a “3” was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
    
  • endpointing_timeout_duration
    Type: STRING
    Provider name: endpointingTimeoutDuration
    Description: Endpoint timeout setting for matching dtmf input to regex.
    
  • finish_digit
    Type: STRING
    Provider name: finishDigit
    Description: The digit that terminates a DTMF digit sequence.
    
  • interdigit_timeout_duration
    Type: STRING
    Provider name: interdigitTimeoutDuration
    Description: Interdigit timeout setting for matching dtmf input to regex.
    
  • max_digits
    Type: INT32
    Provider name: maxDigits
    Description: Max length of DTMF digits.
    
• logging_settings
  Type: STRUCT
  Provider name: loggingSettings
  Description: Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
  
  • enable_consent_based_redaction
    Type: BOOLEAN
    Provider name: enableConsentBasedRedaction
    Description: Enables consent-based end-user input redaction, if true, a pre-defined session parameter $session.params.conversation-redaction will be used to determine if the utterance should be redacted.
    
  • enable_interaction_logging
    Type: BOOLEAN
    Provider name: enableInteractionLogging
    Description: Enables DF Interaction logging.
    
  • enable_stackdriver_logging
    Type: BOOLEAN
    Provider name: enableStackdriverLogging
    Description: Enables Google Cloud Logging.
    
• speech_settings
  Type: STRUCT
  Provider name: speechSettings
  Description: Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
  
  • endpointer_sensitivity
    Type: INT32
    Provider name: endpointerSensitivity
    Description: Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
    
  • no_speech_timeout
    Type: STRING
    Provider name: noSpeechTimeout
    Description: Timeout before detecting no speech.
    
  • use_timeout_based_endpointing
    Type: BOOLEAN
    Provider name: useTimeoutBasedEndpointing
    Description: Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
    

ancestors

Type: UNORDERED_LIST_STRING

answer_feedback_settings

Type: STRUCT
Provider name: answerFeedbackSettings
Description: Optional. Answer feedback collection settings.

• enable_answer_feedback
  Type: BOOLEAN
  Provider name: enableAnswerFeedback
  Description: 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.
  

avatar_uri

Type: STRING
Provider name: avatarUri
Description: The URI of the agent’s avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

client_certificate_settings

Type: STRUCT
Provider name: clientCertificateSettings
Description: Optional. Settings for custom client certificates.

• passphrase
  Type: STRING
  Provider name: passphrase
  Description: 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}
  
• private_key
  Type: STRING
  Provider name: privateKey
  Description: Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: projects/{project}/secrets/{secret}/versions/{version}
  
• ssl_certificate
  Type: STRING
  Provider name: sslCertificate
  Description: Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines.
  

default_language_code

Type: STRING
Provider name: defaultLanguageCode
Description: 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.

description

Type: STRING
Provider name: description
Description: The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

enable_multi_language_training

Type: BOOLEAN
Provider name: enableMultiLanguageTraining
Description: Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.

enable_spell_correction

Type: BOOLEAN
Provider name: enableSpellCorrection
Description: Indicates if automatic spell correction is enabled in detect intent requests.

enable_stackdriver_logging

Type: BOOLEAN
Provider name: enableStackdriverLogging
Description: Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.

gcp_display_name

Type: STRING
Provider name: displayName
Description: Required. The human-readable name of the agent, unique within the location.

gen_app_builder_settings

Type: STRUCT
Provider name: genAppBuilderSettings
Description: Gen App Builder-related agent-level settings.

• engine
  Type: STRING
  Provider name: engine
  Description: 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}
  

git_integration_settings

Type: STRUCT
Provider name: gitIntegrationSettings
Description: Git integration settings for this agent.

• github_settings
  Type: STRUCT
  Provider name: githubSettings
  Description: GitHub settings.
  
  • access_token
    Type: STRING
    Provider name: accessToken
    Description: The access token used to authenticate the access to the GitHub repository.
    
  • branches
    Type: UNORDERED_LIST_STRING
    Provider name: branches
    Description: A list of branches configured to be used from Dialogflow.
    
  • gcp_display_name
    Type: STRING
    Provider name: displayName
    Description: The unique repository display name for the GitHub repository.
    
  • repository_uri
    Type: STRING
    Provider name: repositoryUri
    Description: The GitHub repository URI related to the agent.
    
  • tracking_branch
    Type: STRING
    Provider name: trackingBranch
    Description: The branch of the GitHub repository tracked for this agent.
    

labels

Type: UNORDERED_LIST_STRING

locked

Type: BOOLEAN
Provider name: locked
Description: Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.

name

Type: STRING
Provider name: name
Description: The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects//locations//agents/.

organization_id

Type: STRING

parent

Type: STRING

personalization_settings

Type: STRUCT
Provider name: personalizationSettings
Description: Optional. Settings for end user personalization.

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

satisfies_pzi

Type: BOOLEAN
Provider name: satisfiesPzi
Description: Optional. Output only. A read only boolean field reflecting Zone Isolation status of the agent.

satisfies_pzs

Type: BOOLEAN
Provider name: satisfiesPzs
Description: Optional. Output only. A read only boolean field reflecting Zone Separation status of the agent.

security_settings

Type: STRING
Provider name: securitySettings
Description: Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.

speech_to_text_settings

Type: STRUCT
Provider name: speechToTextSettings
Description: Speech recognition related settings.

• enable_speech_adaptation
  Type: BOOLEAN
  Provider name: enableSpeechAdaptation
  Description: Whether to use speech adaptation for speech recognition.
  

start_flow

Type: STRING
Provider name: startFlow
Description: 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//locations//agents//flows/. Currently only the default start flow with id “00000000-0000-0000-0000-000000000000” is allowed.

start_playbook

Type: STRING
Provider name: startPlaybook
Description: 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//locations//agents//playbooks/. Currently only the default playbook with id “00000000-0000-0000-0000-000000000000” is allowed.

supported_language_codes

Type: UNORDERED_LIST_STRING
Provider name: supportedLanguageCodes
Description: The list of all languages supported by the agent (except for the default_language_code).

tags

Type: UNORDERED_LIST_STRING

text_to_speech_settings

Type: STRUCT
Provider name: textToSpeechSettings
Description: Settings on instructing the speech synthesizer on how to generate the output audio content.

time_zone

Type: STRING
Provider name: timeZone
Description: Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.