flows

Creates, updates, deletes, gets or lists a flows resource.

Overview

Name	flows
Type	Resource
Id	google.dialogflow.flows

Fields

The following fields are returned by SELECT queries:

projects_locations_agents_flows_get

Name	Datatype	Description
name	string
advancedSettings	object	(id: GoogleCloudDialogflowCxV3AdvancedSettings)
description	string
displayName	string
eventHandlers	array
inputParameterDefinitions	array
knowledgeConnectorSettings	object	(id: GoogleCloudDialogflowCxV3KnowledgeConnectorSettings)
locked	boolean
multiLanguageSettings	object	(id: GoogleCloudDialogflowCxV3FlowMultiLanguageSettings)
nluSettings	object	(id: GoogleCloudDialogflowCxV3NluSettings)
outputParameterDefinitions	array
transitionRouteGroups	array
transitionRoutes	array

projects_locations_agents_flows_list

Name	Datatype	Description
name	string
advancedSettings	object	(id: GoogleCloudDialogflowCxV3AdvancedSettings)
description	string
displayName	string
eventHandlers	array
inputParameterDefinitions	array
knowledgeConnectorSettings	object	(id: GoogleCloudDialogflowCxV3KnowledgeConnectorSettings)
locked	boolean
multiLanguageSettings	object	(id: GoogleCloudDialogflowCxV3FlowMultiLanguageSettings)
nluSettings	object	(id: GoogleCloudDialogflowCxV3NluSettings)
outputParameterDefinitions	array
transitionRouteGroups	array
transitionRoutes	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_agents_flows_get	select	projectsId, locationsId, agentsId, flowsId	languageCode
projects_locations_agents_flows_list	select	projectsId, locationsId, agentsId	languageCode, pageSize, pageToken
projects_locations_agents_flows_create	insert	projectsId, locationsId, agentsId	languageCode
projects_locations_agents_flows_patch	update	projectsId, locationsId, agentsId, flowsId	languageCode, updateMask
projects_locations_agents_flows_delete	delete	projectsId, locationsId, agentsId, flowsId	force
projects_locations_agents_flows_export	exec	projectsId, locationsId, agentsId, flowsId
projects_locations_agents_flows_import	exec	projectsId, locationsId, agentsId
projects_locations_agents_flows_train	exec	projectsId, locationsId, agentsId, flowsId
projects_locations_agents_flows_validate	exec	projectsId, locationsId, agentsId, flowsId

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
flowsId	string
locationsId	string
projectsId	string
force	boolean
languageCode	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_agents_flows_get

Successful response

SELECT
name,
advancedSettings,
description,
displayName,
eventHandlers,
inputParameterDefinitions,
knowledgeConnectorSettings,
locked,
multiLanguageSettings,
nluSettings,
outputParameterDefinitions,
transitionRouteGroups,
transitionRoutes
FROM google.dialogflow.flows
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND flowsId = '{{ flowsId }}' -- required
AND languageCode = '{{ languageCode }}'
;

projects_locations_agents_flows_list

Successful response

SELECT
name,
advancedSettings,
description,
displayName,
eventHandlers,
inputParameterDefinitions,
knowledgeConnectorSettings,
locked,
multiLanguageSettings,
nluSettings,
outputParameterDefinitions,
transitionRouteGroups,
transitionRoutes
FROM google.dialogflow.flows
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND languageCode = '{{ languageCode }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

projects_locations_agents_flows_create

No description available.

INSERT INTO google.dialogflow.flows (
data__advancedSettings,
data__description,
data__displayName,
data__eventHandlers,
data__inputParameterDefinitions,
data__knowledgeConnectorSettings,
data__locked,
data__multiLanguageSettings,
data__name,
data__nluSettings,
data__outputParameterDefinitions,
data__transitionRouteGroups,
data__transitionRoutes,
projectsId,
locationsId,
agentsId,
languageCode
)
SELECT 
'{{ advancedSettings }}',
'{{ description }}',
'{{ displayName }}',
'{{ eventHandlers }}',
'{{ inputParameterDefinitions }}',
'{{ knowledgeConnectorSettings }}',
{{ locked }},
'{{ multiLanguageSettings }}',
'{{ name }}',
'{{ nluSettings }}',
'{{ outputParameterDefinitions }}',
'{{ transitionRouteGroups }}',
'{{ transitionRoutes }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentsId }}',
'{{ languageCode }}'
RETURNING
name,
advancedSettings,
description,
displayName,
eventHandlers,
inputParameterDefinitions,
knowledgeConnectorSettings,
locked,
multiLanguageSettings,
nluSettings,
outputParameterDefinitions,
transitionRouteGroups,
transitionRoutes
;

