dialogflow_cx_flow.md

permalink
/dialogflow_cx_flow/

dialogflow_cx_flow

dialogflow_cx_flow represents the google_dialogflow_cx_flow Terraform resource.

This package contains functions and utilities for setting up the resource using Jsonnet code.

Index

• fn new()
• fn newAttrs()
• fn withDescription()
• fn withDisplayName()
• fn withEventHandlers()
• fn withEventHandlersMixin()
• fn withLanguageCode()
• fn withNluSettings()
• fn withNluSettingsMixin()
• fn withParent()
• fn withTimeouts()
• fn withTimeoutsMixin()
• fn withTransitionRouteGroups()
• fn withTransitionRoutes()
• fn withTransitionRoutesMixin()
• obj event_handlers
  • fn new()
  • obj event_handlers.trigger_fulfillment
    • fn new()
    • obj event_handlers.trigger_fulfillment.conditional_cases
      • fn new()
    • obj event_handlers.trigger_fulfillment.messages
      • fn new()
      • obj event_handlers.trigger_fulfillment.messages.conversation_success
        • fn new()
      • obj event_handlers.trigger_fulfillment.messages.live_agent_handoff
        • fn new()
      • obj event_handlers.trigger_fulfillment.messages.output_audio_text
        • fn new()
      • obj event_handlers.trigger_fulfillment.messages.play_audio
        • fn new()
      • obj event_handlers.trigger_fulfillment.messages.telephony_transfer_call
        • fn new()
      • obj event_handlers.trigger_fulfillment.messages.text
        • fn new()
    • obj event_handlers.trigger_fulfillment.set_parameter_actions
      • fn new()
• obj nlu_settings
  • fn new()
• obj timeouts
  • fn new()
• obj transition_routes
  • fn new()
  • obj transition_routes.trigger_fulfillment
    • fn new()
    • obj transition_routes.trigger_fulfillment.conditional_cases
      • fn new()
    • obj transition_routes.trigger_fulfillment.messages
      • fn new()
      • obj transition_routes.trigger_fulfillment.messages.conversation_success
        • fn new()
      • obj transition_routes.trigger_fulfillment.messages.live_agent_handoff
        • fn new()
      • obj transition_routes.trigger_fulfillment.messages.output_audio_text
        • fn new()
      • obj transition_routes.trigger_fulfillment.messages.play_audio
        • fn new()
      • obj transition_routes.trigger_fulfillment.messages.telephony_transfer_call
        • fn new()
      • obj transition_routes.trigger_fulfillment.messages.text
        • fn new()
    • obj transition_routes.trigger_fulfillment.set_parameter_actions
      • fn new()

Fields

fn new

new()

google.dialogflow_cx_flow.new injects a new google_dialogflow_cx_flow Terraform resource block into the root module document.

Additionally, this inserts a private function into the _ref attribute that generates references to attributes of the resource. For example, if you added a new instance to the root using:

# arguments omitted for brevity
google.dialogflow_cx_flow.new('some_id')

You can get the reference to the id field of the created google.dialogflow_cx_flow using the reference:

$._ref.google_dialogflow_cx_flow.some_id.get('id')

This is the same as directly entering "${ google_dialogflow_cx_flow.some_id.id }" as the value.

NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use super, self, or $ to refer to the root object. Instead, make an explicit outer object using local.

Args:

• resourceLabel (string): The name label of the block.
• description (string): The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected. When null, the description field will be omitted from the resulting object.
• display_name (string): The human-readable name of the flow.
• language_code (string): The language of the following fields in flow: Flow.event_handlers.trigger_fulfillment.messages Flow.event_handlers.trigger_fulfillment.conditional_cases Flow.transition_routes.trigger_fulfillment.messages Flow.transition_routes.trigger_fulfillment.conditional_cases If 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. When null, the language_code field will be omitted from the resulting object.
• parent (string): The agent to create a flow for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. When null, the parent field will be omitted from the resulting object.
• transition_route_groups (list): A flow's transition route group serve two purposes: They are responsible for matching the user's first utterances in the flow. They 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. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>. When null, the transition_route_groups field will be omitted from the resulting object.
• event_handlers (list[obj]): A flow's event handlers serve two purposes: They are responsible for handling events (e.g. no match, webhook errors) in the flow. They 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. Unlike transitionRoutes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. When null, the event_handlers sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.event_handlers.new constructor.
• nlu_settings (list[obj]): NLU related settings of the flow. When null, the nlu_settings sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.nlu_settings.new constructor.
• timeouts (obj): Set the timeouts field on the resulting resource block. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.timeouts.new constructor.
• transition_routes (list[obj]): A flow's transition routes serve two purposes: They are responsible for matching the user's first utterances in the flow. They 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.

