Docs Packages
  1. Pulumi Registry
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. diagflow
  5. CxFlow
gcp logo
Google Cloud Classic v6.56.0, May 18 23

gcp.diagflow.CxFlow

Explore with Pulumi AI

Flows represents the conversation flows when you build your chatbot agent.

To get more information about Flow, see:

Example Usage

Dialogflowcx Flow Full

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var agent = new Gcp.Diagflow.CxAgent("agent", new()
    {
        DisplayName = "dialogflowcx-agent",
        Location = "global",
        DefaultLanguageCode = "en",
        SupportedLanguageCodes = new[]
        {
            "fr",
            "de",
            "es",
        },
        TimeZone = "America/New_York",
        Description = "Example description.",
        AvatarUri = "https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
        EnableStackdriverLogging = true,
        EnableSpellCorrection = true,
        SpeechToTextSettings = new Gcp.Diagflow.Inputs.CxAgentSpeechToTextSettingsArgs
        {
            EnableSpeechAdaptation = true,
        },
    });

    var basicFlow = new Gcp.Diagflow.CxFlow("basicFlow", new()
    {
        Parent = agent.Id,
        DisplayName = "MyFlow",
        Description = "Test Flow",
        NluSettings = new Gcp.Diagflow.Inputs.CxFlowNluSettingsArgs
        {
            ClassificationThreshold = 0.3,
            ModelType = "MODEL_TYPE_STANDARD",
        },
        EventHandlers = new[]
        {
            new Gcp.Diagflow.Inputs.CxFlowEventHandlerArgs
            {
                Event = "custom-event",
                TriggerFulfillment = new Gcp.Diagflow.Inputs.CxFlowEventHandlerTriggerFulfillmentArgs
                {
                    ReturnPartialResponses = false,
                    Messages = new[]
                    {
                        new Gcp.Diagflow.Inputs.CxFlowEventHandlerTriggerFulfillmentMessageArgs
                        {
                            Text = new Gcp.Diagflow.Inputs.CxFlowEventHandlerTriggerFulfillmentMessageTextArgs
                            {
                                Texts = new[]
                                {
                                    "I didn't get that. Can you say it again?",
                                },
                            },
                        },
                    },
                },
            },
            new Gcp.Diagflow.Inputs.CxFlowEventHandlerArgs
            {
                Event = "sys.no-match-default",
                TriggerFulfillment = new Gcp.Diagflow.Inputs.CxFlowEventHandlerTriggerFulfillmentArgs
                {
                    ReturnPartialResponses = false,
                    Messages = new[]
                    {
                        new Gcp.Diagflow.Inputs.CxFlowEventHandlerTriggerFulfillmentMessageArgs
                        {
                            Text = new Gcp.Diagflow.Inputs.CxFlowEventHandlerTriggerFulfillmentMessageTextArgs
                            {
                                Texts = new[]
                                {
                                    "Sorry, could you say that again?",
                                },
                            },
                        },
                    },
                },
            },
            new Gcp.Diagflow.Inputs.CxFlowEventHandlerArgs
            {
                Event = "sys.no-input-default",
                TriggerFulfillment = new Gcp.Diagflow.Inputs.CxFlowEventHandlerTriggerFulfillmentArgs
                {
                    ReturnPartialResponses = false,
                    Messages = new[]
                    {
                        new Gcp.Diagflow.Inputs.CxFlowEventHandlerTriggerFulfillmentMessageArgs
                        {
                            Text = new Gcp.Diagflow.Inputs.CxFlowEventHandlerTriggerFulfillmentMessageTextArgs
                            {
                                Texts = new[]
                                {
                                    "One more time?",
                                },
                            },
                        },
                    },
                },
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/diagflow"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		agent, err := diagflow.NewCxAgent(ctx, "agent", &diagflow.CxAgentArgs{
			DisplayName:         pulumi.String("dialogflowcx-agent"),
			Location:            pulumi.String("global"),
			DefaultLanguageCode: pulumi.String("en"),
			SupportedLanguageCodes: pulumi.StringArray{
				pulumi.String("fr"),
				pulumi.String("de"),
				pulumi.String("es"),
			},
			TimeZone:                 pulumi.String("America/New_York"),
			Description:              pulumi.String("Example description."),
			AvatarUri:                pulumi.String("https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png"),
			EnableStackdriverLogging: pulumi.Bool(true),
			EnableSpellCorrection:    pulumi.Bool(true),
			SpeechToTextSettings: &diagflow.CxAgentSpeechToTextSettingsArgs{
				EnableSpeechAdaptation: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		_, err = diagflow.NewCxFlow(ctx, "basicFlow", &diagflow.CxFlowArgs{
			Parent:      agent.ID(),
			DisplayName: pulumi.String("MyFlow"),
			Description: pulumi.String("Test Flow"),
			NluSettings: &diagflow.CxFlowNluSettingsArgs{
				ClassificationThreshold: pulumi.Float64(0.3),
				ModelType:               pulumi.String("MODEL_TYPE_STANDARD"),
			},
			EventHandlers: diagflow.CxFlowEventHandlerArray{
				&diagflow.CxFlowEventHandlerArgs{
					Event: pulumi.String("custom-event"),
					TriggerFulfillment: &diagflow.CxFlowEventHandlerTriggerFulfillmentArgs{
						ReturnPartialResponses: pulumi.Bool(false),
						Messages: diagflow.CxFlowEventHandlerTriggerFulfillmentMessageArray{
							&diagflow.CxFlowEventHandlerTriggerFulfillmentMessageArgs{
								Text: &diagflow.CxFlowEventHandlerTriggerFulfillmentMessageTextArgs{
									Texts: pulumi.StringArray{
										pulumi.String("I didn't get that. Can you say it again?"),
									},
								},
							},
						},
					},
				},
				&diagflow.CxFlowEventHandlerArgs{
					Event: pulumi.String("sys.no-match-default"),
					TriggerFulfillment: &diagflow.CxFlowEventHandlerTriggerFulfillmentArgs{
						ReturnPartialResponses: pulumi.Bool(false),
						Messages: diagflow.CxFlowEventHandlerTriggerFulfillmentMessageArray{
							&diagflow.CxFlowEventHandlerTriggerFulfillmentMessageArgs{
								Text: &diagflow.CxFlowEventHandlerTriggerFulfillmentMessageTextArgs{
									Texts: pulumi.StringArray{
										pulumi.String("Sorry, could you say that again?"),
									},
								},
							},
						},
					},
				},
				&diagflow.CxFlowEventHandlerArgs{
					Event: pulumi.String("sys.no-input-default"),
					TriggerFulfillment: &diagflow.CxFlowEventHandlerTriggerFulfillmentArgs{
						ReturnPartialResponses: pulumi.Bool(false),
						Messages: diagflow.CxFlowEventHandlerTriggerFulfillmentMessageArray{
							&diagflow.CxFlowEventHandlerTriggerFulfillmentMessageArgs{
								Text: &diagflow.CxFlowEventHandlerTriggerFulfillmentMessageTextArgs{
									Texts: pulumi.StringArray{
										pulumi.String("One more time?"),
									},
								},
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.diagflow.CxAgent;
import com.pulumi.gcp.diagflow.CxAgentArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentSpeechToTextSettingsArgs;
import com.pulumi.gcp.diagflow.CxFlow;
import com.pulumi.gcp.diagflow.CxFlowArgs;
import com.pulumi.gcp.diagflow.inputs.CxFlowNluSettingsArgs;
import com.pulumi.gcp.diagflow.inputs.CxFlowEventHandlerArgs;
import com.pulumi.gcp.diagflow.inputs.CxFlowEventHandlerTriggerFulfillmentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var agent = new CxAgent("agent", CxAgentArgs.builder()        
            .displayName("dialogflowcx-agent")
            .location("global")
            .defaultLanguageCode("en")
            .supportedLanguageCodes(            
                "fr",
                "de",
                "es")
            .timeZone("America/New_York")
            .description("Example description.")
            .avatarUri("https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png")
            .enableStackdriverLogging(true)
            .enableSpellCorrection(true)
            .speechToTextSettings(CxAgentSpeechToTextSettingsArgs.builder()
                .enableSpeechAdaptation(true)
                .build())
            .build());

        var basicFlow = new CxFlow("basicFlow", CxFlowArgs.builder()        
            .parent(agent.id())
            .displayName("MyFlow")
            .description("Test Flow")
            .nluSettings(CxFlowNluSettingsArgs.builder()
                .classificationThreshold(0.3)
                .modelType("MODEL_TYPE_STANDARD")
                .build())
            .eventHandlers(            
                CxFlowEventHandlerArgs.builder()
                    .event("custom-event")
                    .triggerFulfillment(CxFlowEventHandlerTriggerFulfillmentArgs.builder()
                        .returnPartialResponses(false)
                        .messages(CxFlowEventHandlerTriggerFulfillmentMessageArgs.builder()
                            .text(CxFlowEventHandlerTriggerFulfillmentMessageTextArgs.builder()
                                .texts("I didn't get that. Can you say it again?")
                                .build())
                            .build())
                        .build())
                    .build(),
                CxFlowEventHandlerArgs.builder()
                    .event("sys.no-match-default")
                    .triggerFulfillment(CxFlowEventHandlerTriggerFulfillmentArgs.builder()
                        .returnPartialResponses(false)
                        .messages(CxFlowEventHandlerTriggerFulfillmentMessageArgs.builder()
                            .text(CxFlowEventHandlerTriggerFulfillmentMessageTextArgs.builder()
                                .texts("Sorry, could you say that again?")
                                .build())
                            .build())
                        .build())
                    .build(),
                CxFlowEventHandlerArgs.builder()
                    .event("sys.no-input-default")
                    .triggerFulfillment(CxFlowEventHandlerTriggerFulfillmentArgs.builder()
                        .returnPartialResponses(false)
                        .messages(CxFlowEventHandlerTriggerFulfillmentMessageArgs.builder()
                            .text(CxFlowEventHandlerTriggerFulfillmentMessageTextArgs.builder()
                                .texts("One more time?")
                                .build())
                            .build())
                        .build())
                    .build())
            .build());

    }
}

import pulumi
import pulumi_gcp as gcp

agent = gcp.diagflow.CxAgent("agent",
    display_name="dialogflowcx-agent",
    location="global",
    default_language_code="en",
    supported_language_codes=[
        "fr",
        "de",
        "es",
    ],
    time_zone="America/New_York",
    description="Example description.",
    avatar_uri="https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
    enable_stackdriver_logging=True,
    enable_spell_correction=True,
    speech_to_text_settings=gcp.diagflow.CxAgentSpeechToTextSettingsArgs(
        enable_speech_adaptation=True,
    ))
basic_flow = gcp.diagflow.CxFlow("basicFlow",
    parent=agent.id,
    display_name="MyFlow",
    description="Test Flow",
    nlu_settings=gcp.diagflow.CxFlowNluSettingsArgs(
        classification_threshold=0.3,
        model_type="MODEL_TYPE_STANDARD",
    ),
    event_handlers=[
        gcp.diagflow.CxFlowEventHandlerArgs(
            event="custom-event",
            trigger_fulfillment=gcp.diagflow.CxFlowEventHandlerTriggerFulfillmentArgs(
                return_partial_responses=False,
                messages=[gcp.diagflow.CxFlowEventHandlerTriggerFulfillmentMessageArgs(
                    text=gcp.diagflow.CxFlowEventHandlerTriggerFulfillmentMessageTextArgs(
                        texts=["I didn't get that. Can you say it again?"],
                    ),
                )],
            ),
        ),
        gcp.diagflow.CxFlowEventHandlerArgs(
            event="sys.no-match-default",
            trigger_fulfillment=gcp.diagflow.CxFlowEventHandlerTriggerFulfillmentArgs(
                return_partial_responses=False,
                messages=[gcp.diagflow.CxFlowEventHandlerTriggerFulfillmentMessageArgs(
                    text=gcp.diagflow.CxFlowEventHandlerTriggerFulfillmentMessageTextArgs(
                        texts=["Sorry, could you say that again?"],
                    ),
                )],
            ),
        ),
        gcp.diagflow.CxFlowEventHandlerArgs(
            event="sys.no-input-default",
            trigger_fulfillment=gcp.diagflow.CxFlowEventHandlerTriggerFulfillmentArgs(
                return_partial_responses=False,
                messages=[gcp.diagflow.CxFlowEventHandlerTriggerFulfillmentMessageArgs(
                    text=gcp.diagflow.CxFlowEventHandlerTriggerFulfillmentMessageTextArgs(
                        texts=["One more time?"],
                    ),
                )],
            ),
        ),
    ])

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const agent = new gcp.diagflow.CxAgent("agent", {
    displayName: "dialogflowcx-agent",
    location: "global",
    defaultLanguageCode: "en",
    supportedLanguageCodes: [
        "fr",
        "de",
        "es",
    ],
    timeZone: "America/New_York",
    description: "Example description.",
    avatarUri: "https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
    enableStackdriverLogging: true,
    enableSpellCorrection: true,
    speechToTextSettings: {
        enableSpeechAdaptation: true,
    },
});
const basicFlow = new gcp.diagflow.CxFlow("basicFlow", {
    parent: agent.id,
    displayName: "MyFlow",
    description: "Test Flow",
    nluSettings: {
        classificationThreshold: 0.3,
        modelType: "MODEL_TYPE_STANDARD",
    },
    eventHandlers: [
        {
            event: "custom-event",
            triggerFulfillment: {
                returnPartialResponses: false,
                messages: [{
                    text: {
                        texts: ["I didn't get that. Can you say it again?"],
                    },
                }],
            },
        },
        {
            event: "sys.no-match-default",
            triggerFulfillment: {
                returnPartialResponses: false,
                messages: [{
                    text: {
                        texts: ["Sorry, could you say that again?"],
                    },
                }],
            },
        },
        {
            event: "sys.no-input-default",
            triggerFulfillment: {
                returnPartialResponses: false,
                messages: [{
                    text: {
                        texts: ["One more time?"],
                    },
                }],
            },
        },
    ],
});

resources:
  agent:
    type: gcp:diagflow:CxAgent
    properties:
      displayName: dialogflowcx-agent
      location: global
      defaultLanguageCode: en
      supportedLanguageCodes:
        - fr
        - de
        - es
      timeZone: America/New_York
      description: Example description.
      avatarUri: https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png
      enableStackdriverLogging: true
      enableSpellCorrection: true
      speechToTextSettings:
        enableSpeechAdaptation: true
  basicFlow:
    type: gcp:diagflow:CxFlow
    properties:
      parent: ${agent.id}
      displayName: MyFlow
      description: Test Flow
      nluSettings:
        classificationThreshold: 0.3
        modelType: MODEL_TYPE_STANDARD
      eventHandlers:
        - event: custom-event
          triggerFulfillment:
            returnPartialResponses: false
            messages:
              - text:
                  texts:
                    - I didn't get that. Can you say it again?
        - event: sys.no-match-default
          triggerFulfillment:
            returnPartialResponses: false
            messages:
              - text:
                  texts:
                    - Sorry, could you say that again?
        - event: sys.no-input-default
          triggerFulfillment:
            returnPartialResponses: false
            messages:
              - text:
                  texts:
                    - One more time?

Create CxFlow Resource

new CxFlow(name: string, args: CxFlowArgs, opts?: CustomResourceOptions);
@overload
def CxFlow(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           description: Optional[str] = None,
           display_name: Optional[str] = None,
           event_handlers: Optional[Sequence[CxFlowEventHandlerArgs]] = None,
           language_code: Optional[str] = None,
           nlu_settings: Optional[CxFlowNluSettingsArgs] = None,
           parent: Optional[str] = None,
           transition_route_groups: Optional[Sequence[str]] = None,
           transition_routes: Optional[Sequence[CxFlowTransitionRouteArgs]] = None)
@overload
def CxFlow(resource_name: str,
           args: CxFlowArgs,
           opts: Optional[ResourceOptions] = None)
func NewCxFlow(ctx *Context, name string, args CxFlowArgs, opts ...ResourceOption) (*CxFlow, error)
public CxFlow(string name, CxFlowArgs args, CustomResourceOptions? opts = null)
public CxFlow(String name, CxFlowArgs args)
public CxFlow(String name, CxFlowArgs args, CustomResourceOptions options)

type: gcp:diagflow:CxFlow
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CxFlowArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args CxFlowArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args CxFlowArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CxFlowArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args CxFlowArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

CxFlow Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The CxFlow resource accepts the following input properties:

DisplayName string

The human-readable name of the flow.

Description string

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

EventHandlers List<CxFlowEventHandlerArgs>

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

LanguageCode string

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

NluSettings CxFlowNluSettingsArgs

NLU related settings of the flow. Structure is documented below.

Parent string

The agent to create a flow for. Format: projects//locations//agents/.

TransitionRouteGroups List<string>

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

TransitionRoutes List<CxFlowTransitionRouteArgs>

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

DisplayName string

The human-readable name of the flow.

Description string

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

EventHandlers []CxFlowEventHandlerArgs

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

LanguageCode string

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

NluSettings CxFlowNluSettingsArgs

NLU related settings of the flow. Structure is documented below.

Parent string

The agent to create a flow for. Format: projects//locations//agents/.

TransitionRouteGroups []string

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

TransitionRoutes []CxFlowTransitionRouteArgs

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

displayName String

The human-readable name of the flow.

description String

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

eventHandlers List<CxFlowEventHandlerArgs>

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

languageCode String

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

nluSettings CxFlowNluSettingsArgs

NLU related settings of the flow. Structure is documented below.

parent String

The agent to create a flow for. Format: projects//locations//agents/.

transitionRouteGroups List<String>

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

transitionRoutes List<CxFlowTransitionRouteArgs>

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

displayName string

The human-readable name of the flow.

description string

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

eventHandlers CxFlowEventHandlerArgs[]

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

languageCode string

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

nluSettings CxFlowNluSettingsArgs

NLU related settings of the flow. Structure is documented below.

parent string

The agent to create a flow for. Format: projects//locations//agents/.

transitionRouteGroups string[]

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

transitionRoutes CxFlowTransitionRouteArgs[]

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

display_name str

The human-readable name of the flow.

description str

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

event_handlers Sequence[CxFlowEventHandlerArgs]

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

language_code str

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

nlu_settings CxFlowNluSettingsArgs

NLU related settings of the flow. Structure is documented below.

parent str

The agent to create a flow for. Format: projects//locations//agents/.

transition_route_groups Sequence[str]

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

transition_routes Sequence[CxFlowTransitionRouteArgs]

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

displayName String

The human-readable name of the flow.

description String

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

eventHandlers List<Property Map>

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

languageCode String

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

nluSettings Property Map

NLU related settings of the flow. Structure is documented below.

parent String

The agent to create a flow for. Format: projects//locations//agents/.

transitionRouteGroups List<String>

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

transitionRoutes List<Property Map>

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

Outputs

All input properties are implicitly available as output properties. Additionally, the CxFlow resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Name string

(Output) The unique identifier of this transition route. (Output) The unique identifier of this event handler.

Id string

The provider-assigned unique ID for this managed resource.

Name string

(Output) The unique identifier of this transition route. (Output) The unique identifier of this event handler.

id String

The provider-assigned unique ID for this managed resource.

name String

(Output) The unique identifier of this transition route. (Output) The unique identifier of this event handler.

id string

The provider-assigned unique ID for this managed resource.

name string

(Output) The unique identifier of this transition route. (Output) The unique identifier of this event handler.

id str

The provider-assigned unique ID for this managed resource.

name str

(Output) The unique identifier of this transition route. (Output) The unique identifier of this event handler.

id String

The provider-assigned unique ID for this managed resource.

name String

(Output) The unique identifier of this transition route. (Output) The unique identifier of this event handler.

Look up Existing CxFlow Resource

Get an existing CxFlow resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: CxFlowState, opts?: CustomResourceOptions): CxFlow
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        event_handlers: Optional[Sequence[CxFlowEventHandlerArgs]] = None,
        language_code: Optional[str] = None,
        name: Optional[str] = None,
        nlu_settings: Optional[CxFlowNluSettingsArgs] = None,
        parent: Optional[str] = None,
        transition_route_groups: Optional[Sequence[str]] = None,
        transition_routes: Optional[Sequence[CxFlowTransitionRouteArgs]] = None) -> CxFlow
func GetCxFlow(ctx *Context, name string, id IDInput, state *CxFlowState, opts ...ResourceOption) (*CxFlow, error)
public static CxFlow Get(string name, Input<string> id, CxFlowState? state, CustomResourceOptions? opts = null)
public static CxFlow get(String name, Output<String> id, CxFlowState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Description string

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

DisplayName string

The human-readable name of the flow.

EventHandlers List<CxFlowEventHandlerArgs>

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

LanguageCode string

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

Name string

(Output) The unique identifier of this transition route. (Output) The unique identifier of this event handler.

NluSettings CxFlowNluSettingsArgs

NLU related settings of the flow. Structure is documented below.

Parent string

The agent to create a flow for. Format: projects//locations//agents/.

TransitionRouteGroups List<string>

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

TransitionRoutes List<CxFlowTransitionRouteArgs>

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

Description string

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

DisplayName string

The human-readable name of the flow.

EventHandlers []CxFlowEventHandlerArgs

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

LanguageCode string

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

Name string

(Output) The unique identifier of this transition route. (Output) The unique identifier of this event handler.

NluSettings CxFlowNluSettingsArgs

NLU related settings of the flow. Structure is documented below.

Parent string

The agent to create a flow for. Format: projects//locations//agents/.

TransitionRouteGroups []string

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

TransitionRoutes []CxFlowTransitionRouteArgs

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

description String

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

displayName String

The human-readable name of the flow.

eventHandlers List<CxFlowEventHandlerArgs>

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

languageCode String

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

name String

(Output) The unique identifier of this transition route. (Output) The unique identifier of this event handler.

nluSettings CxFlowNluSettingsArgs

NLU related settings of the flow. Structure is documented below.

parent String

The agent to create a flow for. Format: projects//locations//agents/.

transitionRouteGroups List<String>

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

transitionRoutes List<CxFlowTransitionRouteArgs>

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

description string

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

displayName string

The human-readable name of the flow.

eventHandlers CxFlowEventHandlerArgs[]

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

languageCode string

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

name string

(Output) The unique identifier of this transition route. (Output) The unique identifier of this event handler.

nluSettings CxFlowNluSettingsArgs

NLU related settings of the flow. Structure is documented below.

parent string

The agent to create a flow for. Format: projects//locations//agents/.

transitionRouteGroups string[]

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

transitionRoutes CxFlowTransitionRouteArgs[]

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

description str

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

display_name str

The human-readable name of the flow.

event_handlers Sequence[CxFlowEventHandlerArgs]

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

language_code str

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

name str

(Output) The unique identifier of this transition route. (Output) The unique identifier of this event handler.

nlu_settings CxFlowNluSettingsArgs

NLU related settings of the flow. Structure is documented below.

parent str

The agent to create a flow for. Format: projects//locations//agents/.

transition_route_groups Sequence[str]

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

transition_routes Sequence[CxFlowTransitionRouteArgs]

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

description String

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

displayName String

The human-readable name of the flow.

eventHandlers List<Property Map>

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

languageCode String

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

name String

(Output) The unique identifier of this transition route. (Output) The unique identifier of this event handler.

nluSettings Property Map

NLU related settings of the flow. Structure is documented below.

parent String

The agent to create a flow for. Format: projects//locations//agents/.

transitionRouteGroups List<String>

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

transitionRoutes List<Property Map>

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

Supporting Types

CxFlowEventHandler

Event string

The name of the event to handle.

Name string

(Output) 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 CxFlowEventHandlerTriggerFulfillment

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. Structure is documented below.

Event string

The name of the event to handle.

Name string

(Output) 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 CxFlowEventHandlerTriggerFulfillment

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. Structure is documented below.

event String

The name of the event to handle.

name String

(Output) 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 CxFlowEventHandlerTriggerFulfillment

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. Structure is documented below.

event string

The name of the event to handle.

name string

(Output) 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 CxFlowEventHandlerTriggerFulfillment

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. Structure is documented below.

event str

The name of the event to handle.

name str

(Output) 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 CxFlowEventHandlerTriggerFulfillment

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. Structure is documented below.

event String

The name of the event to handle.

name String

(Output) 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. Structure is documented below.

CxFlowEventHandlerTriggerFulfillment

Messages List<CxFlowEventHandlerTriggerFulfillmentMessage>

The list of rich message responses to present to the user. Structure is documented below.

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.

Tag string

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

Webhook string

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

Messages []CxFlowEventHandlerTriggerFulfillmentMessage

The list of rich message responses to present to the user. Structure is documented below.

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.

Tag string

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

Webhook string

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

messages List<CxFlowEventHandlerTriggerFulfillmentMessage>

The list of rich message responses to present to the user. Structure is documented below.

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.

tag String

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

webhook String

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

messages CxFlowEventHandlerTriggerFulfillmentMessage[]

The list of rich message responses to present to the user. Structure is documented below.

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.

tag string

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

webhook string

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

messages Sequence[CxFlowEventHandlerTriggerFulfillmentMessage]

The list of rich message responses to present to the user. Structure is documented below.

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.

tag str

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

webhook str

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

messages List<Property Map>

The list of rich message responses to present to the user. Structure is documented below.

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.

tag String

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

webhook String

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

CxFlowEventHandlerTriggerFulfillmentMessage

Text CxFlowEventHandlerTriggerFulfillmentMessageText

The text response message. Structure is documented below.

Text CxFlowEventHandlerTriggerFulfillmentMessageText

The text response message. Structure is documented below.

text CxFlowEventHandlerTriggerFulfillmentMessageText

The text response message. Structure is documented below.

text CxFlowEventHandlerTriggerFulfillmentMessageText

The text response message. Structure is documented below.

text CxFlowEventHandlerTriggerFulfillmentMessageText

The text response message. Structure is documented below.

text Property Map

The text response message. Structure is documented below.

CxFlowEventHandlerTriggerFulfillmentMessageText

AllowPlaybackInterruption bool

(Output) 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.

Texts List<string>

A collection of text responses.

AllowPlaybackInterruption bool

(Output) 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.

Texts []string

A collection of text responses.

allowPlaybackInterruption Boolean

(Output) 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.

texts List<String>

A collection of text responses.

allowPlaybackInterruption boolean

(Output) 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.

texts string[]

A collection of text responses.

allow_playback_interruption bool

(Output) 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.

texts Sequence[str]

A collection of text responses.

allowPlaybackInterruption Boolean

(Output) 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.

texts List<String>

A collection of text responses.

CxFlowNluSettings

ClassificationThreshold double

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

ModelTrainingMode string

Indicates NLU model training mode.

  • MODEL_TRAINING_MODE_AUTOMATIC: NLU model training is automatically triggered when a flow gets modified. User can also manually trigger model training in this mode.
  • MODEL_TRAINING_MODE_MANUAL: User needs to manually trigger NLU model training. Best for large flows whose models take long time to train. Possible values are: MODEL_TRAINING_MODE_AUTOMATIC, MODEL_TRAINING_MODE_MANUAL.
ModelType string

Indicates the type of NLU model.

  • MODEL_TYPE_STANDARD: Use standard NLU model.
  • MODEL_TYPE_ADVANCED: Use advanced NLU model. Possible values are: MODEL_TYPE_STANDARD, MODEL_TYPE_ADVANCED.
ClassificationThreshold float64

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

ModelTrainingMode string

Indicates NLU model training mode.

  • MODEL_TRAINING_MODE_AUTOMATIC: NLU model training is automatically triggered when a flow gets modified. User can also manually trigger model training in this mode.
  • MODEL_TRAINING_MODE_MANUAL: User needs to manually trigger NLU model training. Best for large flows whose models take long time to train. Possible values are: MODEL_TRAINING_MODE_AUTOMATIC, MODEL_TRAINING_MODE_MANUAL.
ModelType string

Indicates the type of NLU model.

  • MODEL_TYPE_STANDARD: Use standard NLU model.
  • MODEL_TYPE_ADVANCED: Use advanced NLU model. Possible values are: MODEL_TYPE_STANDARD, MODEL_TYPE_ADVANCED.
classificationThreshold Double

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

modelTrainingMode String

Indicates NLU model training mode.

  • MODEL_TRAINING_MODE_AUTOMATIC: NLU model training is automatically triggered when a flow gets modified. User can also manually trigger model training in this mode.
  • MODEL_TRAINING_MODE_MANUAL: User needs to manually trigger NLU model training. Best for large flows whose models take long time to train. Possible values are: MODEL_TRAINING_MODE_AUTOMATIC, MODEL_TRAINING_MODE_MANUAL.
modelType String

Indicates the type of NLU model.

  • MODEL_TYPE_STANDARD: Use standard NLU model.
  • MODEL_TYPE_ADVANCED: Use advanced NLU model. Possible values are: MODEL_TYPE_STANDARD, MODEL_TYPE_ADVANCED.
classificationThreshold number

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

modelTrainingMode string

Indicates NLU model training mode.

  • MODEL_TRAINING_MODE_AUTOMATIC: NLU model training is automatically triggered when a flow gets modified. User can also manually trigger model training in this mode.
  • MODEL_TRAINING_MODE_MANUAL: User needs to manually trigger NLU model training. Best for large flows whose models take long time to train. Possible values are: MODEL_TRAINING_MODE_AUTOMATIC, MODEL_TRAINING_MODE_MANUAL.
modelType string

Indicates the type of NLU model.

  • MODEL_TYPE_STANDARD: Use standard NLU model.
  • MODEL_TYPE_ADVANCED: Use advanced NLU model. Possible values are: MODEL_TYPE_STANDARD, MODEL_TYPE_ADVANCED.
classification_threshold float

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

model_training_mode str

Indicates NLU model training mode.

  • MODEL_TRAINING_MODE_AUTOMATIC: NLU model training is automatically triggered when a flow gets modified. User can also manually trigger model training in this mode.
  • MODEL_TRAINING_MODE_MANUAL: User needs to manually trigger NLU model training. Best for large flows whose models take long time to train. Possible values are: MODEL_TRAINING_MODE_AUTOMATIC, MODEL_TRAINING_MODE_MANUAL.
model_type str

Indicates the type of NLU model.

  • MODEL_TYPE_STANDARD: Use standard NLU model.
  • MODEL_TYPE_ADVANCED: Use advanced NLU model. Possible values are: MODEL_TYPE_STANDARD, MODEL_TYPE_ADVANCED.
classificationThreshold Number

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

modelTrainingMode String

Indicates NLU model training mode.

  • MODEL_TRAINING_MODE_AUTOMATIC: NLU model training is automatically triggered when a flow gets modified. User can also manually trigger model training in this mode.
  • MODEL_TRAINING_MODE_MANUAL: User needs to manually trigger NLU model training. Best for large flows whose models take long time to train. Possible values are: MODEL_TRAINING_MODE_AUTOMATIC, MODEL_TRAINING_MODE_MANUAL.
modelType String

Indicates the type of NLU model.

  • MODEL_TYPE_STANDARD: Use standard NLU model.
  • MODEL_TYPE_ADVANCED: Use advanced NLU model. Possible values are: MODEL_TYPE_STANDARD, MODEL_TYPE_ADVANCED.

CxFlowTransitionRoute

Condition string

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

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

(Output) 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 CxFlowTransitionRouteTriggerFulfillment

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. Structure is documented below.

Condition string

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

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

(Output) 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 CxFlowTransitionRouteTriggerFulfillment

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. Structure is documented below.

condition String

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

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

(Output) 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 CxFlowTransitionRouteTriggerFulfillment

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. Structure is documented below.

condition string

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

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

(Output) 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 CxFlowTransitionRouteTriggerFulfillment

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. Structure is documented below.

condition str

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

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

(Output) 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 CxFlowTransitionRouteTriggerFulfillment

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. Structure is documented below.

condition String

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

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

(Output) 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 triggerFulfillment and target must be specified. When both are defined, triggerFulfillment is executed first. Structure is documented below.

CxFlowTransitionRouteTriggerFulfillment

Messages List<CxFlowTransitionRouteTriggerFulfillmentMessage>

The list of rich message responses to present to the user. Structure is documented below.

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.

Tag string

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

Webhook string

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

Messages []CxFlowTransitionRouteTriggerFulfillmentMessage

The list of rich message responses to present to the user. Structure is documented below.

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.

Tag string

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

Webhook string

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

messages List<CxFlowTransitionRouteTriggerFulfillmentMessage>

The list of rich message responses to present to the user. Structure is documented below.

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.

tag String

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

webhook String

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

messages CxFlowTransitionRouteTriggerFulfillmentMessage[]

The list of rich message responses to present to the user. Structure is documented below.

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.

tag string

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

webhook string

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

messages Sequence[CxFlowTransitionRouteTriggerFulfillmentMessage]

The list of rich message responses to present to the user. Structure is documented below.

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.

tag str

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

webhook str

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

messages List<Property Map>

The list of rich message responses to present to the user. Structure is documented below.

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.

tag String

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

webhook String

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

CxFlowTransitionRouteTriggerFulfillmentMessage

Text CxFlowTransitionRouteTriggerFulfillmentMessageText

The text response message. Structure is documented below.

Text CxFlowTransitionRouteTriggerFulfillmentMessageText

The text response message. Structure is documented below.

text CxFlowTransitionRouteTriggerFulfillmentMessageText

The text response message. Structure is documented below.

text CxFlowTransitionRouteTriggerFulfillmentMessageText

The text response message. Structure is documented below.

text CxFlowTransitionRouteTriggerFulfillmentMessageText

The text response message. Structure is documented below.

text Property Map

The text response message. Structure is documented below.

CxFlowTransitionRouteTriggerFulfillmentMessageText

AllowPlaybackInterruption bool

(Output) 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.

Texts List<string>

A collection of text responses.

AllowPlaybackInterruption bool

(Output) 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.

Texts []string

A collection of text responses.

allowPlaybackInterruption Boolean

(Output) 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.

texts List<String>

A collection of text responses.

allowPlaybackInterruption boolean

(Output) 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.

texts string[]

A collection of text responses.

allow_playback_interruption bool

(Output) 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.

texts Sequence[str]

A collection of text responses.

allowPlaybackInterruption Boolean

(Output) 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.

texts List<String>

A collection of text responses.

Import

Flow can be imported using any of these accepted formats

 $ pulumi import gcp:diagflow/cxFlow:CxFlow default {{parent}}/flows/{{name}}

 $ pulumi import gcp:diagflow/cxFlow:CxFlow default {{parent}}/{{name}}

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes

This Pulumi package is based on the google-beta Terraform Provider.