import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * 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](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.flows.pages) * * How-to Guides * * [Official Documentation](https://cloud.google.com/dialogflow/cx/docs) * * ## Example Usage * * ### Dialogflowcx Page Full * * ```typescript * 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("my_page2", { * parent: agent.startFlow, * displayName: "MyPage2", * }); * const myWebhook = new gcp.diagflow.CxWebhook("my_webhook", { * parent: agent.id, * displayName: "MyWebhook", * genericWebService: { * uri: "https://example.com", * }, * }); * const project = gcp.organizations.getProject({}); * const basicPage = new gcp.diagflow.CxPage("basic_page", { * parent: agent.startFlow, * displayName: "MyPage", * entryFulfillment: { * messages: [ * { * channel: "some-channel", * text: { * texts: ["Welcome to page"], * }, * }, * { * payload: " {\\\"some-key\\\": \\\"some-value\\\", \\\"other-key\\\": [\\\"other-value\\\"]}\n", * }, * { * conversationSuccess: { * metadata: " {\\\"some-metadata-key\\\": \\\"some-value\\\", \\\"other-metadata-key\\\": 1234}\n", * }, * }, * { * outputAudioText: { * text: "some output text", * }, * }, * { * outputAudioText: { * ssml: " Some example SSML XML\n", * }, * }, * { * liveAgentHandoff: { * metadata: " {\\\"some-metadata-key\\\": \\\"some-value\\\", \\\"other-metadata-key\\\": 1234}\n", * }, * }, * { * playAudio: { * audioUri: "http://example.com/some-audio-file.mp3", * }, * }, * { * telephonyTransferCall: { * phoneNumber: "1-234-567-8901", * }, * }, * ], * setParameterActions: [ * { * parameter: "some-param", * value: "123.45", * }, * { * parameter: "another-param", * value: JSON.stringify("abc"), * }, * { * parameter: "other-param", * value: JSON.stringify(["foo"]), * }, * ], * conditionalCases: [{ * cases: JSON.stringify([ * { * condition: "$sys.func.RAND() < 0.5", * caseContent: [ * { * message: { * text: { * text: ["First case"], * }, * }, * }, * { * additionalCases: { * cases: [{ * condition: "$sys.func.RAND() < 0.2", * caseContent: [{ * message: { * text: { * text: ["Nested case"], * }, * }, * }], * }], * }, * }, * ], * }, * { * caseContent: [{ * message: { * text: { * text: ["Final case"], * }, * }, * }], * }, * ]), * }], * }, * eventHandlers: [{ * event: "some-event", * triggerFulfillment: { * returnPartialResponses: true, * messages: [ * { * channel: "some-channel", * text: { * texts: ["Some text"], * }, * }, * { * payload: " {\\\"some-key\\\": \\\"some-value\\\", \\\"other-key\\\": [\\\"other-value\\\"]}\n", * }, * { * conversationSuccess: { * metadata: " {\\\"some-metadata-key\\\": \\\"some-value\\\", \\\"other-metadata-key\\\": 1234}\n", * }, * }, * { * outputAudioText: { * text: "some output text", * }, * }, * { * outputAudioText: { * ssml: " Some example SSML XML\n", * }, * }, * { * liveAgentHandoff: { * metadata: " {\\\"some-metadata-key\\\": \\\"some-value\\\", \\\"other-metadata-key\\\": 1234}\n", * }, * }, * { * playAudio: { * audioUri: "http://example.com/some-audio-file.mp3", * }, * }, * { * telephonyTransferCall: { * phoneNumber: "1-234-567-8901", * }, * }, * ], * setParameterActions: [ * { * parameter: "some-param", * value: "123.45", * }, * { * parameter: "another-param", * value: JSON.stringify("abc"), * }, * { * parameter: "other-param", * value: JSON.stringify(["foo"]), * }, * ], * conditionalCases: [{ * cases: JSON.stringify([ * { * condition: "$sys.func.RAND() < 0.5", * caseContent: [ * { * message: { * text: { * text: ["First case"], * }, * }, * }, * { * additionalCases: { * cases: [{ * condition: "$sys.func.RAND() < 0.2", * caseContent: [{ * message: { * text: { * text: ["Nested case"], * }, * }, * }], * }], * }, * }, * ], * }, * { * caseContent: [{ * message: { * text: { * text: ["Final case"], * }, * }, * }], * }, * ]), * }], * }, * }], * form: { * parameters: [{ * displayName: "param1", * entityType: "projects/-/locations/-/agents/-/entityTypes/sys.date", * defaultValue: JSON.stringify("2000-01-01"), * fillBehavior: { * initialPromptFulfillment: { * messages: [ * { * channel: "some-channel", * text: { * texts: ["Please provide param1"], * }, * }, * { * payload: " {\\\"some-key\\\": \\\"some-value\\\", \\\"other-key\\\": [\\\"other-value\\\"]}\n", * }, * { * conversationSuccess: { * metadata: " {\\\"some-metadata-key\\\": \\\"some-value\\\", \\\"other-metadata-key\\\": 1234}\n", * }, * }, * { * outputAudioText: { * text: "some output text", * }, * }, * { * outputAudioText: { * ssml: " Some example SSML XML\n", * }, * }, * { * liveAgentHandoff: { * metadata: " {\\\"some-metadata-key\\\": \\\"some-value\\\", \\\"other-metadata-key\\\": 1234}\n", * }, * }, * { * playAudio: { * audioUri: "http://example.com/some-audio-file.mp3", * }, * }, * { * telephonyTransferCall: { * phoneNumber: "1-234-567-8901", * }, * }, * ], * setParameterActions: [ * { * parameter: "some-param", * value: "123.45", * }, * { * parameter: "another-param", * value: JSON.stringify("abc"), * }, * { * parameter: "other-param", * value: JSON.stringify(["foo"]), * }, * ], * conditionalCases: [{ * cases: JSON.stringify([ * { * condition: "$sys.func.RAND() < 0.5", * caseContent: [ * { * message: { * text: { * text: ["First case"], * }, * }, * }, * { * additionalCases: { * cases: [{ * condition: "$sys.func.RAND() < 0.2", * caseContent: [{ * message: { * text: { * text: ["Nested case"], * }, * }, * }], * }], * }, * }, * ], * }, * { * caseContent: [{ * message: { * text: { * text: ["Final case"], * }, * }, * }], * }, * ]), * }], * }, * repromptEventHandlers: [ * { * event: "sys.no-match-1", * triggerFulfillment: { * returnPartialResponses: true, * webhook: myWebhook.id, * tag: "some-tag", * messages: [ * { * channel: "some-channel", * text: { * texts: ["Please provide param1"], * }, * }, * { * payload: " {\\\"some-key\\\": \\\"some-value\\\", \\\"other-key\\\": [\\\"other-value\\\"]}\n", * }, * { * conversationSuccess: { * metadata: " {\\\"some-metadata-key\\\": \\\"some-value\\\", \\\"other-metadata-key\\\": 1234}\n", * }, * }, * { * outputAudioText: { * text: "some output text", * }, * }, * { * outputAudioText: { * ssml: " Some example SSML XML\n", * }, * }, * { * liveAgentHandoff: { * metadata: " {\\\"some-metadata-key\\\": \\\"some-value\\\", \\\"other-metadata-key\\\": 1234}\n", * }, * }, * { * playAudio: { * audioUri: "http://example.com/some-audio-file.mp3", * }, * }, * { * telephonyTransferCall: { * phoneNumber: "1-234-567-8901", * }, * }, * ], * setParameterActions: [ * { * parameter: "some-param", * value: "123.45", * }, * { * parameter: "another-param", * value: JSON.stringify("abc"), * }, * { * parameter: "other-param", * value: JSON.stringify(["foo"]), * }, * ], * conditionalCases: [{ * cases: JSON.stringify([ * { * condition: "$sys.func.RAND() < 0.5", * caseContent: [ * { * message: { * text: { * text: ["First case"], * }, * }, * }, * { * additionalCases: { * cases: [{ * condition: "$sys.func.RAND() < 0.2", * caseContent: [{ * message: { * text: { * text: ["Nested case"], * }, * }, * }], * }], * }, * }, * ], * }, * { * caseContent: [{ * message: { * text: { * text: ["Final case"], * }, * }, * }], * }, * ]), * }], * }, * }, * { * event: "sys.no-match-2", * targetFlow: agent.startFlow, * }, * { * event: "sys.no-match-3", * targetPage: myPage2.id, * }, * ], * }, * required: true, * redact: true, * advancedSettings: { * dtmfSettings: { * enabled: true, * maxDigits: 1, * finishDigit: "#", * }, * }, * }], * }, * transitionRoutes: [{ * condition: "$page.params.status = 'FINAL'", * triggerFulfillment: { * messages: [ * { * channel: "some-channel", * text: { * texts: ["information completed, navigating to page 2"], * }, * }, * { * payload: " {\\\"some-key\\\": \\\"some-value\\\", \\\"other-key\\\": [\\\"other-value\\\"]}\n", * }, * { * conversationSuccess: { * metadata: " {\\\"some-metadata-key\\\": \\\"some-value\\\", \\\"other-metadata-key\\\": 1234}\n", * }, * }, * { * outputAudioText: { * text: "some output text", * }, * }, * { * outputAudioText: { * ssml: " Some example SSML XML\n", * }, * }, * { * liveAgentHandoff: { * metadata: " {\\\"some-metadata-key\\\": \\\"some-value\\\", \\\"other-metadata-key\\\": 1234}\n", * }, * }, * { * playAudio: { * audioUri: "http://example.com/some-audio-file.mp3", * }, * }, * { * telephonyTransferCall: { * phoneNumber: "1-234-567-8901", * }, * }, * ], * setParameterActions: [ * { * parameter: "some-param", * value: "123.45", * }, * { * parameter: "another-param", * value: JSON.stringify("abc"), * }, * { * parameter: "other-param", * value: JSON.stringify(["foo"]), * }, * ], * conditionalCases: [{ * cases: JSON.stringify([ * { * condition: "$sys.func.RAND() < 0.5", * caseContent: [ * { * message: { * text: { * text: ["First case"], * }, * }, * }, * { * additionalCases: { * cases: [{ * condition: "$sys.func.RAND() < 0.2", * caseContent: [{ * message: { * text: { * text: ["Nested case"], * }, * }, * }], * }], * }, * }, * ], * }, * { * caseContent: [{ * message: { * text: { * text: ["Final case"], * }, * }, * }], * }, * ]), * }], * }, * targetPage: myPage2.id, * }], * advancedSettings: { * dtmfSettings: { * enabled: true, * maxDigits: 1, * finishDigit: "#", * }, * }, * knowledgeConnectorSettings: { * enabled: true, * triggerFulfillment: { * messages: [ * { * channel: "some-channel", * knowledgeInfoCard: {}, * }, * { * channel: "some-channel", * text: { * texts: ["information completed, navigating to page 2"], * }, * }, * { * payload: " {\\\"some-key\\\": \\\"some-value\\\", \\\"other-key\\\": [\\\"other-value\\\"]}\n", * }, * { * conversationSuccess: { * metadata: " {\\\"some-metadata-key\\\": \\\"some-value\\\", \\\"other-metadata-key\\\": 1234}\n", * }, * }, * { * outputAudioText: { * text: "some output text", * }, * }, * { * outputAudioText: { * ssml: " Some example SSML XML\n", * }, * }, * { * liveAgentHandoff: { * metadata: " {\\\"some-metadata-key\\\": \\\"some-value\\\", \\\"other-metadata-key\\\": 1234}\n", * }, * }, * { * playAudio: { * audioUri: "http://example.com/some-audio-file.mp3", * }, * }, * { * telephonyTransferCall: { * phoneNumber: "1-234-567-8902", * }, * }, * ], * webhook: myWebhook.id, * returnPartialResponses: true, * tag: "some-tag", * setParameterActions: [{ * parameter: "some-param", * value: "123.45", * }], * conditionalCases: [{ * cases: JSON.stringify([ * { * condition: "$sys.func.RAND() < 0.5", * caseContent: [{ * message: { * text: { * text: ["First case"], * }, * }, * }], * }, * { * caseContent: [{ * message: { * text: { * text: ["Final case"], * }, * }, * }], * }, * ]), * }], * advancedSettings: { * speechSettings: { * endpointerSensitivity: 30, * noSpeechTimeout: "3.500s", * useTimeoutBasedEndpointing: true, * models: { * name: "wrench", * mass: "1.3kg", * count: "3", * }, * }, * dtmfSettings: { * enabled: true, * maxDigits: 1, * finishDigit: "#", * interdigitTimeoutDuration: "3.500s", * endpointingTimeoutDuration: "3.500s", * }, * loggingSettings: { * enableStackdriverLogging: true, * enableInteractionLogging: true, * enableConsentBasedRedaction: true, * }, * }, * enableGenerativeFallback: true, * }, * dataStoreConnections: [{ * dataStoreType: "PUBLIC_WEB", * dataStore: pulumi.all([project, agent.location]).apply(([project, location]) => `projects/${project.number}/locations/${location}/collections/default_collection/dataStores/datastore-page-full`), * documentProcessingMode: "CHUNKS", * }], * targetPage: myPage2.id, * }, * }); * const myDatastore = new gcp.discoveryengine.DataStore("my_datastore", { * location: "global", * dataStoreId: "datastore-page-full", * displayName: "datastore-page-full", * industryVertical: "GENERIC", * contentConfig: "NO_CONTENT", * }); * ``` * * ## Import * * Page can be imported using any of these accepted formats: * * * `{{parent}}/pages/{{name}}` * * * `{{parent}}/{{name}}` * * When using the `pulumi import` command, Page can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:diagflow/cxPage:CxPage default {{parent}}/pages/{{name}} * ``` * * ```sh * $ pulumi import gcp:diagflow/cxPage:CxPage default {{parent}}/{{name}} * ``` */ export declare class CxPage extends pulumi.CustomResource { /** * Get an existing CxPage resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: CxPageState, opts?: pulumi.CustomResourceOptions): CxPage; /** * Returns true if the given object is an instance of CxPage. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is CxPage; /** * Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. * Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. * Structure is documented below. */ readonly advancedSettings: pulumi.Output; /** * The human-readable name of the page, unique within the agent. */ readonly displayName: pulumi.Output; /** * The fulfillment to call when the session is entering the page. * Structure is documented below. */ readonly entryFulfillment: pulumi.Output; /** * Handlers associated with the page to handle events such as webhook errors, no match or no input. * Structure is documented below. */ readonly eventHandlers: pulumi.Output; /** * The form associated with the page, used for collecting parameters relevant to the page. * Structure is documented below. */ readonly form: pulumi.Output; /** * Knowledge connector configuration. * Structure is documented below. */ readonly knowledgeConnectorSettings: pulumi.Output; /** * 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. */ readonly languageCode: pulumi.Output; /** * The unique identifier of the page. * Format: projects//locations//agents//flows//pages/. */ readonly name: pulumi.Output; /** * The flow to create a page for. * Format: projects//locations//agents//flows/. */ readonly parent: pulumi.Output; /** * 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/. */ readonly transitionRouteGroups: pulumi.Output; /** * 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. */ readonly transitionRoutes: pulumi.Output; /** * Create a CxPage resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: CxPageArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering CxPage resources. */ export interface CxPageState { /** * Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. * Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. * Structure is documented below. */ advancedSettings?: pulumi.Input; /** * The human-readable name of the page, unique within the agent. */ displayName?: pulumi.Input; /** * The fulfillment to call when the session is entering the page. * Structure is documented below. */ entryFulfillment?: pulumi.Input; /** * Handlers associated with the page to handle events such as webhook errors, no match or no input. * Structure is documented below. */ eventHandlers?: pulumi.Input[]>; /** * The form associated with the page, used for collecting parameters relevant to the page. * Structure is documented below. */ form?: pulumi.Input; /** * Knowledge connector configuration. * Structure is documented below. */ knowledgeConnectorSettings?: pulumi.Input; /** * 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. */ languageCode?: pulumi.Input; /** * The unique identifier of the page. * Format: projects//locations//agents//flows//pages/. */ name?: pulumi.Input; /** * The flow to create a page for. * Format: projects//locations//agents//flows/. */ parent?: pulumi.Input; /** * 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/. */ transitionRouteGroups?: pulumi.Input[]>; /** * 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. */ transitionRoutes?: pulumi.Input[]>; } /** * The set of arguments for constructing a CxPage resource. */ export interface CxPageArgs { /** * Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. * Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. * Structure is documented below. */ advancedSettings?: pulumi.Input; /** * The human-readable name of the page, unique within the agent. */ displayName: pulumi.Input; /** * The fulfillment to call when the session is entering the page. * Structure is documented below. */ entryFulfillment?: pulumi.Input; /** * Handlers associated with the page to handle events such as webhook errors, no match or no input. * Structure is documented below. */ eventHandlers?: pulumi.Input[]>; /** * The form associated with the page, used for collecting parameters relevant to the page. * Structure is documented below. */ form?: pulumi.Input; /** * Knowledge connector configuration. * Structure is documented below. */ knowledgeConnectorSettings?: pulumi.Input; /** * 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. */ languageCode?: pulumi.Input; /** * The flow to create a page for. * Format: projects//locations//agents//flows/. */ parent?: pulumi.Input; /** * 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/. */ transitionRouteGroups?: pulumi.Input[]>; /** * 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. */ transitionRoutes?: pulumi.Input[]>; }