# Dialogflow ![Figure 1: The Dialogflow module in use.](https://820663326-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M40QJ5NXmtM4utV6bD_%2Fuploads%2Fjp1m7wNzdPqtXRT4E4jW%2Fdialogflow-intro.png?alt=media\&token=b6de0405-d7cc-4f07-8ac8-38a50e66b44b) {% hint style="warning" %} **IMPORTANT:** This is an advanced module. Some setup is required before use. {% endhint %} ## Function This module uses the supported third-party service Google Dialogflow. The module allows you to integrate a Dialogflow voice agent into your application to interact with callers. You can select and use any Dialogflow integration that has been added to your Fuse account. {% hint style="info" %} **NOTE:** Integrations are shared with all users in a Fuse account. You can always check existing integrations by going to the **My Account** page and viewing the **Integrations** tab. {% endhint %} ## Prerequisites To use this module, you must have access to Google Dialogflow. You must also have a working Dialogflow voice agent added as an integration to your Fuse account. Complete the following in order: #### In Google Dialogflow: 1. Get access to Google Dialogflow. ([Dialogflow website](https://cloud.google.com/dialogflow)) 2. Build your own working, custom voice agent. ([Google Documentation](https://cloud.google.com/dialogflow/docs))\ (Optional) You may also use a prebuilt voice agent instead. ([Google Documentation](https://cloud.google.com/dialogflow/es/docs/agents-prebuilt)) 3. Set up a service account and service account key for your agent. ([Guide](https://docs.plumvoice.com/fuse/setting-up-authentication#google-dialogflow)) #### In Fuse: 1. **Admin-only task:** [Add your voice agent as an integration in the My Account page](https://docs.plumvoice.com/fuse/my-account/admin-options#add-an-integration-admin). Once finished, the

Dialogflow module can be used successfully. ## Input Fields As shown in Figure 2, the following fields are available: 1. **Select Integration**: Select one of your Dialogflow integrations. 2. **Select Environment**: Select a Dialogflow environment. List options are retrieved from Google Dialogflow based on the selected integration. 3. **Prompt field**: Enter a message that you want your voice agent to read when it starts. This field accepts strings and/or variables. ![Figure 2: Dialogflow module fields.](https://820663326-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M40QJ5NXmtM4utV6bD_%2Fuploads%2FCB7rshU2vxOlZo57bbVi%2Fdialogflow-base-fields.png?alt=media\&token=8a7c7639-034d-4fc4-ad32-d52e4404497a) ### Shadow Variables (Dialogflow only) The Dialogflow module also supports the following shadow variables:

Shadow variable	Returns
`name$.query`	`string` End-user input received by Dialogflow.
`name$.intent`	`string` Intent matched to the received end-user input.
`name$.message`	`string` Text of the response spoken or displayed to the end-user based on the matched intent.
`name$.entities`	`object` Entity types associated with the matched intent.
`name$.confidence`	`integer` Confidence level for the name field.
`name$.allRequiredParamsPresent`	`boolean` Returns `true` when: All required parameter values have been collected OR The matched intent contains no required parameters. Returns `false` when: The matched intent has required parameters AND One or more required parameter values have not been collected.

See [Shadow Variables](https://docs.plumvoice.com/fuse/variables/shadow-variables) for more information on this variable type in general. ## Module Settings ![Figure 3: Module settings for Dialogflow.](https://820663326-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M40QJ5NXmtM4utV6bD_%2Fuploads%2FCB7rshU2vxOlZo57bbVi%2Fdialogflow-base-fields.png?alt=media\&token=8a7c7639-034d-4fc4-ad32-d52e4404497a) ### [Hold Music](https://docs.plumvoice.com/fuse/module-settings#hold-music) | ![](https://820663326-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M40QJ5NXmtM4utV6bD_%2Fuploads%2FA3dIvYB3p2kNOEOrewsb%2Fsettings-holdmusic.png?alt=media\&token=f733651d-091f-4b33-95c7-4249fe1d5e51) |

Enable this setting to play audio while an end-user is on hold.
To upload a file for hold music, go to Application Settings > Connection Settings > Webservices > Webservice fetch audio.

This allows users to set the maximum time, in seconds, that elapse before returning a timeout error. This applies to modules that fetch outside scripts, like the SOAP, REST, or subdialog modules.

The default value for Timeout Length is 30 seconds.
Acceptable number values range from 1 to 120.

This setting controls the logging function of a module.
Enabling the 'Private' setting instructs the module to not record, report, or retain the information input to that module for reporting or any other purposes. When enabled any information entered into a module during a call will be lost immediately when the call terminates.
The 'Private' setting is critical for businesses that need to maintain PCI-DSS or HIPAA compliance.

The module icon, in the upper left-hand corner, becomes grayed-out when this setting is enabled. See more details here.

This setting allows callers to interrupt a prompt before it finishes playing.
When enabled, DTMF input interrupts the prompt and progresses the call forward in the call-flow. If speech recognition is enabled on the ensuing module in the call-flow, then end-users can also interrupt the prompt with a spoken utterance, too. Disabling barge-in forces callers to listen to the entire prompt.

A barge-in enabled module will have a dashed line on top of the text box. See example here.

Enabling this setting overrides the default, global error options set in the Application Settings > User Input Settings.
This allows users to establish custom error handling in order to act on errors in a specific way in that module.
Instead of progressing to the next module in the call-flow, custom error handling allows users to re-prompt the same module, to provide a custom error message, to re-direct the call based on the error, or any other desired behavior.

Adding multiple errors () to a module functions behave the same way as a counter.
The first error follows the path for the first error listed, if a second error occurs in the same module it follows the second listed error, and so on until all errors are exhausted or an error directs the end-user away from that module.

No Input occurs when the caller does not provide an input based on the timeout settings.
This is based on the “Initial input timeout” in User Input Settings.

No Match occurs when the caller input does not match the module's criteria for the input module.

| | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |