agents

Creates, updates, deletes, gets or lists an agents resource.

Overview

Name	agents
Type	Resource
Id	google.dialogflow.agents

Fields

The following fields are returned by SELECT queries:

projects_locations_agents_get

Name	Datatype	Description
name	string
advancedSettings	object	(id: GoogleCloudDialogflowCxV3AdvancedSettings)
answerFeedbackSettings	object	(id: GoogleCloudDialogflowCxV3AgentAnswerFeedbackSettings)
avatarUri	string
clientCertificateSettings	object	(id: GoogleCloudDialogflowCxV3AgentClientCertificateSettings)
defaultLanguageCode	string
description	string
displayName	string
enableMultiLanguageTraining	boolean
enableSpellCorrection	boolean
enableStackdriverLogging	boolean
genAppBuilderSettings	object	(id: GoogleCloudDialogflowCxV3AgentGenAppBuilderSettings)
gitIntegrationSettings	object	(id: GoogleCloudDialogflowCxV3AgentGitIntegrationSettings)
locked	boolean
personalizationSettings	object	(id: GoogleCloudDialogflowCxV3AgentPersonalizationSettings)
satisfiesPzi	boolean
satisfiesPzs	boolean
securitySettings	string
speechToTextSettings	object	(id: GoogleCloudDialogflowCxV3SpeechToTextSettings)
startFlow	string
startPlaybook	string
supportedLanguageCodes	array
textToSpeechSettings	object	(id: GoogleCloudDialogflowCxV3TextToSpeechSettings)
timeZone	string

projects_locations_agents_list

Name	Datatype	Description
name	string
advancedSettings	object	(id: GoogleCloudDialogflowCxV3AdvancedSettings)
answerFeedbackSettings	object	(id: GoogleCloudDialogflowCxV3AgentAnswerFeedbackSettings)
avatarUri	string
clientCertificateSettings	object	(id: GoogleCloudDialogflowCxV3AgentClientCertificateSettings)
defaultLanguageCode	string
description	string
displayName	string
enableMultiLanguageTraining	boolean
enableSpellCorrection	boolean
enableStackdriverLogging	boolean
genAppBuilderSettings	object	(id: GoogleCloudDialogflowCxV3AgentGenAppBuilderSettings)
gitIntegrationSettings	object	(id: GoogleCloudDialogflowCxV3AgentGitIntegrationSettings)
locked	boolean
personalizationSettings	object	(id: GoogleCloudDialogflowCxV3AgentPersonalizationSettings)
satisfiesPzi	boolean
satisfiesPzs	boolean
securitySettings	string
speechToTextSettings	object	(id: GoogleCloudDialogflowCxV3SpeechToTextSettings)
startFlow	string
startPlaybook	string
supportedLanguageCodes	array
textToSpeechSettings	object	(id: GoogleCloudDialogflowCxV3TextToSpeechSettings)
timeZone	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_agents_get	select	projectsId, locationsId, agentsId
projects_locations_agents_list	select	projectsId, locationsId	pageSize, pageToken
projects_locations_agents_create	insert	projectsId, locationsId
projects_locations_agents_patch	update	projectsId, locationsId, agentsId	updateMask
projects_locations_agents_delete	delete	projectsId, locationsId, agentsId
projects_locations_agents_restore	exec	projectsId, locationsId, agentsId
projects_locations_agents_validate	exec	projectsId, locationsId, agentsId
projects_locations_agents_export	exec	projectsId, locationsId, agentsId

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agentsId	string
locationsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_agents_get

Successful response

SELECT
name,
advancedSettings,
answerFeedbackSettings,
avatarUri,
clientCertificateSettings,
defaultLanguageCode,
description,
displayName,
enableMultiLanguageTraining,
enableSpellCorrection,
enableStackdriverLogging,
genAppBuilderSettings,
gitIntegrationSettings,
locked,
personalizationSettings,
satisfiesPzi,
satisfiesPzs,
securitySettings,
speechToTextSettings,
startFlow,
startPlaybook,
supportedLanguageCodes,
textToSpeechSettings,
timeZone
FROM google.dialogflow.agents
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
;

projects_locations_agents_list

Successful response

