Prebuilt components are a collection of prebuilt flows provided by Dialogflow CX for common tasks and scenarios. You can use them to accelerate development for both new and existing agents.
There are two types of prebuilt components:
- Building blocks: components that collect specific parameters, such as name and address.
- Use cases: components that represent larger user journeys, such as making a payment, which use one or more building blocks.
Prebuilt component flows include intents and entities that are ready to use. For components that require integrations with external services, you must modify the configuration of the flexible webhooks to integrate with the appropriate endpoints.
The following building block components are available:
- Address collection
- Alphanumeric collection
- Credit card CVV collection
- Credit card expiration date collection
- Credit card number collection
- Date of birth collection
- Feedback
- Greeting
- Name collection
- Numeric collection
- Telephone number collection
- Waiting room
- ZIP code collection
The following use case components are available:
- Account balance
- Account statement
- Arrange appointment
- Authentication
- Cancel order
- Credit card enrollment
- Credit card statement
- Disputes
- Exchange order
- Financial services steering
- Lock card
- Lost and stolen card
- Make a payment
- Offers and deals
- Open account
- Order status
- Retail authentication
- Retail fraud and dispute
- Return and refund
- Telecommunications steering
- Transaction history
Limitations
The following limitations apply:
- Prebuilt components support English (en).
Import a prebuilt component
If your project is within a VPC Service Controls perimeter (VPC-SC), you can add an egress rule that lets traffic out from the perimeter to the Google-owned Google Cloud Storage bucket where later versions of prebuilt components are stored. For more information, see Import a prebuilt component in the VPC Service Controls.
To import a prebuilt component to your project:
- Go to the Dialogflow CX console.
- Choose your Google Cloud project.
- Select your agent or create a new agent.
- Select the Manage tab.
- Click Prebuilt in the Manage panel.
- Select the component of interest and click Import as flow.
- Check the corresponding component-specific documentation to determine whether additional setup for webhook is needed.
- Start testing and customizing.
VPC Service Controls
If your project is within a VPC Service Controls (VPC-SC) perimeter, you can add an egress rule to import the latest versions of prebuilt components from the external Google-hosted Google Cloud Storage bucket where they're stored.
If your VPC-SC rules prevent egress to the Google-hosted bucket, you can receive an error message on import that contains "Permission denied while accessing Google Cloud Storage URI 'gs://gassets-api-ai/prebuilt_components/cx-standard-prebuilt-components/resource-name'".
To import the component, create an
egress rule
that lets traffic access the specified Google Cloud project containing the
Google Cloud Storage bucket gs://gassets-api-ai.
The following attributes describe the resource and operations to enable import from the Google-owned resource:
- Resource:
projects/921279757870 - Service Name:
storage.googleapis.com - Method:
google.storage.objects.get
Customizations and settings
To customize the component and improve settings, complete the following steps:
- Edit agent responses and custom entities to meet your business needs.
- For voice agents, apply these speech settings:
- Change the STT model to
latest_shortby following Change STT model. To see which features are supported by this model for a particular language, check Speech-to-Text supported languages. - Enable auto speech adaptation.
- Change the STT model to
- If you use a telephony integration that lets you extract parameter values from telephone keypad presses, enable DTMF for telephony integrations.
- Test the agent using the simulator.
- Test your component over voice using Dialogflow CX Phone Gateway.
Handle exit events
When a prebuilt component completes a task successfully, it exits with the
END_FLOW symbolic transition target.
When a prebuilt component cannot complete a task, it emits the following events for the calling page that caused the transition to the prebuilt component flow. Handle these events in your agent by creating the corresponding event handlers in the calling page.
For more information, see built-in events:
flow-cancelledflow-failedflow-failed-human-escalation
Additional features
Some prebuilt components have additional features. See the component-specific documentation to check which features are implemented for a particular component.
Repeat functionality
If you have difficulty understanding the virtual agent or don't hear a response, you can ask the virtual agent to repeat the last prompt.
Sample utterances:
- What did you just say?
- Say it again.
- Can you repeat?
- Pardon.
Waiting room functionality
If you want to take a minute to get back to the agent and don't have an immediate answer to a prompt, you can ask the virtual agent to hold. When you're ready to continue the conversation, you can tell the agent "I'm ready" to resume the conversation. The waiting room feature is enabled in some prebuilt components by calling the waiting room prebuilt component.
The waiting room feature can also be enabled anywhere in the agent by following the setup instructions. For more information, see the Waiting room prebuilt component overview.
Sample utterances:
- Wait.
- Wait a second.
- Hold, let me check.
- I'm checking, wait.
- I'm ready now.
Playback functionality
Ask the agent to play back the information to see what it's collected so far. The agent then plays back the currently captured parameters.
Sample utterances:
- Play back.
- Play it back.
- Read it back.
- Read that back to me.
Common intents
Common intents provide shared behaviors across multiple prebuilt components.
| Common Intents | Description |
|---|---|
| prebuilt_components_confirmation_yes | Positive phrases used to express affirmation, assent, or to mark the addition of something emphasizing and amplifying a statement in response to a question or request. |
| prebuilt_components_confirmation_no | Negative phrases used to express dissent, denial, or refusal in response to a question or request. |
| prebuilt_components_confirmation_done | Phrases used to express that you are done with a task or request. |
| prebuilt_components_escalate_human_agent | Phrases used to request that the virtual agent connect you to a human agent. |
| prebuilt_components_start_over | Phrases used to request that the entire experience starts over from the beginning. |
| prebuilt_components_playback | Specific phrases to request that the currently collected input is played back to you so that you can give confirmation. |
| prebuilt_components_replay | Phrases used to request that the previous prompt is said again. |
| prebuilt_components_waiting_room | Phrases used to express the need for time to review, find, or provide information in response to a question or request. |
| prebuilt_components_ready | Phrases used to notify the virtual agent that you want to continue an action. |