Skip to content

dialogflowcx.v1alpha1.dialogflowCXFlow

Index

Fields

fn new

new(name)

new returns an instance of DialogflowCXFlow

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

fn spec.withDescription

withDescription(description)

"The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected."

fn spec.withDisplayName

withDisplayName(displayName)

"The human-readable name of the flow."

fn spec.withEventHandlers

withEventHandlers(eventHandlers)

"A flow's event handlers serve two purposes:\nThey are responsible for handling events (e.g. no match, webhook errors) in the flow.\nThey are inherited by every page's [event handlers][Page.event_handlers], which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.\nUnlike transitionRoutes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored."

fn spec.withEventHandlersMixin

withEventHandlersMixin(eventHandlers)

"A flow's event handlers serve two purposes:\nThey are responsible for handling events (e.g. no match, webhook errors) in the flow.\nThey are inherited by every page's [event handlers][Page.event_handlers], which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.\nUnlike transitionRoutes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored."

Note: This function appends passed data to existing values

fn spec.withLanguageCode

withLanguageCode(languageCode)

"Immutable. The language of the following fields in flow:\nFlow.event_handlers.trigger_fulfillment.messages\nFlow.event_handlers.trigger_fulfillment.conditional_cases\nFlow.transition_routes.trigger_fulfillment.messages\nFlow.transition_routes.trigger_fulfillment.conditional_cases\nIf not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used."

fn spec.withParent

withParent(parent)

"Immutable. The agent to create a flow for.\nFormat: projects//locations//agents/."

fn spec.withResourceID

withResourceID(resourceID)

"Immutable. Optional. The service-generated name of the resource. Used for acquisition only. Leave unset to create a new resource."

fn spec.withTransitionRouteGroups

withTransitionRouteGroups(transitionRouteGroups)

"A flow's transition route group serve two purposes:\nThey are responsible for matching the user's first utterances in the flow.\nThey are inherited by every page's [transition route groups][Page.transition_route_groups]. Transition route groups defined in the page have higher priority than those defined in the flow.\nFormat:projects//locations//agents//flows//transitionRouteGroups/."

fn spec.withTransitionRouteGroupsMixin

withTransitionRouteGroupsMixin(transitionRouteGroups)

"A flow's transition route group serve two purposes:\nThey are responsible for matching the user's first utterances in the flow.\nThey are inherited by every page's [transition route groups][Page.transition_route_groups]. Transition route groups defined in the page have higher priority than those defined in the flow.\nFormat:projects//locations//agents//flows//transitionRouteGroups/."

Note: This function appends passed data to existing values

fn spec.withTransitionRoutes

withTransitionRoutes(transitionRoutes)

"A flow's transition routes serve two purposes:\nThey are responsible for matching the user's first utterances in the flow.\nThey are inherited by every page's [transition routes][Page.transition_routes] and can support use cases such as the user saying \"help\" or \"can I talk to a human?\", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.\n\nTransitionRoutes are evalauted in the following order:\n TransitionRoutes with intent specified.\n TransitionRoutes with only condition specified.\n TransitionRoutes with intent specified are inherited by pages in the flow."

fn spec.withTransitionRoutesMixin

withTransitionRoutesMixin(transitionRoutes)

"A flow's transition routes serve two purposes:\nThey are responsible for matching the user's first utterances in the flow.\nThey are inherited by every page's [transition routes][Page.transition_routes] and can support use cases such as the user saying \"help\" or \"can I talk to a human?\", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.\n\nTransitionRoutes are evalauted in the following order:\n TransitionRoutes with intent specified.\n TransitionRoutes with only condition specified.\n TransitionRoutes with intent specified are inherited by pages in the flow."

Note: This function appends passed data to existing values

obj spec.eventHandlers

"A flow's event handlers serve two purposes:\nThey are responsible for handling events (e.g. no match, webhook errors) in the flow.\nThey are inherited by every page's [event handlers][Page.event_handlers], which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.\nUnlike transitionRoutes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored."

fn spec.eventHandlers.withEvent

withEvent(event)

"The name of the event to handle."

fn spec.eventHandlers.withName

withName(name)

"The unique identifier of this event handler."

fn spec.eventHandlers.withTargetFlow

withTargetFlow(targetFlow)

"The target flow to transition to.\nFormat: projects//locations//agents//flows/."

fn spec.eventHandlers.withTargetPage

withTargetPage(targetPage)