TransitionRoutes are evalauted in the following order: TransitionRoutes with intent specified. TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. When null, the transition_routes sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.transition_routes.new constructor.

Returns:

• A mixin object that injects the new resource into the root Terraform configuration.

fn newAttrs

newAttrs()

google.dialogflow_cx_flow.newAttrs constructs a new object with attributes and blocks configured for the dialogflow_cx_flow Terraform resource.

Unlike google.dialogflow_cx_flow.new, this function will not inject the resource block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withResource function to build a complete block.

This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.

Args:

• description (string): The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected. When null, the description field will be omitted from the resulting object.
• display_name (string): The human-readable name of the flow.
• language_code (string): The language of the following fields in flow: Flow.event_handlers.trigger_fulfillment.messages Flow.event_handlers.trigger_fulfillment.conditional_cases Flow.transition_routes.trigger_fulfillment.messages Flow.transition_routes.trigger_fulfillment.conditional_cases If 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. When null, the language_code field will be omitted from the resulting object.
• parent (string): The agent to create a flow for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. When null, the parent field will be omitted from the resulting object.
• transition_route_groups (list): A flow's transition route group serve two purposes: They are responsible for matching the user's first utterances in the flow. They 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. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>. When null, the transition_route_groups field will be omitted from the resulting object.
• event_handlers (list[obj]): A flow's event handlers serve two purposes: They are responsible for handling events (e.g. no match, webhook errors) in the flow. They 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. Unlike transitionRoutes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. When null, the event_handlers sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.event_handlers.new constructor.
• nlu_settings (list[obj]): NLU related settings of the flow. When null, the nlu_settings sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.nlu_settings.new constructor.
• timeouts (obj): Set the timeouts field on the resulting object. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.timeouts.new constructor.
• transition_routes (list[obj]): A flow's transition routes serve two purposes: They are responsible for matching the user's first utterances in the flow. They 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.

TransitionRoutes are evalauted in the following order: TransitionRoutes with intent specified. TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. When null, the transition_routes sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.transition_routes.new constructor.

Returns:

• An attribute object that can be used with tf.withResource to construct a new dialogflow_cx_flow resource into the root Terraform configuration.

fn withDescription

withDescription()

google.string.withDescription constructs a mixin object that can be merged into the string Terraform resource block to set or update the description field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the description field.

fn withDisplayName

withDisplayName()

google.string.withDisplayName constructs a mixin object that can be merged into the string Terraform resource block to set or update the display_name field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the display_name field.

fn withEventHandlers

withEventHandlers()

google.list[obj].withEventHandlers constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the event_handlers field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the google.list[obj].withEventHandlersMixin function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the event_handlers field.

fn withEventHandlersMixin

withEventHandlersMixin()

google.list[obj].withEventHandlersMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the event_handlers field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the google.list[obj].withEventHandlers function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the event_handlers field.

fn withLanguageCode

withLanguageCode()

google.string.withLanguageCode constructs a mixin object that can be merged into the string Terraform resource block to set or update the language_code field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the language_code field.

fn withNluSettings

withNluSettings()

google.list[obj].withNluSettings constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the nlu_settings field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the google.list[obj].withNluSettingsMixin function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the nlu_settings field.

fn withNluSettingsMixin

withNluSettingsMixin()

google.list[obj].withNluSettingsMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the nlu_settings field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the google.list[obj].withNluSettings function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the nlu_settings field.