Manifest

# Description fields are for documentation purposes
- name: flows
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the flows resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the flows resource.
  - name: agentsId
    value: "{{ agentsId }}"
    description: Required parameter for the flows resource.
  - name: advancedSettings
    value:
      audioExportGcsDestination:
        uri: "{{ uri }}"
      dtmfSettings:
        enabled: {{ enabled }}
        endpointingTimeoutDuration: "{{ endpointingTimeoutDuration }}"
        finishDigit: "{{ finishDigit }}"
        interdigitTimeoutDuration: "{{ interdigitTimeoutDuration }}"
        maxDigits: {{ maxDigits }}
      loggingSettings:
        enableConsentBasedRedaction: {{ enableConsentBasedRedaction }}
        enableInteractionLogging: {{ enableInteractionLogging }}
        enableStackdriverLogging: {{ enableStackdriverLogging }}
      speechSettings:
        endpointerSensitivity: {{ endpointerSensitivity }}
        models: "{{ models }}"
        noSpeechTimeout: "{{ noSpeechTimeout }}"
        useTimeoutBasedEndpointing: {{ useTimeoutBasedEndpointing }}
  - name: description
    value: "{{ description }}"
  - name: displayName
    value: "{{ displayName }}"
  - name: eventHandlers
    value:
      - event: "{{ event }}"
        name: "{{ name }}"
        targetFlow: "{{ targetFlow }}"
        targetPage: "{{ targetPage }}"
        targetPlaybook: "{{ targetPlaybook }}"
        triggerFulfillment:
          advancedSettings:
            audioExportGcsDestination:
              uri: "{{ uri }}"
            dtmfSettings:
              enabled: {{ enabled }}
              endpointingTimeoutDuration: "{{ endpointingTimeoutDuration }}"
              finishDigit: "{{ finishDigit }}"
              interdigitTimeoutDuration: "{{ interdigitTimeoutDuration }}"
              maxDigits: {{ maxDigits }}
            loggingSettings:
              enableConsentBasedRedaction: {{ enableConsentBasedRedaction }}
              enableInteractionLogging: {{ enableInteractionLogging }}
              enableStackdriverLogging: {{ enableStackdriverLogging }}
            speechSettings:
              endpointerSensitivity: {{ endpointerSensitivity }}
              models: "{{ models }}"
              noSpeechTimeout: "{{ noSpeechTimeout }}"
              useTimeoutBasedEndpointing: {{ useTimeoutBasedEndpointing }}
          codeBlockFunction: "{{ codeBlockFunction }}"
          conditionalCases:
            - cases: "{{ cases }}"
          enableGenerativeFallback: {{ enableGenerativeFallback }}
          generators:
            - generator: "{{ generator }}"
              inputParameters: "{{ inputParameters }}"
              outputParameter: "{{ outputParameter }}"
          messages:
            - channel: "{{ channel }}"
              conversationSuccess:
                metadata: "{{ metadata }}"
              endInteraction: "{{ endInteraction }}"
              knowledgeInfoCard: "{{ knowledgeInfoCard }}"
              liveAgentHandoff:
                metadata: "{{ metadata }}"
              mixedAudio:
                segments:
                  - allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                    audio: "{{ audio }}"
                    uri: "{{ uri }}"
              outputAudioText:
                allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                ssml: "{{ ssml }}"
                text: "{{ text }}"
              payload: "{{ payload }}"
              playAudio:
                allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                audioUri: "{{ audioUri }}"
              responseType: "{{ responseType }}"
              telephonyTransferCall:
                phoneNumber: "{{ phoneNumber }}"
              text:
                allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                text:
                  - "{{ text }}"
              toolCall:
                action: "{{ action }}"
                inputParameters: "{{ inputParameters }}"
                tool: "{{ tool }}"
          returnPartialResponses: {{ returnPartialResponses }}
          setParameterActions:
            - parameter: "{{ parameter }}"
              value: "{{ value }}"
          tag: "{{ tag }}"
          webhook: "{{ webhook }}"
  - name: inputParameterDefinitions
    value:
      - description: "{{ description }}"
        name: "{{ name }}"
        type: "{{ type }}"
        typeSchema:
          inlineSchema:
            items:
              inlineSchema:
                items: "{{ items }}"
                type: "{{ type }}"
              schemaReference:
                schema: "{{ schema }}"
                tool: "{{ tool }}"
            type: "{{ type }}"
          schemaReference:
            schema: "{{ schema }}"
            tool: "{{ tool }}"
  - name: knowledgeConnectorSettings
    value:
      dataStoreConnections:
        - dataStore: "{{ dataStore }}"
          dataStoreType: "{{ dataStoreType }}"
          documentProcessingMode: "{{ documentProcessingMode }}"
      enabled: {{ enabled }}
      targetFlow: "{{ targetFlow }}"
      targetPage: "{{ targetPage }}"
      triggerFulfillment:
        advancedSettings:
          audioExportGcsDestination:
            uri: "{{ uri }}"
          dtmfSettings:
            enabled: {{ enabled }}
            endpointingTimeoutDuration: "{{ endpointingTimeoutDuration }}"
            finishDigit: "{{ finishDigit }}"
            interdigitTimeoutDuration: "{{ interdigitTimeoutDuration }}"
            maxDigits: {{ maxDigits }}
          loggingSettings:
            enableConsentBasedRedaction: {{ enableConsentBasedRedaction }}
            enableInteractionLogging: {{ enableInteractionLogging }}
            enableStackdriverLogging: {{ enableStackdriverLogging }}
          speechSettings:
            endpointerSensitivity: {{ endpointerSensitivity }}
            models: "{{ models }}"
            noSpeechTimeout: "{{ noSpeechTimeout }}"
            useTimeoutBasedEndpointing: {{ useTimeoutBasedEndpointing }}
        codeBlockFunction: "{{ codeBlockFunction }}"
        conditionalCases:
          - cases: "{{ cases }}"
        enableGenerativeFallback: {{ enableGenerativeFallback }}
        generators:
          - generator: "{{ generator }}"
            inputParameters: "{{ inputParameters }}"
            outputParameter: "{{ outputParameter }}"
        messages:
          - channel: "{{ channel }}"
            conversationSuccess:
              metadata: "{{ metadata }}"
            endInteraction: "{{ endInteraction }}"
            knowledgeInfoCard: "{{ knowledgeInfoCard }}"
            liveAgentHandoff:
              metadata: "{{ metadata }}"
            mixedAudio:
              segments:
                - allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                  audio: "{{ audio }}"
                  uri: "{{ uri }}"
            outputAudioText:
              allowPlaybackInterruption: {{ allowPlaybackInterruption }}
              ssml: "{{ ssml }}"
              text: "{{ text }}"
            payload: "{{ payload }}"
            playAudio:
              allowPlaybackInterruption: {{ allowPlaybackInterruption }}
              audioUri: "{{ audioUri }}"
            responseType: "{{ responseType }}"
            telephonyTransferCall:
              phoneNumber: "{{ phoneNumber }}"
            text:
              allowPlaybackInterruption: {{ allowPlaybackInterruption }}
              text:
                - "{{ text }}"
            toolCall:
              action: "{{ action }}"
              inputParameters: "{{ inputParameters }}"
              tool: "{{ tool }}"
        returnPartialResponses: {{ returnPartialResponses }}
        setParameterActions:
          - parameter: "{{ parameter }}"
            value: "{{ value }}"
        tag: "{{ tag }}"
        webhook: "{{ webhook }}"
  - name: locked
    value: {{ locked }}
  - name: multiLanguageSettings
    value:
      enableMultiLanguageDetection: {{ enableMultiLanguageDetection }}
      supportedResponseLanguageCodes:
        - "{{ supportedResponseLanguageCodes }}"
  - name: name
    value: "{{ name }}"
  - name: nluSettings
    value:
      classificationThreshold: {{ classificationThreshold }}
      modelTrainingMode: "{{ modelTrainingMode }}"
      modelType: "{{ modelType }}"
  - name: outputParameterDefinitions
    value:
      - description: "{{ description }}"
        name: "{{ name }}"
        type: "{{ type }}"
        typeSchema:
          inlineSchema:
            items:
              inlineSchema:
                items: "{{ items }}"
                type: "{{ type }}"
              schemaReference:
                schema: "{{ schema }}"
                tool: "{{ tool }}"
            type: "{{ type }}"
          schemaReference:
            schema: "{{ schema }}"
            tool: "{{ tool }}"
  - name: transitionRouteGroups
    value:
      - "{{ transitionRouteGroups }}"
  - name: transitionRoutes
    value:
      - condition: "{{ condition }}"
        description: "{{ description }}"
        intent: "{{ intent }}"
        name: "{{ name }}"
        targetFlow: "{{ targetFlow }}"
        targetPage: "{{ targetPage }}"
        triggerFulfillment:
          advancedSettings:
            audioExportGcsDestination:
              uri: "{{ uri }}"
            dtmfSettings:
              enabled: {{ enabled }}
              endpointingTimeoutDuration: "{{ endpointingTimeoutDuration }}"
              finishDigit: "{{ finishDigit }}"
              interdigitTimeoutDuration: "{{ interdigitTimeoutDuration }}"
              maxDigits: {{ maxDigits }}
            loggingSettings:
              enableConsentBasedRedaction: {{ enableConsentBasedRedaction }}
              enableInteractionLogging: {{ enableInteractionLogging }}
              enableStackdriverLogging: {{ enableStackdriverLogging }}
            speechSettings:
              endpointerSensitivity: {{ endpointerSensitivity }}
              models: "{{ models }}"
              noSpeechTimeout: "{{ noSpeechTimeout }}"
              useTimeoutBasedEndpointing: {{ useTimeoutBasedEndpointing }}
          codeBlockFunction: "{{ codeBlockFunction }}"
          conditionalCases:
            - cases: "{{ cases }}"
          enableGenerativeFallback: {{ enableGenerativeFallback }}
          generators:
            - generator: "{{ generator }}"
              inputParameters: "{{ inputParameters }}"
              outputParameter: "{{ outputParameter }}"
          messages:
            - channel: "{{ channel }}"
              conversationSuccess:
                metadata: "{{ metadata }}"
              endInteraction: "{{ endInteraction }}"
              knowledgeInfoCard: "{{ knowledgeInfoCard }}"
              liveAgentHandoff:
                metadata: "{{ metadata }}"
              mixedAudio:
                segments:
                  - allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                    audio: "{{ audio }}"
                    uri: "{{ uri }}"
              outputAudioText:
                allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                ssml: "{{ ssml }}"
                text: "{{ text }}"
              payload: "{{ payload }}"
              playAudio:
                allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                audioUri: "{{ audioUri }}"
              responseType: "{{ responseType }}"
              telephonyTransferCall:
                phoneNumber: "{{ phoneNumber }}"
              text:
                allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                text:
                  - "{{ text }}"
              toolCall:
                action: "{{ action }}"
                inputParameters: "{{ inputParameters }}"
                tool: "{{ tool }}"
          returnPartialResponses: {{ returnPartialResponses }}
          setParameterActions:
            - parameter: "{{ parameter }}"
              value: "{{ value }}"
          tag: "{{ tag }}"
          webhook: "{{ webhook }}"
  - name: languageCode
    value: "{{ languageCode }}"