"The target page to transition to.\nFormat: projects//locations//agents//flows//pages/."

obj spec.eventHandlers.triggerFulfillment

"The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks."

fn spec.eventHandlers.triggerFulfillment.withConditionalCases

withConditionalCases(conditionalCases)

"Conditional cases for this fulfillment."

fn spec.eventHandlers.triggerFulfillment.withConditionalCasesMixin

withConditionalCasesMixin(conditionalCases)

"Conditional cases for this fulfillment."

Note: This function appends passed data to existing values

fn spec.eventHandlers.triggerFulfillment.withMessages

withMessages(messages)

"The list of rich message responses to present to the user."

fn spec.eventHandlers.triggerFulfillment.withMessagesMixin

withMessagesMixin(messages)

"The list of rich message responses to present to the user."

Note: This function appends passed data to existing values

fn spec.eventHandlers.triggerFulfillment.withReturnPartialResponses

withReturnPartialResponses(returnPartialResponses)

"Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks."

fn spec.eventHandlers.triggerFulfillment.withSetParameterActions

withSetParameterActions(setParameterActions)

"Set parameter values before executing the webhook."

fn spec.eventHandlers.triggerFulfillment.withSetParameterActionsMixin

withSetParameterActionsMixin(setParameterActions)

"Set parameter values before executing the webhook."

Note: This function appends passed data to existing values

fn spec.eventHandlers.triggerFulfillment.withTag

withTag(tag)

"The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified."

fn spec.eventHandlers.triggerFulfillment.withWebhook

withWebhook(webhook)

"The webhook to call. Format: projects//locations//agents//webhooks/."

obj spec.eventHandlers.triggerFulfillment.conditionalCases

"Conditional cases for this fulfillment."

fn spec.eventHandlers.triggerFulfillment.conditionalCases.withCases

withCases(cases)

"A JSON encoded list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.\nSee Case for the schema."

obj spec.eventHandlers.triggerFulfillment.messages

"The list of rich message responses to present to the user."

fn spec.eventHandlers.triggerFulfillment.messages.withChannel

withChannel(channel)

"The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned."

fn spec.eventHandlers.triggerFulfillment.messages.withPayload

withPayload(payload)

"A custom, platform-specific payload."

obj spec.eventHandlers.triggerFulfillment.messages.conversationSuccess

"Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about.\nDialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess.\nYou may set this, for example:\n In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded.\n In a webhook response when you determine that you handled the customer issue."

fn spec.eventHandlers.triggerFulfillment.messages.conversationSuccess.withMetadata

withMetadata(metadata)

"Custom metadata. Dialogflow doesn't impose any structure on this."

obj spec.eventHandlers.triggerFulfillment.messages.liveAgentHandoff

"Indicates that the conversation should be handed off to a live agent.\nDialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures.\nYou may set this, for example:\n In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation.\n In a webhook response when you determine that the customer issue can only be handled by a human."

fn spec.eventHandlers.triggerFulfillment.messages.liveAgentHandoff.withMetadata

withMetadata(metadata)

"Custom metadata. Dialogflow doesn't impose any structure on this."

obj spec.eventHandlers.triggerFulfillment.messages.outputAudioText

"A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message."

fn spec.eventHandlers.triggerFulfillment.messages.outputAudioText.withAllowPlaybackInterruption

withAllowPlaybackInterruption(allowPlaybackInterruption)

"Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request."

fn spec.eventHandlers.triggerFulfillment.messages.outputAudioText.withSsml

withSsml(ssml)

"The SSML text to be synthesized. For more information, see SSML."

fn spec.eventHandlers.triggerFulfillment.messages.outputAudioText.withText

withText(text)

"The raw text to be synthesized."

obj spec.eventHandlers.triggerFulfillment.messages.playAudio

"Specifies an audio clip to be played by the client as part of the response."

fn spec.eventHandlers.triggerFulfillment.messages.playAudio.withAllowPlaybackInterruption

withAllowPlaybackInterruption(allowPlaybackInterruption)

"Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request."

fn spec.eventHandlers.triggerFulfillment.messages.playAudio.withAudioUri

withAudioUri(audioUri)

"URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it."

obj spec.eventHandlers.triggerFulfillment.messages.telephonyTransferCall

"Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint."

fn spec.eventHandlers.triggerFulfillment.messages.telephonyTransferCall.withPhoneNumber

withPhoneNumber(phoneNumber)

"Transfer the call to a phone number in E.164 format."

