1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dialogflow
  5. dialogflow/v3beta1
  6. getPage

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

google-native.dialogflow/v3beta1.getPage

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

    Retrieves the specified page.

    Using getPage

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPage(args: GetPageArgs, opts?: InvokeOptions): Promise<GetPageResult>
    function getPageOutput(args: GetPageOutputArgs, opts?: InvokeOptions): Output<GetPageResult>
    def get_page(agent_id: Optional[str] = None,
                 flow_id: Optional[str] = None,
                 language_code: Optional[str] = None,
                 location: Optional[str] = None,
                 page_id: Optional[str] = None,
                 project: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetPageResult
    def get_page_output(agent_id: Optional[pulumi.Input[str]] = None,
                 flow_id: Optional[pulumi.Input[str]] = None,
                 language_code: Optional[pulumi.Input[str]] = None,
                 location: Optional[pulumi.Input[str]] = None,
                 page_id: Optional[pulumi.Input[str]] = None,
                 project: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetPageResult]
    func LookupPage(ctx *Context, args *LookupPageArgs, opts ...InvokeOption) (*LookupPageResult, error)
    func LookupPageOutput(ctx *Context, args *LookupPageOutputArgs, opts ...InvokeOption) LookupPageResultOutput

    > Note: This function is named LookupPage in the Go SDK.

    public static class GetPage 
    {
        public static Task<GetPageResult> InvokeAsync(GetPageArgs args, InvokeOptions? opts = null)
        public static Output<GetPageResult> Invoke(GetPageInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPageResult> getPage(GetPageArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: google-native:dialogflow/v3beta1:getPage
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AgentId string
    FlowId string
    Location string
    PageId string
    LanguageCode string
    Project string
    AgentId string
    FlowId string
    Location string
    PageId string
    LanguageCode string
    Project string
    agentId String
    flowId String
    location String
    pageId String
    languageCode String
    project String
    agentId string
    flowId string
    location string
    pageId string
    languageCode string
    project string
    agentId String
    flowId String
    location String
    pageId String
    languageCode String
    project String

    getPage Result

    The following output properties are available:

    DisplayName string

    The human-readable name of the page, unique within the flow.

    EntryFulfillment Pulumi.GoogleNative.Dialogflow.V3Beta1.Outputs.GoogleCloudDialogflowCxV3beta1FulfillmentResponse

    The fulfillment to call when the session is entering the page.

    EventHandlers List<Pulumi.GoogleNative.Dialogflow.V3Beta1.Outputs.GoogleCloudDialogflowCxV3beta1EventHandlerResponse>

    Handlers associated with the page to handle events such as webhook errors, no match or no input.

    Form Pulumi.GoogleNative.Dialogflow.V3Beta1.Outputs.GoogleCloudDialogflowCxV3beta1FormResponse

    The form associated with the page, used for collecting parameters relevant to the page.

    Name string

    The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: projects//locations//agents//flows//pages/.

    TransitionRouteGroups List<string>

    Ordered list of TransitionRouteGroups associated with the page. Transition route groups must be unique within a page. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/.

    TransitionRoutes List<Pulumi.GoogleNative.Dialogflow.V3Beta1.Outputs.GoogleCloudDialogflowCxV3beta1TransitionRouteResponse>

    A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.

    DisplayName string

    The human-readable name of the page, unique within the flow.

    EntryFulfillment GoogleCloudDialogflowCxV3beta1FulfillmentResponse

    The fulfillment to call when the session is entering the page.

    EventHandlers []GoogleCloudDialogflowCxV3beta1EventHandlerResponse

    Handlers associated with the page to handle events such as webhook errors, no match or no input.

    Form GoogleCloudDialogflowCxV3beta1FormResponse

    The form associated with the page, used for collecting parameters relevant to the page.

    Name string

    The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: projects//locations//agents//flows//pages/.

    TransitionRouteGroups []string

    Ordered list of TransitionRouteGroups associated with the page. Transition route groups must be unique within a page. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/.

    TransitionRoutes []GoogleCloudDialogflowCxV3beta1TransitionRouteResponse

    A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.

    displayName String

    The human-readable name of the page, unique within the flow.

    entryFulfillment GoogleCloudDialogflowCxV3beta1FulfillmentResponse

    The fulfillment to call when the session is entering the page.

    eventHandlers List<GoogleCloudDialogflowCxV3beta1EventHandlerResponse>

    Handlers associated with the page to handle events such as webhook errors, no match or no input.

    form GoogleCloudDialogflowCxV3beta1FormResponse

    The form associated with the page, used for collecting parameters relevant to the page.

    name String

    The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: projects//locations//agents//flows//pages/.

    transitionRouteGroups List<String>

    Ordered list of TransitionRouteGroups associated with the page. Transition route groups must be unique within a page. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/.

    transitionRoutes List<GoogleCloudDialogflowCxV3beta1TransitionRouteResponse>

    A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.

    displayName string

    The human-readable name of the page, unique within the flow.

    entryFulfillment GoogleCloudDialogflowCxV3beta1FulfillmentResponse

    The fulfillment to call when the session is entering the page.

    eventHandlers GoogleCloudDialogflowCxV3beta1EventHandlerResponse[]

    Handlers associated with the page to handle events such as webhook errors, no match or no input.

    form GoogleCloudDialogflowCxV3beta1FormResponse

    The form associated with the page, used for collecting parameters relevant to the page.

    name string

    The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: projects//locations//agents//flows//pages/.

    transitionRouteGroups string[]

    Ordered list of TransitionRouteGroups associated with the page. Transition route groups must be unique within a page. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/.

    transitionRoutes GoogleCloudDialogflowCxV3beta1TransitionRouteResponse[]

    A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.

    display_name str

    The human-readable name of the page, unique within the flow.

    entry_fulfillment GoogleCloudDialogflowCxV3beta1FulfillmentResponse

    The fulfillment to call when the session is entering the page.

    event_handlers Sequence[GoogleCloudDialogflowCxV3beta1EventHandlerResponse]

    Handlers associated with the page to handle events such as webhook errors, no match or no input.

    form GoogleCloudDialogflowCxV3beta1FormResponse

    The form associated with the page, used for collecting parameters relevant to the page.

    name str

    The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: projects//locations//agents//flows//pages/.

    transition_route_groups Sequence[str]

    Ordered list of TransitionRouteGroups associated with the page. Transition route groups must be unique within a page. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/.

    transition_routes Sequence[GoogleCloudDialogflowCxV3beta1TransitionRouteResponse]

    A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.

    displayName String

    The human-readable name of the page, unique within the flow.

    entryFulfillment Property Map

    The fulfillment to call when the session is entering the page.

    eventHandlers List<Property Map>

    Handlers associated with the page to handle events such as webhook errors, no match or no input.

    form Property Map

    The form associated with the page, used for collecting parameters relevant to the page.

    name String

    The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: projects//locations//agents//flows//pages/.

    transitionRouteGroups List<String>

    Ordered list of TransitionRouteGroups associated with the page. Transition route groups must be unique within a page. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/.

    transitionRoutes List<Property Map>

    A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.

    Supporting Types

    GoogleCloudDialogflowCxV3beta1EventHandlerResponse

    Event string

    The name of the event to handle.

    Name string

    The unique identifier of this event handler.

    TargetFlow string

    The target flow to transition to. Format: projects//locations//agents//flows/.

    TargetPage string

    The target page to transition to. Format: projects//locations//agents//flows//pages/.

    TriggerFulfillment Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1FulfillmentResponse

    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.

    Event string

    The name of the event to handle.

    Name string

    The unique identifier of this event handler.

    TargetFlow string

    The target flow to transition to. Format: projects//locations//agents//flows/.

    TargetPage string

    The target page to transition to. Format: projects//locations//agents//flows//pages/.

    TriggerFulfillment GoogleCloudDialogflowCxV3beta1FulfillmentResponse

    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.

    event String

    The name of the event to handle.

    name String

    The unique identifier of this event handler.

    targetFlow String

    The target flow to transition to. Format: projects//locations//agents//flows/.

    targetPage String

    The target page to transition to. Format: projects//locations//agents//flows//pages/.

    triggerFulfillment GoogleCloudDialogflowCxV3beta1FulfillmentResponse

    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.

    event string

    The name of the event to handle.

    name string

    The unique identifier of this event handler.

    targetFlow string

    The target flow to transition to. Format: projects//locations//agents//flows/.

    targetPage string

    The target page to transition to. Format: projects//locations//agents//flows//pages/.

    triggerFulfillment GoogleCloudDialogflowCxV3beta1FulfillmentResponse

    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.

    event str

    The name of the event to handle.

    name str

    The unique identifier of this event handler.

    target_flow str

    The target flow to transition to. Format: projects//locations//agents//flows/.

    target_page str

    The target page to transition to. Format: projects//locations//agents//flows//pages/.

    trigger_fulfillment GoogleCloudDialogflowCxV3beta1FulfillmentResponse

    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.

    event String

    The name of the event to handle.

    name String

    The unique identifier of this event handler.

    targetFlow String

    The target flow to transition to. Format: projects//locations//agents//flows/.

    targetPage String

    The target page to transition to. Format: projects//locations//agents//flows//pages/.

    triggerFulfillment Property Map

    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.

    GoogleCloudDialogflowCxV3beta1FormParameterFillBehaviorResponse

    InitialPromptFulfillment Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1FulfillmentResponse

    The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.

    RepromptEventHandlers List<Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1EventHandlerResponse>

    The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.

    InitialPromptFulfillment GoogleCloudDialogflowCxV3beta1FulfillmentResponse

    The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.

    RepromptEventHandlers []GoogleCloudDialogflowCxV3beta1EventHandlerResponse

    The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.

    initialPromptFulfillment GoogleCloudDialogflowCxV3beta1FulfillmentResponse

    The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.

    repromptEventHandlers List<GoogleCloudDialogflowCxV3beta1EventHandlerResponse>

    The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.

    initialPromptFulfillment GoogleCloudDialogflowCxV3beta1FulfillmentResponse

    The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.

    repromptEventHandlers GoogleCloudDialogflowCxV3beta1EventHandlerResponse[]

    The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.

    initial_prompt_fulfillment GoogleCloudDialogflowCxV3beta1FulfillmentResponse

    The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.

    reprompt_event_handlers Sequence[GoogleCloudDialogflowCxV3beta1EventHandlerResponse]

    The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.

    initialPromptFulfillment Property Map

    The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.

    repromptEventHandlers List<Property Map>

    The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.

    GoogleCloudDialogflowCxV3beta1FormParameterResponse

    DefaultValue object

    The default value of an optional parameter. If the parameter is required, the default value will be ignored.

    DisplayName string

    The human-readable name of the parameter, unique within the form.

    EntityType string

    The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.

    FillBehavior Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1FormParameterFillBehaviorResponse

    Defines fill behavior for the parameter.

    IsList bool

    Indicates whether the parameter represents a list of values.

    Redact bool

    Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.

    Required bool

    Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.

    DefaultValue interface{}

    The default value of an optional parameter. If the parameter is required, the default value will be ignored.

    DisplayName string

    The human-readable name of the parameter, unique within the form.

    EntityType string

    The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.

    FillBehavior GoogleCloudDialogflowCxV3beta1FormParameterFillBehaviorResponse

    Defines fill behavior for the parameter.

    IsList bool

    Indicates whether the parameter represents a list of values.

    Redact bool

    Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.

    Required bool

    Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.

    defaultValue Object

    The default value of an optional parameter. If the parameter is required, the default value will be ignored.

    displayName String

    The human-readable name of the parameter, unique within the form.

    entityType String

    The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.

    fillBehavior GoogleCloudDialogflowCxV3beta1FormParameterFillBehaviorResponse

    Defines fill behavior for the parameter.

    isList Boolean

    Indicates whether the parameter represents a list of values.

    redact Boolean

    Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.

    required Boolean

    Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.

    defaultValue any

    The default value of an optional parameter. If the parameter is required, the default value will be ignored.

    displayName string

    The human-readable name of the parameter, unique within the form.

    entityType string

    The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.

    fillBehavior GoogleCloudDialogflowCxV3beta1FormParameterFillBehaviorResponse

    Defines fill behavior for the parameter.

    isList boolean

    Indicates whether the parameter represents a list of values.

    redact boolean

    Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.

    required boolean

    Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.

    default_value Any

    The default value of an optional parameter. If the parameter is required, the default value will be ignored.

    display_name str

    The human-readable name of the parameter, unique within the form.

    entity_type str

    The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.

    fill_behavior GoogleCloudDialogflowCxV3beta1FormParameterFillBehaviorResponse

    Defines fill behavior for the parameter.

    is_list bool

    Indicates whether the parameter represents a list of values.

    redact bool

    Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.

    required bool

    Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.

    defaultValue Any

    The default value of an optional parameter. If the parameter is required, the default value will be ignored.

    displayName String

    The human-readable name of the parameter, unique within the form.

    entityType String

    The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.

    fillBehavior Property Map

    Defines fill behavior for the parameter.

    isList Boolean

    Indicates whether the parameter represents a list of values.

    redact Boolean

    Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.

    required Boolean

    Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.

    GoogleCloudDialogflowCxV3beta1FormResponse

    parameters List<Property Map>

    Parameters to collect from the user.

    GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContentResponse

    additionalCases Property Map

    Additional cases to be evaluated.

    message Property Map

    Returned message.

    GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseResponse

    CaseContent List<Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContentResponse>

    A list of case content.

    Condition string

    The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the conditions reference.

    CaseContent []GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContentResponse

    A list of case content.

    Condition string

    The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the conditions reference.

    caseContent List<GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContentResponse>

    A list of case content.

    condition String

    The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the conditions reference.

    caseContent GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContentResponse[]

    A list of case content.

    condition string

    The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the conditions reference.

    case_content Sequence[GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContentResponse]

    A list of case content.

    condition str

    The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the conditions reference.

    caseContent List<Property Map>

    A list of case content.

    condition String

    The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the conditions reference.

    GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesResponse

    cases List<Property Map>

    A list of cascading if-else conditions.

    GoogleCloudDialogflowCxV3beta1FulfillmentResponse

    ConditionalCases List<Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesResponse>

    Conditional cases for this fulfillment.

    Messages List<Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1ResponseMessageResponse>

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

    ReturnPartialResponses 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.

    SetParameterActions List<Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterActionResponse>

    Set parameter values before executing the webhook.

    Tag string

    The value of this field will be populated in the WebhookRequest fulfillmentInfo.tag field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if webhook is specified.

    Webhook string

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

    ConditionalCases []GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesResponse

    Conditional cases for this fulfillment.

    Messages []GoogleCloudDialogflowCxV3beta1ResponseMessageResponse

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

    ReturnPartialResponses 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.

    SetParameterActions []GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterActionResponse

    Set parameter values before executing the webhook.

    Tag string

    The value of this field will be populated in the WebhookRequest fulfillmentInfo.tag field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if webhook is specified.

    Webhook string

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

    conditionalCases List<GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesResponse>

    Conditional cases for this fulfillment.

    messages List<GoogleCloudDialogflowCxV3beta1ResponseMessageResponse>

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

    returnPartialResponses Boolean

    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.

    setParameterActions List<GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterActionResponse>

    Set parameter values before executing the webhook.

    tag String

    The value of this field will be populated in the WebhookRequest fulfillmentInfo.tag field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if webhook is specified.

    webhook String

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

    conditionalCases GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesResponse[]

    Conditional cases for this fulfillment.

    messages GoogleCloudDialogflowCxV3beta1ResponseMessageResponse[]

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

    returnPartialResponses boolean

    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.

    setParameterActions GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterActionResponse[]

    Set parameter values before executing the webhook.

    tag string

    The value of this field will be populated in the WebhookRequest fulfillmentInfo.tag field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if webhook is specified.

    webhook string

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

    conditional_cases Sequence[GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesResponse]

    Conditional cases for this fulfillment.

    messages Sequence[GoogleCloudDialogflowCxV3beta1ResponseMessageResponse]

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

    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.

    set_parameter_actions Sequence[GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterActionResponse]

    Set parameter values before executing the webhook.

    tag str

    The value of this field will be populated in the WebhookRequest fulfillmentInfo.tag field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if webhook is specified.

    webhook str

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

    conditionalCases List<Property Map>

    Conditional cases for this fulfillment.

    messages List<Property Map>

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

    returnPartialResponses Boolean

    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.

    setParameterActions List<Property Map>

    Set parameter values before executing the webhook.

    tag String

    The value of this field will be populated in the WebhookRequest fulfillmentInfo.tag field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if webhook is specified.

    webhook String

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

    GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterActionResponse

    Parameter string

    Display name of the parameter.

    Value object

    The new value of the parameter. A null value clears the parameter.

    Parameter string

    Display name of the parameter.

    Value interface{}

    The new value of the parameter. A null value clears the parameter.

    parameter String

    Display name of the parameter.

    value Object

    The new value of the parameter. A null value clears the parameter.

    parameter string

    Display name of the parameter.

    value any

    The new value of the parameter. A null value clears the parameter.

    parameter str

    Display name of the parameter.

    value Any

    The new value of the parameter. A null value clears the parameter.

    parameter String

    Display name of the parameter.

    value Any

    The new value of the parameter. A null value clears the parameter.

    GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccessResponse

    Metadata Dictionary<string, string>

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

    Metadata map[string]string

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

    metadata Map<String,String>

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

    metadata {[key: string]: string}

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

    metadata Mapping[str, str]

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

    metadata Map<String>

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

    GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoffResponse

    Metadata Dictionary<string, string>

    Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.

    Metadata map[string]string

    Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.

    metadata Map<String,String>

    Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.

    metadata {[key: string]: string}

    Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.

    metadata Mapping[str, str]

    Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.

    metadata Map<String>

    Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.

    GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioResponse

    segments List<Property Map>

    Segments this audio response is composed of.

    GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegmentResponse

    AllowPlaybackInterruption bool

    Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.

    Audio string

    Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.

    Uri string

    Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.

    AllowPlaybackInterruption bool

    Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.

    Audio string

    Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.

    Uri string

    Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.

    allowPlaybackInterruption Boolean

    Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.

    audio String

    Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.

    uri String

    Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.

    allowPlaybackInterruption boolean

    Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.

    audio string

    Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.

    uri string

    Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.

    allow_playback_interruption bool

    Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.

    audio str

    Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.

    uri str

    Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.

    allowPlaybackInterruption Boolean

    Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.

    audio String

    Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.

    uri String

    Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.

    GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioTextResponse

    AllowPlaybackInterruption bool

    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.

    Ssml string

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

    Text string

    The raw text to be synthesized.

    AllowPlaybackInterruption bool

    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.

    Ssml string

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

    Text string

    The raw text to be synthesized.

    allowPlaybackInterruption Boolean

    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.

    ssml String

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

    text String

    The raw text to be synthesized.

    allowPlaybackInterruption boolean

    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.

    ssml string

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

    text string

    The raw text to be synthesized.

    allow_playback_interruption bool

    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.

    ssml str

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

    text str

    The raw text to be synthesized.

    allowPlaybackInterruption Boolean

    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.

    ssml String

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

    text String

    The raw text to be synthesized.

    GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudioResponse

    AllowPlaybackInterruption bool

    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.

    AudioUri string

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

    AllowPlaybackInterruption bool

    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.

    AudioUri string

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

    allowPlaybackInterruption Boolean

    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.

    audioUri String

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

    allowPlaybackInterruption boolean

    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.

    audioUri string

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

    allow_playback_interruption bool

    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.

    audio_uri str

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

    allowPlaybackInterruption Boolean

    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.

    audioUri String

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

    GoogleCloudDialogflowCxV3beta1ResponseMessageResponse

    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.

    ConversationSuccess Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccessResponse

    Indicates that the conversation succeeded.

    EndInteraction Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteractionResponse

    A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches END_SESSION page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.

    LiveAgentHandoff Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoffResponse

    Hands off conversation to a human agent.

    MixedAudio Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioResponse

    An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.

    OutputAudioText Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioTextResponse

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

    Payload Dictionary<string, string>

    Returns a response containing a custom, platform-specific payload.

    PlayAudio Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudioResponse

    Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.

    TelephonyTransferCall Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCallResponse

    A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.

    Text Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1ResponseMessageTextResponse

    Returns a text response.

    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.

    ConversationSuccess GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccessResponse

    Indicates that the conversation succeeded.

    EndInteraction GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteractionResponse

    A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches END_SESSION page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.

    LiveAgentHandoff GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoffResponse

    Hands off conversation to a human agent.

    MixedAudio GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioResponse

    An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.

    OutputAudioText GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioTextResponse

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

    Payload map[string]string

    Returns a response containing a custom, platform-specific payload.

    PlayAudio GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudioResponse

    Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.

    TelephonyTransferCall GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCallResponse

    A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.

    Text GoogleCloudDialogflowCxV3beta1ResponseMessageTextResponse

    Returns a text response.

    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.

    conversationSuccess GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccessResponse

    Indicates that the conversation succeeded.

    endInteraction GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteractionResponse

    A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches END_SESSION page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.

    liveAgentHandoff GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoffResponse

    Hands off conversation to a human agent.

    mixedAudio GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioResponse

    An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.

    outputAudioText GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioTextResponse

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

    payload Map<String,String>

    Returns a response containing a custom, platform-specific payload.

    playAudio GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudioResponse

    Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.

    telephonyTransferCall GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCallResponse

    A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.

    text GoogleCloudDialogflowCxV3beta1ResponseMessageTextResponse

    Returns a text response.

    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.

    conversationSuccess GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccessResponse

    Indicates that the conversation succeeded.

    endInteraction GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteractionResponse

    A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches END_SESSION page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.

    liveAgentHandoff GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoffResponse

    Hands off conversation to a human agent.

    mixedAudio GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioResponse

    An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.

    outputAudioText GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioTextResponse

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

    payload {[key: string]: string}

    Returns a response containing a custom, platform-specific payload.

    playAudio GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudioResponse

    Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.

    telephonyTransferCall GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCallResponse

    A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.

    text GoogleCloudDialogflowCxV3beta1ResponseMessageTextResponse

    Returns a text response.

    channel str

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

    conversation_success GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccessResponse

    Indicates that the conversation succeeded.

    end_interaction GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteractionResponse

    A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches END_SESSION page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.

    live_agent_handoff GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoffResponse

    Hands off conversation to a human agent.

    mixed_audio GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioResponse

    An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.

    output_audio_text GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioTextResponse

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

    payload Mapping[str, str]

    Returns a response containing a custom, platform-specific payload.

    play_audio GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudioResponse

    Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.

    telephony_transfer_call GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCallResponse

    A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.

    text GoogleCloudDialogflowCxV3beta1ResponseMessageTextResponse

    Returns a text response.

    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.

    conversationSuccess Property Map

    Indicates that the conversation succeeded.

    endInteraction Property Map

    A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches END_SESSION page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.

    liveAgentHandoff Property Map

    Hands off conversation to a human agent.

    mixedAudio Property Map

    An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.

    outputAudioText Property Map

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

    payload Map<String>

    Returns a response containing a custom, platform-specific payload.

    playAudio Property Map

    Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.

    telephonyTransferCall Property Map

    A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.

    text Property Map

    Returns a text response.

    GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCallResponse

    PhoneNumber string

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

    PhoneNumber string

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

    phoneNumber String

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

    phoneNumber string

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

    phone_number str

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

    phoneNumber String

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

    GoogleCloudDialogflowCxV3beta1ResponseMessageTextResponse

    AllowPlaybackInterruption bool

    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.

    Text List<string>

    A collection of text responses.

    AllowPlaybackInterruption bool

    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.

    Text []string

    A collection of text responses.

    allowPlaybackInterruption Boolean

    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.

    text List<String>

    A collection of text responses.

    allowPlaybackInterruption boolean

    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.

    text string[]

    A collection of text responses.

    allow_playback_interruption bool

    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.

    text Sequence[str]

    A collection of text responses.

    allowPlaybackInterruption Boolean

    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.

    text List<String>

    A collection of text responses.

    GoogleCloudDialogflowCxV3beta1TransitionRouteResponse

    Condition string

    The condition to evaluate against form parameters or session parameters. See the conditions reference. 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.

    Intent string

    The unique identifier of an Intent. Format: 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.

    Name string

    The unique identifier of this transition route.

    TargetFlow string

    The target flow to transition to. Format: projects//locations//agents//flows/.

    TargetPage string

    The target page to transition to. Format: projects//locations//agents//flows//pages/.

    TriggerFulfillment Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1FulfillmentResponse

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

    Condition string

    The condition to evaluate against form parameters or session parameters. See the conditions reference. 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.

    Intent string

    The unique identifier of an Intent. Format: 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.

    Name string

    The unique identifier of this transition route.

    TargetFlow string

    The target flow to transition to. Format: projects//locations//agents//flows/.

    TargetPage string

    The target page to transition to. Format: projects//locations//agents//flows//pages/.

    TriggerFulfillment GoogleCloudDialogflowCxV3beta1FulfillmentResponse

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

    condition String

    The condition to evaluate against form parameters or session parameters. See the conditions reference. 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.

    intent String

    The unique identifier of an Intent. Format: 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.

    name String

    The unique identifier of this transition route.

    targetFlow String

    The target flow to transition to. Format: projects//locations//agents//flows/.

    targetPage String

    The target page to transition to. Format: projects//locations//agents//flows//pages/.

    triggerFulfillment GoogleCloudDialogflowCxV3beta1FulfillmentResponse

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

    condition string

    The condition to evaluate against form parameters or session parameters. See the conditions reference. 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.

    intent string

    The unique identifier of an Intent. Format: 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.

    name string

    The unique identifier of this transition route.

    targetFlow string

    The target flow to transition to. Format: projects//locations//agents//flows/.

    targetPage string

    The target page to transition to. Format: projects//locations//agents//flows//pages/.

    triggerFulfillment GoogleCloudDialogflowCxV3beta1FulfillmentResponse

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

    condition str

    The condition to evaluate against form parameters or session parameters. See the conditions reference. 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.

    intent str

    The unique identifier of an Intent. Format: 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.

    name str

    The unique identifier of this transition route.

    target_flow str

    The target flow to transition to. Format: projects//locations//agents//flows/.

    target_page str

    The target page to transition to. Format: projects//locations//agents//flows//pages/.

    trigger_fulfillment GoogleCloudDialogflowCxV3beta1FulfillmentResponse

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

    condition String

    The condition to evaluate against form parameters or session parameters. See the conditions reference. 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.

    intent String

    The unique identifier of an Intent. Format: 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.

    name String

    The unique identifier of this transition route.

    targetFlow String

    The target flow to transition to. Format: projects//locations//agents//flows/.

    targetPage String

    The target page to transition to. Format: projects//locations//agents//flows//pages/.

    triggerFulfillment Property Map

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

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi