gcp.diagflow.CxPage
A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages.
To get more information about Page, see:
- API documentation
- How-to Guides
Example Usage
Dialogflowcx Page Full
using System.Collections.Generic;
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 myPage2 = new Gcp.Diagflow.CxPage("myPage2", new()
{
Parent = agent.StartFlow,
DisplayName = "MyPage2",
});
var basicPage = new Gcp.Diagflow.CxPage("basicPage", new()
{
Parent = agent.StartFlow,
DisplayName = "MyPage",
EntryFulfillment = new Gcp.Diagflow.Inputs.CxPageEntryFulfillmentArgs
{
Messages = new[]
{
new Gcp.Diagflow.Inputs.CxPageEntryFulfillmentMessageArgs
{
Text = new Gcp.Diagflow.Inputs.CxPageEntryFulfillmentMessageTextArgs
{
Texts = new[]
{
"Welcome to page",
},
},
},
},
},
Form = new Gcp.Diagflow.Inputs.CxPageFormArgs
{
Parameters = new[]
{
new Gcp.Diagflow.Inputs.CxPageFormParameterArgs
{
DisplayName = "param1",
EntityType = "projects/-/locations/-/agents/-/entityTypes/sys.date",
FillBehavior = new Gcp.Diagflow.Inputs.CxPageFormParameterFillBehaviorArgs
{
InitialPromptFulfillment = new Gcp.Diagflow.Inputs.CxPageFormParameterFillBehaviorInitialPromptFulfillmentArgs
{
Messages = new[]
{
new Gcp.Diagflow.Inputs.CxPageFormParameterFillBehaviorInitialPromptFulfillmentMessageArgs
{
Text = new Gcp.Diagflow.Inputs.CxPageFormParameterFillBehaviorInitialPromptFulfillmentMessageTextArgs
{
Texts = new[]
{
"Please provide param1",
},
},
},
},
},
},
Required = true,
Redact = true,
},
},
},
TransitionRoutes = new[]
{
new Gcp.Diagflow.Inputs.CxPageTransitionRouteArgs
{
Condition = "$page.params.status = 'FINAL'",
TriggerFulfillment = new Gcp.Diagflow.Inputs.CxPageTransitionRouteTriggerFulfillmentArgs
{
Messages = new[]
{
new Gcp.Diagflow.Inputs.CxPageTransitionRouteTriggerFulfillmentMessageArgs
{
Text = new Gcp.Diagflow.Inputs.CxPageTransitionRouteTriggerFulfillmentMessageTextArgs
{
Texts = new[]
{
"information completed, navigating to page 2",
},
},
},
},
},
TargetPage = myPage2.Id,
},
},
});
});
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
}
myPage2, err := diagflow.NewCxPage(ctx, "myPage2", &diagflow.CxPageArgs{
Parent: agent.StartFlow,
DisplayName: pulumi.String("MyPage2"),
})
if err != nil {
return err
}
_, err = diagflow.NewCxPage(ctx, "basicPage", &diagflow.CxPageArgs{
Parent: agent.StartFlow,
DisplayName: pulumi.String("MyPage"),
EntryFulfillment: &diagflow.CxPageEntryFulfillmentArgs{
Messages: diagflow.CxPageEntryFulfillmentMessageArray{
&diagflow.CxPageEntryFulfillmentMessageArgs{
Text: &diagflow.CxPageEntryFulfillmentMessageTextArgs{
Texts: pulumi.StringArray{
pulumi.String("Welcome to page"),
},
},
},
},
},
Form: &diagflow.CxPageFormArgs{
Parameters: diagflow.CxPageFormParameterArray{
&diagflow.CxPageFormParameterArgs{
DisplayName: pulumi.String("param1"),
EntityType: pulumi.String("projects/-/locations/-/agents/-/entityTypes/sys.date"),
FillBehavior: &diagflow.CxPageFormParameterFillBehaviorArgs{
InitialPromptFulfillment: &diagflow.CxPageFormParameterFillBehaviorInitialPromptFulfillmentArgs{
Messages: diagflow.CxPageFormParameterFillBehaviorInitialPromptFulfillmentMessageArray{
&diagflow.CxPageFormParameterFillBehaviorInitialPromptFulfillmentMessageArgs{
Text: &diagflow.CxPageFormParameterFillBehaviorInitialPromptFulfillmentMessageTextArgs{
Texts: pulumi.StringArray{
pulumi.String("Please provide param1"),
},
},
},
},
},
},
Required: pulumi.Bool(true),
Redact: pulumi.Bool(true),
},
},
},
TransitionRoutes: diagflow.CxPageTransitionRouteArray{
&diagflow.CxPageTransitionRouteArgs{
Condition: pulumi.String("$page.params.status = 'FINAL'"),
TriggerFulfillment: &diagflow.CxPageTransitionRouteTriggerFulfillmentArgs{
Messages: diagflow.CxPageTransitionRouteTriggerFulfillmentMessageArray{
&diagflow.CxPageTransitionRouteTriggerFulfillmentMessageArgs{
Text: &diagflow.CxPageTransitionRouteTriggerFulfillmentMessageTextArgs{
Texts: pulumi.StringArray{
pulumi.String("information completed, navigating to page 2"),
},
},
},
},
},
TargetPage: myPage2.ID(),
},
},
})
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.CxPage;
import com.pulumi.gcp.diagflow.CxPageArgs;
import com.pulumi.gcp.diagflow.inputs.CxPageEntryFulfillmentArgs;
import com.pulumi.gcp.diagflow.inputs.CxPageFormArgs;
import com.pulumi.gcp.diagflow.inputs.CxPageTransitionRouteArgs;
import com.pulumi.gcp.diagflow.inputs.CxPageTransitionRouteTriggerFulfillmentArgs;
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 myPage2 = new CxPage("myPage2", CxPageArgs.builder()
.parent(agent.startFlow())
.displayName("MyPage2")
.build());
var basicPage = new CxPage("basicPage", CxPageArgs.builder()
.parent(agent.startFlow())
.displayName("MyPage")
.entryFulfillment(CxPageEntryFulfillmentArgs.builder()
.messages(CxPageEntryFulfillmentMessageArgs.builder()
.text(CxPageEntryFulfillmentMessageTextArgs.builder()
.texts("Welcome to page")
.build())
.build())
.build())
.form(CxPageFormArgs.builder()
.parameters(CxPageFormParameterArgs.builder()
.displayName("param1")
.entityType("projects/-/locations/-/agents/-/entityTypes/sys.date")
.fillBehavior(CxPageFormParameterFillBehaviorArgs.builder()
.initialPromptFulfillment(CxPageFormParameterFillBehaviorInitialPromptFulfillmentArgs.builder()
.messages(CxPageFormParameterFillBehaviorInitialPromptFulfillmentMessageArgs.builder()
.text(CxPageFormParameterFillBehaviorInitialPromptFulfillmentMessageTextArgs.builder()
.texts("Please provide param1")
.build())
.build())
.build())
.build())
.required("true")
.redact("true")
.build())
.build())
.transitionRoutes(CxPageTransitionRouteArgs.builder()
.condition("$page.params.status = 'FINAL'")
.triggerFulfillment(CxPageTransitionRouteTriggerFulfillmentArgs.builder()
.messages(CxPageTransitionRouteTriggerFulfillmentMessageArgs.builder()
.text(CxPageTransitionRouteTriggerFulfillmentMessageTextArgs.builder()
.texts("information completed, navigating to page 2")
.build())
.build())
.build())
.targetPage(myPage2.id())
.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,
))
my_page2 = gcp.diagflow.CxPage("myPage2",
parent=agent.start_flow,
display_name="MyPage2")
basic_page = gcp.diagflow.CxPage("basicPage",
parent=agent.start_flow,
display_name="MyPage",
entry_fulfillment=gcp.diagflow.CxPageEntryFulfillmentArgs(
messages=[gcp.diagflow.CxPageEntryFulfillmentMessageArgs(
text=gcp.diagflow.CxPageEntryFulfillmentMessageTextArgs(
texts=["Welcome to page"],
),
)],
),
form=gcp.diagflow.CxPageFormArgs(
parameters=[gcp.diagflow.CxPageFormParameterArgs(
display_name="param1",
entity_type="projects/-/locations/-/agents/-/entityTypes/sys.date",
fill_behavior=gcp.diagflow.CxPageFormParameterFillBehaviorArgs(
initial_prompt_fulfillment=gcp.diagflow.CxPageFormParameterFillBehaviorInitialPromptFulfillmentArgs(
messages=[gcp.diagflow.CxPageFormParameterFillBehaviorInitialPromptFulfillmentMessageArgs(
text=gcp.diagflow.CxPageFormParameterFillBehaviorInitialPromptFulfillmentMessageTextArgs(
texts=["Please provide param1"],
),
)],
),
),
required=True,
redact=True,
)],
),
transition_routes=[gcp.diagflow.CxPageTransitionRouteArgs(
condition="$page.params.status = 'FINAL'",
trigger_fulfillment=gcp.diagflow.CxPageTransitionRouteTriggerFulfillmentArgs(
messages=[gcp.diagflow.CxPageTransitionRouteTriggerFulfillmentMessageArgs(
text=gcp.diagflow.CxPageTransitionRouteTriggerFulfillmentMessageTextArgs(
texts=["information completed, navigating to page 2"],
),
)],
),
target_page=my_page2.id,
)])
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 myPage2 = new gcp.diagflow.CxPage("myPage2", {
parent: agent.startFlow,
displayName: "MyPage2",
});
const basicPage = new gcp.diagflow.CxPage("basicPage", {
parent: agent.startFlow,
displayName: "MyPage",
entryFulfillment: {
messages: [{
text: {
texts: ["Welcome to page"],
},
}],
},
form: {
parameters: [{
displayName: "param1",
entityType: "projects/-/locations/-/agents/-/entityTypes/sys.date",
fillBehavior: {
initialPromptFulfillment: {
messages: [{
text: {
texts: ["Please provide param1"],
},
}],
},
},
required: true,
redact: true,
}],
},
transitionRoutes: [{
condition: "$page.params.status = 'FINAL'",
triggerFulfillment: {
messages: [{
text: {
texts: ["information completed, navigating to page 2"],
},
}],
},
targetPage: myPage2.id,
}],
});
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
basicPage:
type: gcp:diagflow:CxPage
properties:
parent: ${agent.startFlow}
displayName: MyPage
entryFulfillment:
messages:
- text:
texts:
- Welcome to page
form:
parameters:
- displayName: param1
entityType: projects/-/locations/-/agents/-/entityTypes/sys.date
fillBehavior:
initialPromptFulfillment:
messages:
- text:
texts:
- Please provide param1
required: 'true'
redact: 'true'
transitionRoutes:
- condition: $page.params.status = 'FINAL'
triggerFulfillment:
messages:
- text:
texts:
- information completed, navigating to page 2
targetPage: ${myPage2.id}
myPage2:
type: gcp:diagflow:CxPage
properties:
parent: ${agent.startFlow}
displayName: MyPage2
Create CxPage Resource
new CxPage(name: string, args: CxPageArgs, opts?: CustomResourceOptions);
@overload
def CxPage(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
entry_fulfillment: Optional[CxPageEntryFulfillmentArgs] = None,
event_handlers: Optional[Sequence[CxPageEventHandlerArgs]] = None,
form: Optional[CxPageFormArgs] = None,
language_code: Optional[str] = None,
parent: Optional[str] = None,
transition_route_groups: Optional[Sequence[str]] = None,
transition_routes: Optional[Sequence[CxPageTransitionRouteArgs]] = None)
@overload
def CxPage(resource_name: str,
args: CxPageArgs,
opts: Optional[ResourceOptions] = None)
func NewCxPage(ctx *Context, name string, args CxPageArgs, opts ...ResourceOption) (*CxPage, error)
public CxPage(string name, CxPageArgs args, CustomResourceOptions? opts = null)
public CxPage(String name, CxPageArgs args)
public CxPage(String name, CxPageArgs args, CustomResourceOptions options)
type: gcp:diagflow:CxPage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CxPageArgs
- 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 CxPageArgs
- 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 CxPageArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CxPageArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CxPageArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
CxPage 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 CxPage resource accepts the following input properties:
- Display
Name string The human-readable name of the page, unique within the agent.
- Entry
Fulfillment CxPage Entry Fulfillment Args The fulfillment to call when the session is entering the page. Structure is documented below.
- Event
Handlers List<CxPage Event Handler Args> Handlers associated with the page to handle events such as webhook errors, no match or no input. Structure is documented below.
- Form
Cx
Page Form Args The form associated with the page, used for collecting parameters relevant to the page. Structure is documented below.
- Language
Code string The language of the following fields in page: Page.entry_fulfillment.messages Page.entry_fulfillment.conditional_cases Page.event_handlers.trigger_fulfillment.messages Page.event_handlers.trigger_fulfillment.conditional_cases Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases Page.form.parameters.fill_behavior.reprompt_event_handlers.messages Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases Page.transition_routes.trigger_fulfillment.messages Page.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.
- Parent string
The flow to create a page for. Format: projects//locations//agents//flows/.
- Transition
Route List<string>Groups 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 List<CxPage Transition Route Args> 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. Structure is documented below.
- Display
Name string The human-readable name of the page, unique within the agent.
- Entry
Fulfillment CxPage Entry Fulfillment Args The fulfillment to call when the session is entering the page. Structure is documented below.
- Event
Handlers []CxPage Event Handler Args Handlers associated with the page to handle events such as webhook errors, no match or no input. Structure is documented below.
- Form
Cx
Page Form Args The form associated with the page, used for collecting parameters relevant to the page. Structure is documented below.
- Language
Code string The language of the following fields in page: Page.entry_fulfillment.messages Page.entry_fulfillment.conditional_cases Page.event_handlers.trigger_fulfillment.messages Page.event_handlers.trigger_fulfillment.conditional_cases Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases Page.form.parameters.fill_behavior.reprompt_event_handlers.messages Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases Page.transition_routes.trigger_fulfillment.messages Page.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.
- Parent string
The flow to create a page for. Format: projects//locations//agents//flows/.
- Transition
Route []stringGroups 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 []CxPage Transition Route Args 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. Structure is documented below.
- display
Name String The human-readable name of the page, unique within the agent.
- entry
Fulfillment CxPage Entry Fulfillment Args The fulfillment to call when the session is entering the page. Structure is documented below.
- event
Handlers List<CxPage Event Handler Args> Handlers associated with the page to handle events such as webhook errors, no match or no input. Structure is documented below.
- form
Cx
Page Form Args The form associated with the page, used for collecting parameters relevant to the page. Structure is documented below.
- language
Code String The language of the following fields in page: Page.entry_fulfillment.messages Page.entry_fulfillment.conditional_cases Page.event_handlers.trigger_fulfillment.messages Page.event_handlers.trigger_fulfillment.conditional_cases Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases Page.form.parameters.fill_behavior.reprompt_event_handlers.messages Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases Page.transition_routes.trigger_fulfillment.messages Page.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.
- parent String
The flow to create a page for. Format: projects//locations//agents//flows/.
- transition
Route List<String>Groups 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 List<CxPage Transition Route Args> 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. Structure is documented below.
- display
Name string The human-readable name of the page, unique within the agent.
- entry
Fulfillment CxPage Entry Fulfillment Args The fulfillment to call when the session is entering the page. Structure is documented below.
- event
Handlers CxPage Event Handler Args[] Handlers associated with the page to handle events such as webhook errors, no match or no input. Structure is documented below.
- form
Cx
Page Form Args The form associated with the page, used for collecting parameters relevant to the page. Structure is documented below.
- language
Code string The language of the following fields in page: Page.entry_fulfillment.messages Page.entry_fulfillment.conditional_cases Page.event_handlers.trigger_fulfillment.messages Page.event_handlers.trigger_fulfillment.conditional_cases Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases Page.form.parameters.fill_behavior.reprompt_event_handlers.messages Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases Page.transition_routes.trigger_fulfillment.messages Page.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.
- parent string
The flow to create a page for. Format: projects//locations//agents//flows/.
- transition
Route string[]Groups 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 CxPage Transition Route Args[] 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. Structure is documented below.
- display_
name str The human-readable name of the page, unique within the agent.
- entry_
fulfillment CxPage Entry Fulfillment Args The fulfillment to call when the session is entering the page. Structure is documented below.
- event_
handlers Sequence[CxPage Event Handler Args] Handlers associated with the page to handle events such as webhook errors, no match or no input. Structure is documented below.
- form
Cx
Page Form Args The form associated with the page, used for collecting parameters relevant to the page. Structure is documented below.
- language_
code str The language of the following fields in page: Page.entry_fulfillment.messages Page.entry_fulfillment.conditional_cases Page.event_handlers.trigger_fulfillment.messages Page.event_handlers.trigger_fulfillment.conditional_cases Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases Page.form.parameters.fill_behavior.reprompt_event_handlers.messages Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases Page.transition_routes.trigger_fulfillment.messages Page.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.
- parent str
The flow to create a page for. Format: projects//locations//agents//flows/.
- transition_
route_ Sequence[str]groups 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[CxPage Transition Route Args] 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. Structure is documented below.
- display
Name String The human-readable name of the page, unique within the agent.
- entry
Fulfillment Property Map The fulfillment to call when the session is entering the page. Structure is documented below.
- event
Handlers List<Property Map> Handlers associated with the page to handle events such as webhook errors, no match or no input. Structure is documented below.
- form Property Map
The form associated with the page, used for collecting parameters relevant to the page. Structure is documented below.
- language
Code String The language of the following fields in page: Page.entry_fulfillment.messages Page.entry_fulfillment.conditional_cases Page.event_handlers.trigger_fulfillment.messages Page.event_handlers.trigger_fulfillment.conditional_cases Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases Page.form.parameters.fill_behavior.reprompt_event_handlers.messages Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases Page.transition_routes.trigger_fulfillment.messages Page.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.
- parent String
The flow to create a page for. Format: projects//locations//agents//flows/.
- transition
Route List<String>Groups 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 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. Structure is documented below.
Outputs
All input properties are implicitly available as output properties. Additionally, the CxPage resource produces the following output properties:
Look up Existing CxPage Resource
Get an existing CxPage 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?: CxPageState, opts?: CustomResourceOptions): CxPage
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
entry_fulfillment: Optional[CxPageEntryFulfillmentArgs] = None,
event_handlers: Optional[Sequence[CxPageEventHandlerArgs]] = None,
form: Optional[CxPageFormArgs] = None,
language_code: Optional[str] = None,
name: Optional[str] = None,
parent: Optional[str] = None,
transition_route_groups: Optional[Sequence[str]] = None,
transition_routes: Optional[Sequence[CxPageTransitionRouteArgs]] = None) -> CxPage
func GetCxPage(ctx *Context, name string, id IDInput, state *CxPageState, opts ...ResourceOption) (*CxPage, error)
public static CxPage Get(string name, Input<string> id, CxPageState? state, CustomResourceOptions? opts = null)
public static CxPage get(String name, Output<String> id, CxPageState 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.
- Display
Name string The human-readable name of the page, unique within the agent.
- Entry
Fulfillment CxPage Entry Fulfillment Args The fulfillment to call when the session is entering the page. Structure is documented below.
- Event
Handlers List<CxPage Event Handler Args> Handlers associated with the page to handle events such as webhook errors, no match or no input. Structure is documented below.
- Form
Cx
Page Form Args The form associated with the page, used for collecting parameters relevant to the page. Structure is documented below.
- Language
Code string The language of the following fields in page: Page.entry_fulfillment.messages Page.entry_fulfillment.conditional_cases Page.event_handlers.trigger_fulfillment.messages Page.event_handlers.trigger_fulfillment.conditional_cases Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases Page.form.parameters.fill_behavior.reprompt_event_handlers.messages Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases Page.transition_routes.trigger_fulfillment.messages Page.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.
- Parent string
The flow to create a page for. Format: projects//locations//agents//flows/.
- Transition
Route List<string>Groups 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 List<CxPage Transition Route Args> 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. Structure is documented below.
- Display
Name string The human-readable name of the page, unique within the agent.
- Entry
Fulfillment CxPage Entry Fulfillment Args The fulfillment to call when the session is entering the page. Structure is documented below.
- Event
Handlers []CxPage Event Handler Args Handlers associated with the page to handle events such as webhook errors, no match or no input. Structure is documented below.
- Form
Cx
Page Form Args The form associated with the page, used for collecting parameters relevant to the page. Structure is documented below.
- Language
Code string The language of the following fields in page: Page.entry_fulfillment.messages Page.entry_fulfillment.conditional_cases Page.event_handlers.trigger_fulfillment.messages Page.event_handlers.trigger_fulfillment.conditional_cases Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases Page.form.parameters.fill_behavior.reprompt_event_handlers.messages Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases Page.transition_routes.trigger_fulfillment.messages Page.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.
- Parent string
The flow to create a page for. Format: projects//locations//agents//flows/.
- Transition
Route []stringGroups 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 []CxPage Transition Route Args 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. Structure is documented below.
- display
Name String The human-readable name of the page, unique within the agent.
- entry
Fulfillment CxPage Entry Fulfillment Args The fulfillment to call when the session is entering the page. Structure is documented below.
- event
Handlers List<CxPage Event Handler Args> Handlers associated with the page to handle events such as webhook errors, no match or no input. Structure is documented below.
- form
Cx
Page Form Args The form associated with the page, used for collecting parameters relevant to the page. Structure is documented below.
- language
Code String The language of the following fields in page: Page.entry_fulfillment.messages Page.entry_fulfillment.conditional_cases Page.event_handlers.trigger_fulfillment.messages Page.event_handlers.trigger_fulfillment.conditional_cases Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases Page.form.parameters.fill_behavior.reprompt_event_handlers.messages Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases Page.transition_routes.trigger_fulfillment.messages Page.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.
- parent String
The flow to create a page for. Format: projects//locations//agents//flows/.
- transition
Route List<String>Groups 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 List<CxPage Transition Route Args> 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. Structure is documented below.
- display
Name string The human-readable name of the page, unique within the agent.
- entry
Fulfillment CxPage Entry Fulfillment Args The fulfillment to call when the session is entering the page. Structure is documented below.
- event
Handlers CxPage Event Handler Args[] Handlers associated with the page to handle events such as webhook errors, no match or no input. Structure is documented below.
- form
Cx
Page Form Args The form associated with the page, used for collecting parameters relevant to the page. Structure is documented below.
- language
Code string The language of the following fields in page: Page.entry_fulfillment.messages Page.entry_fulfillment.conditional_cases Page.event_handlers.trigger_fulfillment.messages Page.event_handlers.trigger_fulfillment.conditional_cases Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases Page.form.parameters.fill_behavior.reprompt_event_handlers.messages Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases Page.transition_routes.trigger_fulfillment.messages Page.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.
- parent string
The flow to create a page for. Format: projects//locations//agents//flows/.
- transition
Route string[]Groups 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 CxPage Transition Route Args[] 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. Structure is documented below.
- display_
name str The human-readable name of the page, unique within the agent.
- entry_
fulfillment CxPage Entry Fulfillment Args The fulfillment to call when the session is entering the page. Structure is documented below.
- event_
handlers Sequence[CxPage Event Handler Args] Handlers associated with the page to handle events such as webhook errors, no match or no input. Structure is documented below.
- form
Cx
Page Form Args The form associated with the page, used for collecting parameters relevant to the page. Structure is documented below.
- language_
code str The language of the following fields in page: Page.entry_fulfillment.messages Page.entry_fulfillment.conditional_cases Page.event_handlers.trigger_fulfillment.messages Page.event_handlers.trigger_fulfillment.conditional_cases Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases Page.form.parameters.fill_behavior.reprompt_event_handlers.messages Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases Page.transition_routes.trigger_fulfillment.messages Page.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.
- parent str
The flow to create a page for. Format: projects//locations//agents//flows/.
- transition_
route_ Sequence[str]groups 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[CxPage Transition Route Args] 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. Structure is documented below.
- display
Name String The human-readable name of the page, unique within the agent.
- entry
Fulfillment Property Map The fulfillment to call when the session is entering the page. Structure is documented below.
- event
Handlers List<Property Map> Handlers associated with the page to handle events such as webhook errors, no match or no input. Structure is documented below.
- form Property Map
The form associated with the page, used for collecting parameters relevant to the page. Structure is documented below.
- language
Code String The language of the following fields in page: Page.entry_fulfillment.messages Page.entry_fulfillment.conditional_cases Page.event_handlers.trigger_fulfillment.messages Page.event_handlers.trigger_fulfillment.conditional_cases Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases Page.form.parameters.fill_behavior.reprompt_event_handlers.messages Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases Page.transition_routes.trigger_fulfillment.messages Page.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.
- parent String
The flow to create a page for. Format: projects//locations//agents//flows/.
- transition
Route List<String>Groups 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 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. Structure is documented below.
Supporting Types
CxPageEntryFulfillment
- Messages
List<Cx
Page Entry Fulfillment Message> The list of rich message responses to present to the user. Structure is documented below.
- Return
Partial boolResponses 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
[]Cx
Page Entry Fulfillment Message The list of rich message responses to present to the user. Structure is documented below.
- Return
Partial boolResponses 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<Cx
Page Entry Fulfillment Message> The list of rich message responses to present to the user. Structure is documented below.
- return
Partial BooleanResponses 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
Cx
Page Entry Fulfillment Message[] The list of rich message responses to present to the user. Structure is documented below.
- return
Partial booleanResponses 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[Cx
Page Entry Fulfillment Message] The list of rich message responses to present to the user. Structure is documented below.
- return_
partial_ boolresponses 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.
- return
Partial BooleanResponses 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/.
CxPageEntryFulfillmentMessage
- Text
Cx
Page Entry Fulfillment Message Text The text response message. Structure is documented below.
- Text
Cx
Page Entry Fulfillment Message Text The text response message. Structure is documented below.
- text
Cx
Page Entry Fulfillment Message Text The text response message. Structure is documented below.
- text
Cx
Page Entry Fulfillment Message Text The text response message. Structure is documented below.
- text
Cx
Page Entry Fulfillment Message Text The text response message. Structure is documented below.
- text Property Map
The text response message. Structure is documented below.
CxPageEntryFulfillmentMessageText
- Allow
Playback boolInterruption (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.
- Allow
Playback boolInterruption (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 BooleanInterruption (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.
- allow
Playback booleanInterruption (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_ boolinterruption (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.
- allow
Playback BooleanInterruption (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.
CxPageEventHandler
- Event string
The name of the event to handle.
- Name string
(Output) The unique identifier of this event handler.
- Target
Flow string The target flow to transition to. Format: projects//locations//agents//flows/.
- Target
Page string The target page to transition to. Format: projects//locations//agents//flows//pages/.
- Trigger
Fulfillment CxPage Event Handler Trigger Fulfillment 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.
- Target
Flow string The target flow to transition to. Format: projects//locations//agents//flows/.
- Target
Page string The target page to transition to. Format: projects//locations//agents//flows//pages/.
- Trigger
Fulfillment CxPage Event Handler Trigger Fulfillment 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.
- target
Flow String The target flow to transition to. Format: projects//locations//agents//flows/.
- target
Page String The target page to transition to. Format: projects//locations//agents//flows//pages/.
- trigger
Fulfillment CxPage Event Handler Trigger Fulfillment 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.
- target
Flow string The target flow to transition to. Format: projects//locations//agents//flows/.
- target
Page string The target page to transition to. Format: projects//locations//agents//flows//pages/.
- trigger
Fulfillment CxPage Event Handler Trigger Fulfillment 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 CxPage Event Handler Trigger Fulfillment 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.
- target
Flow String The target flow to transition to. Format: projects//locations//agents//flows/.
- target
Page String The target page to transition to. Format: projects//locations//agents//flows//pages/.
- trigger
Fulfillment 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.
CxPageEventHandlerTriggerFulfillment
- Messages
List<Cx
Page Event Handler Trigger Fulfillment Message> The list of rich message responses to present to the user. Structure is documented below.
- Return
Partial boolResponses 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
[]Cx
Page Event Handler Trigger Fulfillment Message The list of rich message responses to present to the user. Structure is documented below.
- Return
Partial boolResponses 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<Cx
Page Event Handler Trigger Fulfillment Message> The list of rich message responses to present to the user. Structure is documented below.
- return
Partial BooleanResponses 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
Cx
Page Event Handler Trigger Fulfillment Message[] The list of rich message responses to present to the user. Structure is documented below.
- return
Partial booleanResponses 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[Cx
Page Event Handler Trigger Fulfillment Message] The list of rich message responses to present to the user. Structure is documented below.
- return_
partial_ boolresponses 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.
- return
Partial BooleanResponses 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/.
CxPageEventHandlerTriggerFulfillmentMessage
- Text
Cx
Page Event Handler Trigger Fulfillment Message Text The text response message. Structure is documented below.
- Text
Cx
Page Event Handler Trigger Fulfillment Message Text The text response message. Structure is documented below.
- text
Cx
Page Event Handler Trigger Fulfillment Message Text The text response message. Structure is documented below.
- text
Cx
Page Event Handler Trigger Fulfillment Message Text The text response message. Structure is documented below.
- text
Cx
Page Event Handler Trigger Fulfillment Message Text The text response message. Structure is documented below.
- text Property Map
The text response message. Structure is documented below.
CxPageEventHandlerTriggerFulfillmentMessageText
- Allow
Playback boolInterruption (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.
- Allow
Playback boolInterruption (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 BooleanInterruption (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.
- allow
Playback booleanInterruption (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_ boolinterruption (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.
- allow
Playback BooleanInterruption (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.
CxPageForm
- Parameters
List<Cx
Page Form Parameter> Parameters to collect from the user. Structure is documented below.
- Parameters
[]Cx
Page Form Parameter Parameters to collect from the user. Structure is documented below.
- parameters
List<Cx
Page Form Parameter> Parameters to collect from the user. Structure is documented below.
- parameters
Cx
Page Form Parameter[] Parameters to collect from the user. Structure is documented below.
- parameters
Sequence[Cx
Page Form Parameter] Parameters to collect from the user. Structure is documented below.
- parameters List<Property Map>
Parameters to collect from the user. Structure is documented below.
CxPageFormParameter
- Display
Name string The human-readable name of the parameter, unique within the form.
- Entity
Type 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.
- Fill
Behavior CxPage Form Parameter Fill Behavior Defines fill behavior for the parameter. Structure is documented below.
- 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.
- Display
Name string The human-readable name of the parameter, unique within the form.
- Entity
Type 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.
- Fill
Behavior CxPage Form Parameter Fill Behavior Defines fill behavior for the parameter. Structure is documented below.
- 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.
- display
Name String The human-readable name of the parameter, unique within the form.
- entity
Type 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.
- fill
Behavior CxPage Form Parameter Fill Behavior Defines fill behavior for the parameter. Structure is documented below.
- is
List 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.
- display
Name string The human-readable name of the parameter, unique within the form.
- entity
Type 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.
- fill
Behavior CxPage Form Parameter Fill Behavior Defines fill behavior for the parameter. Structure is documented below.
- is
List 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.
- 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 CxPage Form Parameter Fill Behavior Defines fill behavior for the parameter. Structure is documented below.
- 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.
- display
Name String The human-readable name of the parameter, unique within the form.
- entity
Type 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.
- fill
Behavior Property Map Defines fill behavior for the parameter. Structure is documented below.
- is
List 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.
CxPageFormParameterFillBehavior
- Initial
Prompt CxFulfillment Page Form Parameter Fill Behavior Initial Prompt Fulfillment The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. Structure is documented below.
- Initial
Prompt CxFulfillment Page Form Parameter Fill Behavior Initial Prompt Fulfillment The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. Structure is documented below.
- initial
Prompt CxFulfillment Page Form Parameter Fill Behavior Initial Prompt Fulfillment The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. Structure is documented below.
- initial
Prompt CxFulfillment Page Form Parameter Fill Behavior Initial Prompt Fulfillment The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. Structure is documented below.
- initial_
prompt_ Cxfulfillment Page Form Parameter Fill Behavior Initial Prompt Fulfillment The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. Structure is documented below.
- initial
Prompt Property MapFulfillment The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. Structure is documented below.
CxPageFormParameterFillBehaviorInitialPromptFulfillment
- Messages
List<Cx
Page Form Parameter Fill Behavior Initial Prompt Fulfillment Message> The list of rich message responses to present to the user. Structure is documented below.
- Return
Partial boolResponses 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
[]Cx
Page Form Parameter Fill Behavior Initial Prompt Fulfillment Message The list of rich message responses to present to the user. Structure is documented below.
- Return
Partial boolResponses 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<Cx
Page Form Parameter Fill Behavior Initial Prompt Fulfillment Message> The list of rich message responses to present to the user. Structure is documented below.
- return
Partial BooleanResponses 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
Cx
Page Form Parameter Fill Behavior Initial Prompt Fulfillment Message[] The list of rich message responses to present to the user. Structure is documented below.
- return
Partial booleanResponses 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[Cx
Page Form Parameter Fill Behavior Initial Prompt Fulfillment Message] The list of rich message responses to present to the user. Structure is documented below.
- return_
partial_ boolresponses 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.
- return
Partial BooleanResponses 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/.
CxPageFormParameterFillBehaviorInitialPromptFulfillmentMessage
- Text
Cx
Page Form Parameter Fill Behavior Initial Prompt Fulfillment Message Text The text response message. Structure is documented below.
- Text
Cx
Page Form Parameter Fill Behavior Initial Prompt Fulfillment Message Text The text response message. Structure is documented below.
- text
Cx
Page Form Parameter Fill Behavior Initial Prompt Fulfillment Message Text The text response message. Structure is documented below.
- text
Cx
Page Form Parameter Fill Behavior Initial Prompt Fulfillment Message Text The text response message. Structure is documented below.
- text
Cx
Page Form Parameter Fill Behavior Initial Prompt Fulfillment Message Text The text response message. Structure is documented below.
- text Property Map
The text response message. Structure is documented below.
CxPageFormParameterFillBehaviorInitialPromptFulfillmentMessageText
- Allow
Playback boolInterruption (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.
- Allow
Playback boolInterruption (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 BooleanInterruption (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.
- allow
Playback booleanInterruption (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_ boolinterruption (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.
- allow
Playback BooleanInterruption (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.
CxPageTransitionRoute
- 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.
- Target
Flow string The target flow to transition to. Format: projects//locations//agents//flows/.
- Target
Page string The target page to transition to. Format: projects//locations//agents//flows//pages/.
- Trigger
Fulfillment CxPage Transition Route Trigger Fulfillment 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.
- 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.
- Target
Flow string The target flow to transition to. Format: projects//locations//agents//flows/.
- Target
Page string The target page to transition to. Format: projects//locations//agents//flows//pages/.
- Trigger
Fulfillment CxPage Transition Route Trigger Fulfillment 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.
- 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.
- target
Flow String The target flow to transition to. Format: projects//locations//agents//flows/.
- target
Page String The target page to transition to. Format: projects//locations//agents//flows//pages/.
- trigger
Fulfillment CxPage Transition Route Trigger Fulfillment 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.
- 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.
- target
Flow string The target flow to transition to. Format: projects//locations//agents//flows/.
- target
Page string The target page to transition to. Format: projects//locations//agents//flows//pages/.
- trigger
Fulfillment CxPage Transition Route Trigger Fulfillment 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.
- 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 CxPage Transition Route Trigger Fulfillment 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.
- 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.
- target
Flow String The target flow to transition to. Format: projects//locations//agents//flows/.
- target
Page String The target page to transition to. Format: projects//locations//agents//flows//pages/.
- trigger
Fulfillment 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.
CxPageTransitionRouteTriggerFulfillment
- Messages
List<Cx
Page Transition Route Trigger Fulfillment Message> The list of rich message responses to present to the user. Structure is documented below.
- Return
Partial boolResponses 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
[]Cx
Page Transition Route Trigger Fulfillment Message The list of rich message responses to present to the user. Structure is documented below.
- Return
Partial boolResponses 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<Cx
Page Transition Route Trigger Fulfillment Message> The list of rich message responses to present to the user. Structure is documented below.
- return
Partial BooleanResponses 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
Cx
Page Transition Route Trigger Fulfillment Message[] The list of rich message responses to present to the user. Structure is documented below.
- return
Partial booleanResponses 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[Cx
Page Transition Route Trigger Fulfillment Message] The list of rich message responses to present to the user. Structure is documented below.
- return_
partial_ boolresponses 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.
- return
Partial BooleanResponses 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/.
CxPageTransitionRouteTriggerFulfillmentMessage
- Text
Cx
Page Transition Route Trigger Fulfillment Message Text The text response message. Structure is documented below.
- Text
Cx
Page Transition Route Trigger Fulfillment Message Text The text response message. Structure is documented below.
- text
Cx
Page Transition Route Trigger Fulfillment Message Text The text response message. Structure is documented below.
- text
Cx
Page Transition Route Trigger Fulfillment Message Text The text response message. Structure is documented below.
- text
Cx
Page Transition Route Trigger Fulfillment Message Text The text response message. Structure is documented below.
- text Property Map
The text response message. Structure is documented below.
CxPageTransitionRouteTriggerFulfillmentMessageText
- Allow
Playback boolInterruption (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.
- Allow
Playback boolInterruption (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 BooleanInterruption (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.
- allow
Playback booleanInterruption (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_ boolinterruption (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.
- allow
Playback BooleanInterruption (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
Page can be imported using any of these accepted formats
$ pulumi import gcp:diagflow/cxPage:CxPage default {{parent}}/pages/{{name}}
$ pulumi import gcp:diagflow/cxPage:CxPage 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.