obj spec.eventHandlers.triggerFulfillment.messages.text

"The text response message."

fn spec.eventHandlers.triggerFulfillment.messages.text.withAllowPlaybackInterruption

withAllowPlaybackInterruption(allowPlaybackInterruption)

"Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request."

fn spec.eventHandlers.triggerFulfillment.messages.text.withText

withText(text)

"A collection of text responses."

fn spec.eventHandlers.triggerFulfillment.messages.text.withTextMixin

withTextMixin(text)

"A collection of text responses."

Note: This function appends passed data to existing values

obj spec.eventHandlers.triggerFulfillment.setParameterActions

"Set parameter values before executing the webhook."

fn spec.eventHandlers.triggerFulfillment.setParameterActions.withParameter

withParameter(parameter)

"Display name of the parameter."

fn spec.eventHandlers.triggerFulfillment.setParameterActions.withValue

withValue(value)

"The new JSON-encoded value of the parameter. A null value clears the parameter."

obj spec.nluSettings

"NLU related settings of the flow."

fn spec.nluSettings.withClassificationThreshold

withClassificationThreshold(classificationThreshold)

"To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold.\nIf the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used."

fn spec.nluSettings.withModelTrainingMode

withModelTrainingMode(modelTrainingMode)

"Indicates NLU model training mode.\n MODEL_TRAINING_MODE_AUTOMATIC: NLU model training is automatically triggered when a flow gets modified. User can also manually trigger model training in this mode.\n MODEL_TRAINING_MODE_MANUAL: User needs to manually trigger NLU model training. Best for large flows whose models take long time to train. Possible values: [\"MODEL_TRAINING_MODE_AUTOMATIC\", \"MODEL_TRAINING_MODE_MANUAL\"]."

fn spec.nluSettings.withModelType

withModelType(modelType)

"Indicates the type of NLU model.\n MODEL_TYPE_STANDARD: Use standard NLU model.\n MODEL_TYPE_ADVANCED: Use advanced NLU model. Possible values: [\"MODEL_TYPE_STANDARD\", \"MODEL_TYPE_ADVANCED\"]."

obj spec.transitionRoutes

"A flow's transition routes serve two purposes:\nThey are responsible for matching the user's first utterances in the flow.\nThey are inherited by every page's [transition routes][Page.transition_routes] and can support use cases such as the user saying \"help\" or \"can I talk to a human?\", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.\n\nTransitionRoutes are evalauted in the following order:\n TransitionRoutes with intent specified.\n TransitionRoutes with only condition specified.\n TransitionRoutes with intent specified are inherited by pages in the flow."

fn spec.transitionRoutes.withCondition

withCondition(condition)

"The condition to evaluate against form parameters or session parameters.\nAt least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled."

fn spec.transitionRoutes.withIntent

withIntent(intent)

"The unique identifier of an Intent.\nFormat: projects//locations//agents//intents/. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled."

fn spec.transitionRoutes.withName

withName(name)

"The unique identifier of this transition route."

fn spec.transitionRoutes.withTargetFlow

withTargetFlow(targetFlow)

"The target flow to transition to.\nFormat: projects//locations//agents//flows/."

fn spec.transitionRoutes.withTargetPage

withTargetPage(targetPage)

"The target page to transition to.\nFormat: projects//locations//agents//flows//pages/."

obj spec.transitionRoutes.triggerFulfillment

"The fulfillment to call when the condition is satisfied. At least one of triggerFulfillment and target must be specified. When both are defined, triggerFulfillment is executed first."

fn spec.transitionRoutes.triggerFulfillment.withConditionalCases

withConditionalCases(conditionalCases)

"Conditional cases for this fulfillment."

fn spec.transitionRoutes.triggerFulfillment.withConditionalCasesMixin

withConditionalCasesMixin(conditionalCases)

"Conditional cases for this fulfillment."

Note: This function appends passed data to existing values

fn spec.transitionRoutes.triggerFulfillment.withMessages

withMessages(messages)

"The list of rich message responses to present to the user."

fn spec.transitionRoutes.triggerFulfillment.withMessagesMixin

withMessagesMixin(messages)

"The list of rich message responses to present to the user."

Note: This function appends passed data to existing values

fn spec.transitionRoutes.triggerFulfillment.withReturnPartialResponses

withReturnPartialResponses(returnPartialResponses)

"Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks."

fn spec.transitionRoutes.triggerFulfillment.withSetParameterActions

withSetParameterActions(setParameterActions)

"Set parameter values before executing the webhook."

fn spec.transitionRoutes.triggerFulfillment.withSetParameterActionsMixin

withSetParameterActionsMixin(setParameterActions)

"Set parameter values before executing the webhook."

Note: This function appends passed data to existing values

fn spec.transitionRoutes.triggerFulfillment.withTag

withTag(tag)

"The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified."

fn spec.transitionRoutes.triggerFulfillment.withWebhook

withWebhook(webhook)

"The webhook to call. Format: projects//locations//agents//webhooks/."

obj spec.transitionRoutes.triggerFulfillment.conditionalCases

"Conditional cases for this fulfillment."

fn spec.transitionRoutes.triggerFulfillment.conditionalCases.withCases

withCases(cases)

"A JSON encoded list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.\nSee Case for the schema."

obj spec.transitionRoutes.triggerFulfillment.messages

"The list of rich message responses to present to the user."

fn spec.transitionRoutes.triggerFulfillment.messages.withChannel

withChannel(channel)

"The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned."

fn spec.transitionRoutes.triggerFulfillment.messages.withPayload

withPayload(payload)

"A custom, platform-specific payload."

obj spec.transitionRoutes.triggerFulfillment.messages.conversationSuccess

"Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about.\nDialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess.\nYou may set this, for example:\n In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded.\n In a webhook response when you determine that you handled the customer issue."

fn spec.transitionRoutes.triggerFulfillment.messages.conversationSuccess.withMetadata

withMetadata(metadata)

"Custom metadata. Dialogflow doesn't impose any structure on this."

obj spec.transitionRoutes.triggerFulfillment.messages.liveAgentHandoff

"Indicates that the conversation should be handed off to a live agent.\nDialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures.\nYou may set this, for example:\n In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation.\n In a webhook response when you determine that the customer issue can only be handled by a human."

fn spec.transitionRoutes.triggerFulfillment.messages.liveAgentHandoff.withMetadata

withMetadata(metadata)

"Custom metadata. Dialogflow doesn't impose any structure on this."

obj spec.transitionRoutes.triggerFulfillment.messages.outputAudioText

"A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message."

fn spec.transitionRoutes.triggerFulfillment.messages.outputAudioText.withAllowPlaybackInterruption

withAllowPlaybackInterruption(allowPlaybackInterruption)

"Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request."

fn spec.transitionRoutes.triggerFulfillment.messages.outputAudioText.withSsml

withSsml(ssml)

"The SSML text to be synthesized. For more information, see SSML."

fn spec.transitionRoutes.triggerFulfillment.messages.outputAudioText.withText

withText(text)

"The raw text to be synthesized."

obj spec.transitionRoutes.triggerFulfillment.messages.playAudio

"Specifies an audio clip to be played by the client as part of the response."

fn spec.transitionRoutes.triggerFulfillment.messages.playAudio.withAllowPlaybackInterruption

withAllowPlaybackInterruption(allowPlaybackInterruption)

"Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request."

fn spec.transitionRoutes.triggerFulfillment.messages.playAudio.withAudioUri

withAudioUri(audioUri)

"URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it."

obj spec.transitionRoutes.triggerFulfillment.messages.telephonyTransferCall

"Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint."

fn spec.transitionRoutes.triggerFulfillment.messages.telephonyTransferCall.withPhoneNumber

withPhoneNumber(phoneNumber)

"Transfer the call to a phone number in E.164 format."

obj spec.transitionRoutes.triggerFulfillment.messages.text

"The text response message."

fn spec.transitionRoutes.triggerFulfillment.messages.text.withAllowPlaybackInterruption

withAllowPlaybackInterruption(allowPlaybackInterruption)

"Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request."

fn spec.transitionRoutes.triggerFulfillment.messages.text.withText

withText(text)

"A collection of text responses."

fn spec.transitionRoutes.triggerFulfillment.messages.text.withTextMixin

withTextMixin(text)

"A collection of text responses."

Note: This function appends passed data to existing values

obj spec.transitionRoutes.triggerFulfillment.setParameterActions

"Set parameter values before executing the webhook."

fn spec.transitionRoutes.triggerFulfillment.setParameterActions.withParameter

withParameter(parameter)

"Display name of the parameter."

fn spec.transitionRoutes.triggerFulfillment.setParameterActions.withValue

withValue(value)

"The new JSON-encoded value of the parameter. A null value clears the parameter."