SELECT
name,
advancedSettings,
answerFeedbackSettings,
avatarUri,
clientCertificateSettings,
defaultLanguageCode,
description,
displayName,
enableMultiLanguageTraining,
enableSpellCorrection,
enableStackdriverLogging,
genAppBuilderSettings,
gitIntegrationSettings,
locked,
personalizationSettings,
satisfiesPzi,
satisfiesPzs,
securitySettings,
speechToTextSettings,
startFlow,
startPlaybook,
supportedLanguageCodes,
textToSpeechSettings,
timeZone
FROM google.dialogflow.agents
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

projects_locations_agents_create

No description available.

INSERT INTO google.dialogflow.agents (
data__defaultLanguageCode,
data__speechToTextSettings,
data__personalizationSettings,
data__answerFeedbackSettings,
data__enableMultiLanguageTraining,
data__securitySettings,
data__textToSpeechSettings,
data__description,
data__clientCertificateSettings,
data__displayName,
data__enableSpellCorrection,
data__supportedLanguageCodes,
data__genAppBuilderSettings,
data__avatarUri,
data__startPlaybook,
data__enableStackdriverLogging,
data__timeZone,
data__name,
data__locked,
data__gitIntegrationSettings,
data__advancedSettings,
data__startFlow,
projectsId,
locationsId
)
SELECT 
'{{ defaultLanguageCode }}',
'{{ speechToTextSettings }}',
'{{ personalizationSettings }}',
'{{ answerFeedbackSettings }}',
{{ enableMultiLanguageTraining }},
'{{ securitySettings }}',
'{{ textToSpeechSettings }}',
'{{ description }}',
'{{ clientCertificateSettings }}',
'{{ displayName }}',
{{ enableSpellCorrection }},
'{{ supportedLanguageCodes }}',
'{{ genAppBuilderSettings }}',
'{{ avatarUri }}',
'{{ startPlaybook }}',
{{ enableStackdriverLogging }},
'{{ timeZone }}',
'{{ name }}',
{{ locked }},
'{{ gitIntegrationSettings }}',
'{{ advancedSettings }}',
'{{ startFlow }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
advancedSettings,
answerFeedbackSettings,
avatarUri,
clientCertificateSettings,
defaultLanguageCode,
description,
displayName,
enableMultiLanguageTraining,
enableSpellCorrection,
enableStackdriverLogging,
genAppBuilderSettings,
gitIntegrationSettings,
locked,
personalizationSettings,
satisfiesPzi,
satisfiesPzs,
securitySettings,
speechToTextSettings,
startFlow,
startPlaybook,
supportedLanguageCodes,
textToSpeechSettings,
timeZone
;

Manifest

# Description fields are for documentation purposes
- name: agents
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the agents resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the agents resource.
  - name: defaultLanguageCode
    value: "{{ defaultLanguageCode }}"
  - name: speechToTextSettings
    value:
      enableSpeechAdaptation: {{ enableSpeechAdaptation }}
  - name: personalizationSettings
    value:
      defaultEndUserMetadata: "{{ defaultEndUserMetadata }}"
  - name: answerFeedbackSettings
    value:
      enableAnswerFeedback: {{ enableAnswerFeedback }}
  - name: enableMultiLanguageTraining
    value: {{ enableMultiLanguageTraining }}
  - name: securitySettings
    value: "{{ securitySettings }}"
  - name: textToSpeechSettings
    value:
      synthesizeSpeechConfigs: "{{ synthesizeSpeechConfigs }}"
  - name: description
    value: "{{ description }}"
  - name: clientCertificateSettings
    value:
      sslCertificate: "{{ sslCertificate }}"
      privateKey: "{{ privateKey }}"
      passphrase: "{{ passphrase }}"
  - name: displayName
    value: "{{ displayName }}"
  - name: enableSpellCorrection
    value: {{ enableSpellCorrection }}
  - name: supportedLanguageCodes
    value:
      - "{{ supportedLanguageCodes }}"
  - name: genAppBuilderSettings
    value:
      engine: "{{ engine }}"
  - name: avatarUri
    value: "{{ avatarUri }}"
  - name: startPlaybook
    value: "{{ startPlaybook }}"
  - name: enableStackdriverLogging
    value: {{ enableStackdriverLogging }}
  - name: timeZone
    value: "{{ timeZone }}"
  - name: name
    value: "{{ name }}"
  - name: locked
    value: {{ locked }}
  - name: gitIntegrationSettings
    value:
      githubSettings:
        branches:
          - "{{ branches }}"
        repositoryUri: "{{ repositoryUri }}"
        trackingBranch: "{{ trackingBranch }}"
        displayName: "{{ displayName }}"
        accessToken: "{{ accessToken }}"
  - name: advancedSettings
    value:
      loggingSettings:
        enableInteractionLogging: {{ enableInteractionLogging }}
        enableConsentBasedRedaction: {{ enableConsentBasedRedaction }}
        enableStackdriverLogging: {{ enableStackdriverLogging }}
      audioExportGcsDestination:
        uri: "{{ uri }}"
      speechSettings:
        useTimeoutBasedEndpointing: {{ useTimeoutBasedEndpointing }}
        models: "{{ models }}"
        endpointerSensitivity: {{ endpointerSensitivity }}
        noSpeechTimeout: "{{ noSpeechTimeout }}"
      dtmfSettings:
        maxDigits: {{ maxDigits }}
        finishDigit: "{{ finishDigit }}"
        interdigitTimeoutDuration: "{{ interdigitTimeoutDuration }}"
        enabled: {{ enabled }}
        endpointingTimeoutDuration: "{{ endpointingTimeoutDuration }}"
  - name: startFlow
    value: "{{ startFlow }}"

