dialogflowcxflow_v1alpha1.json

{
  "properties": {
    "apiVersion": {
      "description": "apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources",
      "type": "string"
    },
    "kind": {
      "description": "kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "properties": {
        "description": {
          "description": "The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected.",
          "type": "string"
        },
        "displayName": {
          "description": "The human-readable name of the flow.",
          "type": "string"
        },
        "eventHandlers": {
          "description": "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.",
          "items": {
            "properties": {
              "event": {
                "description": "The name of the event to handle.",
                "type": "string"
              },
              "name": {
                "description": "The unique identifier of this event handler.",
                "type": "string"
              },
              "targetFlow": {
                "description": "The target flow to transition to.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.",
                "type": "string"
              },
              "targetPage": {
                "description": "The target page to transition to.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.",
                "type": "string"
              },
              "triggerFulfillment": {
                "description": "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.",
                "properties": {
                  "conditionalCases": {
                    "description": "Conditional cases for this fulfillment.",
                    "items": {
                      "properties": {
                        "cases": {
                          "description": "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](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Fulfillment#case) for the schema.",
                          "type": "string"
                        }
                      },
                      "type": "object",
                      "additionalProperties": false
                    },
                    "type": "array"
                  },
                  "messages": {
                    "description": "The list of rich message responses to present to the user.",
                    "items": {
                      "properties": {
                        "channel": {
                          "description": "The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.",
                          "type": "string"
                        },
                        "conversationSuccess": {
                          "description": "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.",
                          "properties": {
                            "metadata": {
                              "description": "Custom metadata. Dialogflow doesn't impose any structure on this.",
                              "type": "string"
                            }
                          },
                          "type": "object",
                          "additionalProperties": false
                        },
                        "liveAgentHandoff": {
                          "description": "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.",
                          "properties": {
                            "metadata": {
                              "description": "Custom metadata. Dialogflow doesn't impose any structure on this.",
                              "type": "string"
                            }
                          },
                          "type": "object",
                          "additionalProperties": false
                        },
                        "outputAudioText": {
                          "description": "A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.",
                          "properties": {
                            "allowPlaybackInterruption": {
                              "description": "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.",
                              "type": "boolean"
                            },
                            "ssml": {
                              "description": "The SSML text to be synthesized. For more information, see SSML.",
                              "type": "string"
                            },
                            "text": {
                              "description": "The raw text to be synthesized.",
                              "type": "string"
                            }
                          },
                          "type": "object",
                          "additionalProperties": false
                        },
                        "payload": {
                          "description": "A custom, platform-specific payload.",
                          "type": "string"
                        },
                        "playAudio": {
                          "description": "Specifies an audio clip to be played by the client as part of the response.",
                          "properties": {
                            "allowPlaybackInterruption": {
                              "description": "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.",
                              "type": "boolean"
                            },
                            "audioUri": {
                              "description": "URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.",
                              "type": "string"
                            }
                          },
                          "required": [
                            "audioUri"
                          ],
                          "type": "object",
                          "additionalProperties": false
                        },
                        "telephonyTransferCall": {
                          "description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.",
                          "properties": {
                            "phoneNumber": {
                              "description": "Transfer the call to a phone number in E.164 format.",
                              "type": "string"
                            }
                          },
                          "required": [
                            "phoneNumber"
                          ],
                          "type": "object",
                          "additionalProperties": false
                        },
                        "text": {
                          "description": "The text response message.",
                          "properties": {
                            "allowPlaybackInterruption": {
                              "description": "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.",
                              "type": "boolean"
                            },
                            "text": {
                              "description": "A collection of text responses.",
                              "items": {
                                "type": "string"
                              },
                              "type": "array"
                            }
                          },
                          "type": "object",
                          "additionalProperties": false
                        }
                      },
                      "type": "object",
                      "additionalProperties": false
                    },
                    "type": "array"
                  },
                  "returnPartialResponses": {
                    "description": "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.",
                    "type": "boolean"
                  },
                  "setParameterActions": {
                    "description": "Set parameter values before executing the webhook.",
                    "items": {
                      "properties": {
                        "parameter": {
                          "description": "Display name of the parameter.",
                          "type": "string"
                        },
                        "value": {
                          "description": "The new JSON-encoded value of the parameter. A null value clears the parameter.",
                          "type": "string"
                        }
                      },
                      "type": "object",
                      "additionalProperties": false
                    },
                    "type": "array"
                  },
                  "tag": {
                    "description": "The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified.",
                    "type": "string"
                  },
                  "webhook": {
                    "description": "The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>.",
                    "type": "string"
                  }
                },
                "type": "object",
                "additionalProperties": false
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "languageCode": {
          "description": "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.",
          "type": "string"
        },
        "nluSettings": {
          "description": "NLU related settings of the flow.",
          "properties": {
            "classificationThreshold": {
              "description": "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.",
              "type": "number"
            },
            "modelTrainingMode": {
              "description": "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\"].",
              "type": "string"
            },
            "modelType": {
              "description": "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\"].",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "parent": {
          "description": "Immutable. The agent to create a flow for.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.",
          "type": "string"
        },
        "resourceID": {
          "description": "Immutable. Optional. The service-generated name of the resource. Used for acquisition only. Leave unset to create a new resource.",
          "type": "string"
        },
        "transitionRouteGroups": {
          "description": "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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "transitionRoutes": {
          "description": "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 evaluated 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.",
          "items": {
            "properties": {
              "condition": {
                "description": "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.",
                "type": "string"
              },
              "intent": {
                "description": "The unique identifier of an Intent.\nFormat: 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.",
                "type": "string"
              },
              "name": {
                "description": "The unique identifier of this transition route.",
                "type": "string"
              },
              "targetFlow": {
                "description": "The target flow to transition to.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.",
                "type": "string"
              },
              "targetPage": {
                "description": "The target page to transition to.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.",
                "type": "string"
              },
              "triggerFulfillment": {
                "description": "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.",
                "properties": {
                  "conditionalCases": {
                    "description": "Conditional cases for this fulfillment.",
                    "items": {
                      "properties": {
                        "cases": {
                          "description": "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](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Fulfillment#case) for the schema.",
                          "type": "string"
                        }
                      },
                      "type": "object",
                      "additionalProperties": false
                    },
                    "type": "array"
                  },
                  "messages": {
                    "description": "The list of rich message responses to present to the user.",
                    "items": {
                      "properties": {
                        "channel": {
                          "description": "The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.",
                          "type": "string"
                        },
                        "conversationSuccess": {
                          "description": "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.",
                          "properties": {
                            "metadata": {
                              "description": "Custom metadata. Dialogflow doesn't impose any structure on this.",
                              "type": "string"
                            }
                          },
                          "type": "object",
                          "additionalProperties": false
                        },
                        "liveAgentHandoff": {
                          "description": "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.",
                          "properties": {
                            "metadata": {
                              "description": "Custom metadata. Dialogflow doesn't impose any structure on this.",
                              "type": "string"
                            }
                          },
                          "type": "object",
                          "additionalProperties": false
                        },
                        "outputAudioText": {
                          "description": "A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.",
                          "properties": {
                            "allowPlaybackInterruption": {
                              "description": "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.",
                              "type": "boolean"
                            },
                            "ssml": {
                              "description": "The SSML text to be synthesized. For more information, see SSML.",
                              "type": "string"
                            },
                            "text": {
                              "description": "The raw text to be synthesized.",
                              "type": "string"
                            }
                          },
                          "type": "object",
                          "additionalProperties": false
                        },
                        "payload": {
                          "description": "A custom, platform-specific payload.",
                          "type": "string"
                        },
                        "playAudio": {
                          "description": "Specifies an audio clip to be played by the client as part of the response.",
                          "properties": {
                            "allowPlaybackInterruption": {
                              "description": "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.",
                              "type": "boolean"
                            },
                            "audioUri": {
                              "description": "URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.",
                              "type": "string"
                            }
                          },
                          "required": [
                            "audioUri"
                          ],
                          "type": "object",
                          "additionalProperties": false
                        },
                        "telephonyTransferCall": {
                          "description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.",
                          "properties": {
                            "phoneNumber": {
                              "description": "Transfer the call to a phone number in E.164 format.",
                              "type": "string"
                            }
                          },
                          "required": [
                            "phoneNumber"
                          ],
                          "type": "object",
                          "additionalProperties": false
                        },
                        "text": {
                          "description": "The text response message.",
                          "properties": {
                            "allowPlaybackInterruption": {
                              "description": "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.",
                              "type": "boolean"
                            },
                            "text": {
                              "description": "A collection of text responses.",
                              "items": {
                                "type": "string"
                              },
                              "type": "array"
                            }
                          },
                          "type": "object",
                          "additionalProperties": false
                        }
                      },
                      "type": "object",
                      "additionalProperties": false
                    },
                    "type": "array"
                  },
                  "returnPartialResponses": {
                    "description": "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.",
                    "type": "boolean"
                  },
                  "setParameterActions": {
                    "description": "Set parameter values before executing the webhook.",
                    "items": {
                      "properties": {
                        "parameter": {
                          "description": "Display name of the parameter.",
                          "type": "string"
                        },
                        "value": {
                          "description": "The new JSON-encoded value of the parameter. A null value clears the parameter.",
                          "type": "string"
                        }
                      },
                      "type": "object",
                      "additionalProperties": false
                    },
                    "type": "array"
                  },
                  "tag": {
                    "description": "The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified.",
                    "type": "string"
                  },
                  "webhook": {
                    "description": "The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>.",
                    "type": "string"
                  }
                },
                "type": "object",
                "additionalProperties": false
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        }
      },
      "required": [
        "displayName"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "properties": {
        "conditions": {
          "description": "Conditions represent the latest available observation of the resource's current state.",
          "items": {
            "properties": {
              "lastTransitionTime": {
                "description": "Last time the condition transitioned from one status to another.",
                "type": "string"
              },
              "message": {
                "description": "Human-readable message indicating details about last transition.",
                "type": "string"
              },
              "reason": {
                "description": "Unique, one-word, CamelCase reason for the condition's last transition.",
                "type": "string"
              },
              "status": {
                "description": "Status is the status of the condition. Can be True, False, Unknown.",
                "type": "string"
              },
              "type": {
                "description": "Type is the type of the condition.",
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "name": {
          "description": "The unique identifier of the flow.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.",
          "type": "string"
        },
        "observedGeneration": {
          "description": "ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.",
          "type": "integer"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  },
  "required": [
    "spec"
  ],
  "type": "object"
}