UPDATE examples

projects_locations_agents_flows_patch

No description available.

UPDATE google.dialogflow.flows
SET 
data__advancedSettings = '{{ advancedSettings }}',
data__description = '{{ description }}',
data__displayName = '{{ displayName }}',
data__eventHandlers = '{{ eventHandlers }}',
data__inputParameterDefinitions = '{{ inputParameterDefinitions }}',
data__knowledgeConnectorSettings = '{{ knowledgeConnectorSettings }}',
data__locked = {{ locked }},
data__multiLanguageSettings = '{{ multiLanguageSettings }}',
data__name = '{{ name }}',
data__nluSettings = '{{ nluSettings }}',
data__outputParameterDefinitions = '{{ outputParameterDefinitions }}',
data__transitionRouteGroups = '{{ transitionRouteGroups }}',
data__transitionRoutes = '{{ transitionRoutes }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND flowsId = '{{ flowsId }}' --required
AND languageCode = '{{ languageCode}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
advancedSettings,
description,
displayName,
eventHandlers,
inputParameterDefinitions,
knowledgeConnectorSettings,
locked,
multiLanguageSettings,
nluSettings,
outputParameterDefinitions,
transitionRouteGroups,
transitionRoutes;

DELETE examples

projects_locations_agents_flows_delete

No description available.

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

Lifecycle Methods

projects_locations_agents_flows_export

Successful response

EXEC google.dialogflow.flows.projects_locations_agents_flows_export 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required, 
@flowsId='{{ flowsId }}' --required 
@@json=
'{
"flowUri": "{{ flowUri }}", 
"includeReferencedFlows": {{ includeReferencedFlows }}
}'
;

projects_locations_agents_flows_import

Successful response

EXEC google.dialogflow.flows.projects_locations_agents_flows_import 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required 
@@json=
'{
"flowContent": "{{ flowContent }}", 
"flowImportStrategy": "{{ flowImportStrategy }}", 
"flowUri": "{{ flowUri }}", 
"importOption": "{{ importOption }}"
}'
;

projects_locations_agents_flows_train

Successful response

EXEC google.dialogflow.flows.projects_locations_agents_flows_train 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required, 
@flowsId='{{ flowsId }}' --required
;

projects_locations_agents_flows_validate

Successful response

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