UPDATE examples

projects_locations_agents_patch

No description available.

UPDATE google.dialogflow.agents
SET 
data__defaultLanguageCode = '{{ defaultLanguageCode }}',
data__speechToTextSettings = '{{ speechToTextSettings }}',
data__personalizationSettings = '{{ personalizationSettings }}',
data__answerFeedbackSettings = '{{ answerFeedbackSettings }}',
data__enableMultiLanguageTraining = {{ enableMultiLanguageTraining }},
data__securitySettings = '{{ securitySettings }}',
data__textToSpeechSettings = '{{ textToSpeechSettings }}',
data__description = '{{ description }}',
data__clientCertificateSettings = '{{ clientCertificateSettings }}',
data__displayName = '{{ displayName }}',
data__enableSpellCorrection = {{ enableSpellCorrection }},
data__supportedLanguageCodes = '{{ supportedLanguageCodes }}',
data__genAppBuilderSettings = '{{ genAppBuilderSettings }}',
data__avatarUri = '{{ avatarUri }}',
data__startPlaybook = '{{ startPlaybook }}',
data__enableStackdriverLogging = {{ enableStackdriverLogging }},
data__timeZone = '{{ timeZone }}',
data__name = '{{ name }}',
data__locked = {{ locked }},
data__gitIntegrationSettings = '{{ gitIntegrationSettings }}',
data__advancedSettings = '{{ advancedSettings }}',
data__startFlow = '{{ startFlow }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
advancedSettings,
answerFeedbackSettings,
avatarUri,
clientCertificateSettings,
defaultLanguageCode,
description,
displayName,
enableMultiLanguageTraining,
enableSpellCorrection,
enableStackdriverLogging,
genAppBuilderSettings,
gitIntegrationSettings,
locked,
personalizationSettings,
satisfiesPzi,
satisfiesPzs,
securitySettings,
speechToTextSettings,
startFlow,
startPlaybook,
supportedLanguageCodes,
textToSpeechSettings,
timeZone;

DELETE examples

projects_locations_agents_delete

No description available.

DELETE FROM google.dialogflow.agents
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
;

Lifecycle Methods

projects_locations_agents_restore

Successful response

EXEC google.dialogflow.agents.projects_locations_agents_restore 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required 
@@json=
'{
"agentUri": "{{ agentUri }}", 
"restoreOption": "{{ restoreOption }}", 
"agentContent": "{{ agentContent }}", 
"gitSource": "{{ gitSource }}"
}'
;

projects_locations_agents_validate

Successful response

EXEC google.dialogflow.agents.projects_locations_agents_validate 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required 
@@json=
'{
"languageCode": "{{ languageCode }}"
}'
;

projects_locations_agents_export

Successful response

EXEC google.dialogflow.agents.projects_locations_agents_export 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required 
@@json=
'{
"gitDestination": "{{ gitDestination }}", 
"includeBigqueryExportSettings": {{ includeBigqueryExportSettings }}, 
"environment": "{{ environment }}", 
"agentUri": "{{ agentUri }}", 
"dataFormat": "{{ dataFormat }}"
}'
;