pages

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

Overview

Name	pages
Type	Resource
Id	google.dialogflow.pages

Fields

Name	Datatype	Description
name	string	The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: projects//locations//agents//flows//pages/.
description	string	The description of the page. The maximum length is 500 characters.
advancedSettings	object	Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
displayName	string	Required. The human-readable name of the page, unique within the flow.
entryFulfillment	object	A fulfillment can do one or more of the following actions at the same time: Generate rich message responses. Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both.
eventHandlers	array	Handlers associated with the page to handle events such as webhook errors, no match or no input.
form	object	A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session.
knowledgeConnectorSettings	object	The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment.
transitionRouteGroups	array	Ordered list of TransitionRouteGroups added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/ or projects//locations//agents//transitionRouteGroups/ for agent-level groups.
transitionRoutes	array	A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: TransitionRoutes defined in the page with intent specified. TransitionRoutes defined in the transition route groups with intent specified. TransitionRoutes defined in flow with intent specified. TransitionRoutes defined in the transition route groups with intent specified. TransitionRoutes defined in the page with only condition specified. TransitionRoutes defined in the transition route groups with only condition specified.

Methods

Name	Accessible by	Required Params	Description
projects_locations_agents_flows_pages_get	SELECT	agentsId, flowsId, locationsId, pagesId, projectsId	Retrieves the specified page.
projects_locations_agents_flows_pages_list	SELECT	agentsId, flowsId, locationsId, projectsId	Returns the list of all pages in the specified flow.
projects_locations_agents_flows_pages_create	INSERT	agentsId, flowsId, locationsId, projectsId	Creates a page in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.
projects_locations_agents_flows_pages_delete	DELETE	agentsId, flowsId, locationsId, pagesId, projectsId	Deletes the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation.
projects_locations_agents_flows_pages_patch	UPDATE	agentsId, flowsId, locationsId, pagesId, projectsId	Updates the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation.

SELECT examples

Returns the list of all pages in the specified flow.

SELECT
name,
description,
advancedSettings,
displayName,
entryFulfillment,
eventHandlers,
form,
knowledgeConnectorSettings,
transitionRouteGroups,
transitionRoutes
FROM google.dialogflow.pages
WHERE agentsId = '{{ agentsId }}'
AND flowsId = '{{ flowsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new pages resource.

All Properties