fn withParent

withParent()

google.string.withParent constructs a mixin object that can be merged into the string Terraform resource block to set or update the parent field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the parent field.

fn withTimeouts

withTimeouts()

google.obj.withTimeouts constructs a mixin object that can be merged into the obj Terraform resource block to set or update the timeouts field.

This function will replace the map with the passed in value. If you wish to instead merge the passed in value to the existing map, use the google.obj.withTimeoutsMixin function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the timeouts field.

fn withTimeoutsMixin

withTimeoutsMixin()

google.obj.withTimeoutsMixin constructs a mixin object that can be merged into the obj Terraform resource block to set or update the timeouts field.

This function will merge the passed in value to the existing map. If you wish to instead replace the entire map with the passed in value, use the google.obj.withTimeouts function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the timeouts field.

fn withTransitionRouteGroups

withTransitionRouteGroups()

google.list.withTransitionRouteGroups constructs a mixin object that can be merged into the list Terraform resource block to set or update the transition_route_groups field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list): The value to set for the transition_route_groups field.

fn withTransitionRoutes

withTransitionRoutes()

google.list[obj].withTransitionRoutes constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the transition_routes field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the google.list[obj].withTransitionRoutesMixin function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the transition_routes field.

fn withTransitionRoutesMixin

withTransitionRoutesMixin()

google.list[obj].withTransitionRoutesMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the transition_routes field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the google.list[obj].withTransitionRoutes function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the transition_routes field.

obj event_handlers

fn event_handlers.new

new()

google.dialogflow_cx_flow.event_handlers.new constructs a new object with attributes and blocks configured for the event_handlers Terraform sub block.

Args:

• event (string): The name of the event to handle. When null, the event field will be omitted from the resulting object.
• target_flow (string): The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. When null, the target_flow field will be omitted from the resulting object.
• target_page (string): The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>. When null, the target_page field will be omitted from the resulting object.
• trigger_fulfillment (list[obj]): 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. When null, the trigger_fulfillment sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.new constructor.

Returns:

• An attribute object that represents the event_handlers sub block.

obj event_handlers.trigger_fulfillment

fn event_handlers.trigger_fulfillment.new

new()

google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.new constructs a new object with attributes and blocks configured for the trigger_fulfillment Terraform sub block.

Args:

• return_partial_responses (bool): 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. When null, the return_partial_responses field will be omitted from the resulting object.
• tag (string): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When null, the tag field will be omitted from the resulting object.
• webhook (string): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When null, the webhook field will be omitted from the resulting object.
• conditional_cases (list[obj]): Conditional cases for this fulfillment. When null, the conditional_cases sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.conditional_cases.new constructor.
• messages (list[obj]): The list of rich message responses to present to the user. When null, the messages sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.new constructor.
• set_parameter_actions (list[obj]): Set parameter values before executing the webhook. When null, the set_parameter_actions sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.set_parameter_actions.new constructor.

Returns:

• An attribute object that represents the trigger_fulfillment sub block.

obj event_handlers.trigger_fulfillment.conditional_cases

fn event_handlers.trigger_fulfillment.conditional_cases.new

new()

google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.conditional_cases.new constructs a new object with attributes and blocks configured for the conditional_cases Terraform sub block.

Args:

• cases (string): 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. See Case for the schema. When null, the cases field will be omitted from the resulting object.

Returns:

• An attribute object that represents the conditional_cases sub block.

obj event_handlers.trigger_fulfillment.messages

fn event_handlers.trigger_fulfillment.messages.new

new()

google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.new constructs a new object with attributes and blocks configured for the messages Terraform sub block.

Args:

• channel (string): The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. When null, the channel field will be omitted from the resulting object.
• payload (string): A custom, platform-specific payload. When null, the payload field will be omitted from the resulting object.
• conversation_success (list[obj]): Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow 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. You may set this, for example:

• In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded.
• In a webhook response when you determine that you handled the customer issue. When null, the conversation_success sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.conversation_success.new constructor.
  • live_agent_handoff (list[obj]): Indicates that the conversation should be handed off to a live agent. Dialogflow 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. You may set this, for example:
• In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation.
• In a webhook response when you determine that the customer issue can only be handled by a human. When null, the live_agent_handoff sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.live_agent_handoff.new constructor.
  • output_audio_text (list[obj]): A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. When null, the output_audio_text sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.output_audio_text.new constructor.
  • play_audio (list[obj]): Specifies an audio clip to be played by the client as part of the response. When null, the play_audio sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.play_audio.new constructor.
  • telephony_transfer_call (list[obj]): Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. When null, the telephony_transfer_call sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.telephony_transfer_call.new constructor.
  • text (list[obj]): The text response message. When null, the text sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.text.new constructor.

Returns:

• An attribute object that represents the messages sub block.

obj event_handlers.trigger_fulfillment.messages.conversation_success

fn event_handlers.trigger_fulfillment.messages.conversation_success.new

new()

google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.conversation_success.new constructs a new object with attributes and blocks configured for the conversation_success Terraform sub block.

Args:

• metadata (string): Custom metadata. Dialogflow doesn't impose any structure on this. When null, the metadata field will be omitted from the resulting object.

Returns:

• An attribute object that represents the conversation_success sub block.

obj event_handlers.trigger_fulfillment.messages.live_agent_handoff

fn event_handlers.trigger_fulfillment.messages.live_agent_handoff.new

new()

google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.live_agent_handoff.new constructs a new object with attributes and blocks configured for the live_agent_handoff Terraform sub block.

Args:

• metadata (string): Custom metadata. Dialogflow doesn't impose any structure on this. When null, the metadata field will be omitted from the resulting object.

Returns:

• An attribute object that represents the live_agent_handoff sub block.

obj event_handlers.trigger_fulfillment.messages.output_audio_text

fn event_handlers.trigger_fulfillment.messages.output_audio_text.new

new()

google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.output_audio_text.new constructs a new object with attributes and blocks configured for the output_audio_text Terraform sub block.

Args:

• ssml (string): The SSML text to be synthesized. For more information, see SSML. When null, the ssml field will be omitted from the resulting object.
• text (string): The raw text to be synthesized. When null, the text field will be omitted from the resulting object.

Returns:

• An attribute object that represents the output_audio_text sub block.

obj event_handlers.trigger_fulfillment.messages.play_audio

fn event_handlers.trigger_fulfillment.messages.play_audio.new

new()

google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.play_audio.new constructs a new object with attributes and blocks configured for the play_audio Terraform sub block.

Args:

• audio_uri (string): URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.

Returns:

• An attribute object that represents the play_audio sub block.

obj event_handlers.trigger_fulfillment.messages.telephony_transfer_call

fn event_handlers.trigger_fulfillment.messages.telephony_transfer_call.new

new()

google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.telephony_transfer_call.new constructs a new object with attributes and blocks configured for the telephony_transfer_call Terraform sub block.

Args:

• phone_number (string): Transfer the call to a phone number in E.164 format.

Returns:

• An attribute object that represents the telephony_transfer_call sub block.

obj event_handlers.trigger_fulfillment.messages.text

fn event_handlers.trigger_fulfillment.messages.text.new

new()

google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.text.new constructs a new object with attributes and blocks configured for the text Terraform sub block.

Args:

• text (list): A collection of text responses. When null, the text field will be omitted from the resulting object.

Returns:

• An attribute object that represents the text sub block.

obj event_handlers.trigger_fulfillment.set_parameter_actions

fn event_handlers.trigger_fulfillment.set_parameter_actions.new

new()

google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.set_parameter_actions.new constructs a new object with attributes and blocks configured for the set_parameter_actions Terraform sub block.

Args:

• parameter (string): Display name of the parameter. When null, the parameter field will be omitted from the resulting object.
• value (string): The new JSON-encoded value of the parameter. A null value clears the parameter. When null, the value field will be omitted from the resulting object.

Returns:

• An attribute object that represents the set_parameter_actions sub block.

obj nlu_settings