/*+ create */
INSERT INTO google.dialogflow.pages (
agentsId,
flowsId,
locationsId,
projectsId,
name,
displayName,
description,
entryFulfillment,
form,
transitionRouteGroups,
transitionRoutes,
eventHandlers,
advancedSettings,
knowledgeConnectorSettings
)
SELECT 
'{{ agentsId }}',
'{{ flowsId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
'{{ entryFulfillment }}',
'{{ form }}',
'{{ transitionRouteGroups }}',
'{{ transitionRoutes }}',
'{{ eventHandlers }}',
'{{ advancedSettings }}',
'{{ knowledgeConnectorSettings }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: description
      value: string
    - name: entryFulfillment
      value:
        - name: messages
          value:
            - - name: text
                value:
                  - name: text
                    value:
                      - string
                  - name: allowPlaybackInterruption
                    value: boolean
              - name: payload
                value: object
              - name: conversationSuccess
                value:
                  - name: metadata
                    value: object
              - name: outputAudioText
                value:
                  - name: text
                    value: string
                  - name: ssml
                    value: string
                  - name: allowPlaybackInterruption
                    value: boolean
              - name: liveAgentHandoff
                value:
                  - name: metadata
                    value: object
              - name: endInteraction
                value: []
              - name: playAudio
                value:
                  - name: audioUri
                    value: string
                  - name: allowPlaybackInterruption
                    value: boolean
              - name: mixedAudio
                value:
                  - name: segments
                    value:
                      - - name: audio
                          value: string
                        - name: uri
                          value: string
                        - name: allowPlaybackInterruption
                          value: boolean
              - name: telephonyTransferCall
                value:
                  - name: phoneNumber
                    value: string
              - name: knowledgeInfoCard
                value: []
              - name: responseType
                value: string
              - name: channel
                value: string
        - name: webhook
          value: string
        - name: returnPartialResponses
          value: boolean
        - name: tag
          value: string
        - name: setParameterActions
          value:
            - - name: parameter
                value: string
              - name: value
                value: any
        - name: conditionalCases
          value:
            - - name: cases
                value:
                  - - name: condition
                      value: string
                    - name: caseContent
                      value:
                        - - name: message
                            value:
                              - name: payload
                                value: object
                              - name: responseType
                                value: string
                              - name: channel
                                value: string
                          - name: additionalCases
                            value:
                              - name: cases
                                value:
                                  - - name: condition
                                      value: string
                                    - name: caseContent
                                      value:
                                        - []
        - name: advancedSettings
          value:
            - name: audioExportGcsDestination
              value:
                - name: uri
                  value: string
            - name: speechSettings
              value:
                - name: endpointerSensitivity
                  value: integer
                - name: noSpeechTimeout
                  value: string
                - name: useTimeoutBasedEndpointing
                  value: boolean
                - name: models
                  value: object
            - name: dtmfSettings
              value:
                - name: enabled
                  value: boolean
                - name: maxDigits
                  value: integer
                - name: finishDigit
                  value: string
                - name: interdigitTimeoutDuration
                  value: string
                - name: endpointingTimeoutDuration
                  value: string
            - name: loggingSettings
              value:
                - name: enableStackdriverLogging
                  value: boolean
                - name: enableInteractionLogging
                  value: boolean
                - name: enableConsentBasedRedaction
                  value: boolean
        - name: enableGenerativeFallback
          value: boolean
    - name: form
      value:
        - name: parameters
          value:
            - - name: displayName
                value: string
              - name: required
                value: boolean
              - name: entityType
                value: string
              - name: isList
                value: boolean
              - name: fillBehavior
                value:
                  - name: repromptEventHandlers
                    value:
                      - - name: name
                          value: string
                        - name: event
                          value: string
                        - name: targetPage
                          value: string
                        - name: targetFlow
                          value: string
                        - name: targetPlaybook
                          value: string
              - name: defaultValue
                value: any
              - name: redact
                value: boolean
    - name: transitionRouteGroups
      value:
        - string
    - name: transitionRoutes
      value:
        - - name: name
            value: string
          - name: description
            value: string
          - name: intent
            value: string
          - name: condition
            value: string
          - name: targetPage
            value: string
          - name: targetFlow
            value: string
    - name: eventHandlers
      value:
        - - name: name
            value: string
          - name: event
            value: string
          - name: targetPage
            value: string
          - name: targetFlow
            value: string
          - name: targetPlaybook
            value: string
    - name: knowledgeConnectorSettings
      value:
        - name: enabled
          value: boolean
        - name: targetPage
          value: string
        - name: targetFlow
          value: string
        - name: dataStoreConnections
          value:
            - - name: dataStoreType
                value: string
              - name: dataStore
                value: string

UPDATE example

Updates a pages resource.

/*+ update */
UPDATE google.dialogflow.pages
SET 
name = '{{ name }}',
displayName = '{{ displayName }}',
description = '{{ description }}',
entryFulfillment = '{{ entryFulfillment }}',
form = '{{ form }}',
transitionRouteGroups = '{{ transitionRouteGroups }}',
transitionRoutes = '{{ transitionRoutes }}',
eventHandlers = '{{ eventHandlers }}',
advancedSettings = '{{ advancedSettings }}',
knowledgeConnectorSettings = '{{ knowledgeConnectorSettings }}'
WHERE 
agentsId = '{{ agentsId }}'
AND flowsId = '{{ flowsId }}'
AND locationsId = '{{ locationsId }}'
AND pagesId = '{{ pagesId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified pages resource.

/*+ delete */
DELETE FROM google.dialogflow.pages
WHERE agentsId = '{{ agentsId }}'
AND flowsId = '{{ flowsId }}'
AND locationsId = '{{ locationsId }}'
AND pagesId = '{{ pagesId }}'
AND projectsId = '{{ projectsId }}';