fn nlu_settings.new

new()

google.dialogflow_cx_flow.nlu_settings.new constructs a new object with attributes and blocks configured for the nlu_settings Terraform sub block.

Args:

• classification_threshold (number): 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. If 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. When null, the classification_threshold field will be omitted from the resulting object.
• model_training_mode (string): Indicates NLU model training mode.

• 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.
• 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"] When null, the model_training_mode field will be omitted from the resulting object.
  • model_type (string): Indicates the type of NLU model.
• MODEL_TYPE_STANDARD: Use standard NLU model.
• MODEL_TYPE_ADVANCED: Use advanced NLU model. Possible values: ["MODEL_TYPE_STANDARD", "MODEL_TYPE_ADVANCED"] When null, the model_type field will be omitted from the resulting object.

Returns:

• An attribute object that represents the nlu_settings sub block.

obj timeouts

fn timeouts.new

new()

google.dialogflow_cx_flow.timeouts.new constructs a new object with attributes and blocks configured for the timeouts Terraform sub block.

Args:

• create (string): Set the create field on the resulting object. When null, the create field will be omitted from the resulting object.
• delete (string): Set the delete field on the resulting object. When null, the delete field will be omitted from the resulting object.
• update (string): Set the update field on the resulting object. When null, the update field will be omitted from the resulting object.

Returns:

• An attribute object that represents the timeouts sub block.

obj transition_routes

fn transition_routes.new

new()

google.dialogflow_cx_flow.transition_routes.new constructs a new object with attributes and blocks configured for the transition_routes Terraform sub block.

Args:

• condition (string): The condition to evaluate against form parameters or session parameters. 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. When null, the condition field will be omitted from the resulting object.
• intent (string): The unique identifier of an Intent. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>. 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. When null, the intent field will be omitted from the resulting object.
• target_flow (string): The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. When null, the target_flow field will be omitted from the resulting object.
• target_page (string): The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>. When null, the target_page field will be omitted from the resulting object.
• trigger_fulfillment (list[obj]): 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. When null, the trigger_fulfillment sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.new constructor.

Returns:

• An attribute object that represents the transition_routes sub block.

obj transition_routes.trigger_fulfillment

fn transition_routes.trigger_fulfillment.new

new()

google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.new constructs a new object with attributes and blocks configured for the trigger_fulfillment Terraform sub block.

Args:

• return_partial_responses (bool): 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. When null, the return_partial_responses field will be omitted from the resulting object.
• tag (string): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When null, the tag field will be omitted from the resulting object.
• webhook (string): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When null, the webhook field will be omitted from the resulting object.
• conditional_cases (list[obj]): Conditional cases for this fulfillment. When null, the conditional_cases sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.conditional_cases.new constructor.
• messages (list[obj]): The list of rich message responses to present to the user. When null, the messages sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.new constructor.
• set_parameter_actions (list[obj]): Set parameter values before executing the webhook. When null, the set_parameter_actions sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.set_parameter_actions.new constructor.

Returns:

• An attribute object that represents the trigger_fulfillment sub block.

obj transition_routes.trigger_fulfillment.conditional_cases

fn transition_routes.trigger_fulfillment.conditional_cases.new

new()

google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.conditional_cases.new constructs a new object with attributes and blocks configured for the conditional_cases Terraform sub block.

Args:

• cases (string): 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. See Case for the schema. When null, the cases field will be omitted from the resulting object.

Returns:

• An attribute object that represents the conditional_cases sub block.

obj transition_routes.trigger_fulfillment.messages

fn transition_routes.trigger_fulfillment.messages.new

new()

google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.new constructs a new object with attributes and blocks configured for the messages Terraform sub block.

Args:

• channel (string): The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. When null, the channel field will be omitted from the resulting object.
• payload (string): A custom, platform-specific payload. When null, the payload field will be omitted from the resulting object.
• conversation_success (list[obj]): Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow 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. You may set this, for example:

• In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded.
• In a webhook response when you determine that you handled the customer issue. When null, the conversation_success sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.conversation_success.new constructor.
  • live_agent_handoff (list[obj]): Indicates that the conversation should be handed off to a live agent. Dialogflow 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. You may set this, for example:
• In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation.
• In a webhook response when you determine that the customer issue can only be handled by a human. When null, the live_agent_handoff sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.live_agent_handoff.new constructor.
  • output_audio_text (list[obj]): A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. When null, the output_audio_text sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.output_audio_text.new constructor.
  • play_audio (list[obj]): Specifies an audio clip to be played by the client as part of the response. When null, the play_audio sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.play_audio.new constructor.
  • telephony_transfer_call (list[obj]): Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. When null, the telephony_transfer_call sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.telephony_transfer_call.new constructor.
  • text (list[obj]): The text response message. When null, the text sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.text.new constructor.

Returns:

• An attribute object that represents the messages sub block.

obj transition_routes.trigger_fulfillment.messages.conversation_success

fn transition_routes.trigger_fulfillment.messages.conversation_success.new

new()

google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.conversation_success.new constructs a new object with attributes and blocks configured for the conversation_success Terraform sub block.

Args:

• metadata (string): Custom metadata. Dialogflow doesn't impose any structure on this. When null, the metadata field will be omitted from the resulting object.

Returns:

• An attribute object that represents the conversation_success sub block.

obj transition_routes.trigger_fulfillment.messages.live_agent_handoff

fn transition_routes.trigger_fulfillment.messages.live_agent_handoff.new

new()

google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.live_agent_handoff.new constructs a new object with attributes and blocks configured for the live_agent_handoff Terraform sub block.

Args:

• metadata (string): Custom metadata. Dialogflow doesn't impose any structure on this. When null, the metadata field will be omitted from the resulting object.

Returns:

• An attribute object that represents the live_agent_handoff sub block.

obj transition_routes.trigger_fulfillment.messages.output_audio_text

fn transition_routes.trigger_fulfillment.messages.output_audio_text.new

new()

google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.output_audio_text.new constructs a new object with attributes and blocks configured for the output_audio_text Terraform sub block.

Args:

• ssml (string): The SSML text to be synthesized. For more information, see SSML. When null, the ssml field will be omitted from the resulting object.
• text (string): The raw text to be synthesized. When null, the text field will be omitted from the resulting object.

Returns:

• An attribute object that represents the output_audio_text sub block.

obj transition_routes.trigger_fulfillment.messages.play_audio

fn transition_routes.trigger_fulfillment.messages.play_audio.new

new()

google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.play_audio.new constructs a new object with attributes and blocks configured for the play_audio Terraform sub block.

Args:

• audio_uri (string): URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.

Returns:

• An attribute object that represents the play_audio sub block.

obj transition_routes.trigger_fulfillment.messages.telephony_transfer_call

fn transition_routes.trigger_fulfillment.messages.telephony_transfer_call.new

new()

google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.telephony_transfer_call.new constructs a new object with attributes and blocks configured for the telephony_transfer_call Terraform sub block.

Args:

• phone_number (string): Transfer the call to a phone number in E.164 format.

Returns:

• An attribute object that represents the telephony_transfer_call sub block.

obj transition_routes.trigger_fulfillment.messages.text

fn transition_routes.trigger_fulfillment.messages.text.new

new()

google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.text.new constructs a new object with attributes and blocks configured for the text Terraform sub block.

Args:

• text (list): A collection of text responses. When null, the text field will be omitted from the resulting object.

Returns:

• An attribute object that represents the text sub block.

obj transition_routes.trigger_fulfillment.set_parameter_actions

fn transition_routes.trigger_fulfillment.set_parameter_actions.new

new()

google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.set_parameter_actions.new constructs a new object with attributes and blocks configured for the set_parameter_actions Terraform sub block.

Args:

• parameter (string): Display name of the parameter. When null, the parameter field will be omitted from the resulting object.
• value (string): The new JSON-encoded value of the parameter. A null value clears the parameter. When null, the value field will be omitted from the resulting object.

Returns:

• An attribute object that represents the set_parameter_actions sub block.