Voice Input Action
Last updated
Last updated
This action will hold the conversation and wait for the user to send a valid voice message. The conversation will hold until the user send the required message or, when allowed, skips the question.
The action uses the following settings:
Setting | Description | |
Recognition Service | The service that will be used by Xenioo to translate the text. Currently only Google Speech-to-Text service is supported. | |
Language | The language of the incoming voice recording | |
API or Service Key | The full API Key or Service Key supplied by the Recognition Service for integration. | |
Detection Mode | Select the input text detection mode to be either an intent or expression based | |
Wrong Answer Reply | This is the text that will be displayed if the user input does not match the control expression | |
Max Wrong Answers | The maximum number of wrong inputs the user can send before the question is skipped. Set to 0 (zero) to never give up on wrong inputs. | |
Control Expression | A simple text or full Regular Expression match string | |
Allow simple text input | If enabled the user can choose to write the answer directly instead of sending a recorded voice message | |
Target Variable | The runtime variable that will contain the full user input that matched the control expression | |
Never Skip Question | The question cannot be skipped by user. The input will repeat indefinitely until the control expression is matched or the maximum number of wrong inputs is reached | |
Intent Skip Question | The user can skip the question if his reply matches a specific intent | |
Text Skip Question | The user can skip the question if his reply matches a specific text or Regular Expression |
This action is halting the conversation. The chatbot is halted at the input point and will not proceed unless the conditions specified in the settings are met.
Text detection can happen in two different ways: using simple text or using a Regular Expression.
Simple text The text you enter in Control Expression is directly matched with the user input. For example entering this is awesome will match any sentence containing that exact text. You can use a pipe (|) symbol to match multiple sentences. So to match this is awesome and this is great, you can enter this is awesome|this is great in Control Expression.
Regular Expression Xenioo supports standard Regular Expression notation. The input text will be matched against the regular expression specified in Control Expression.
Regardless or the selected method, text detection is always case insensitive.
If the maximum number of wrong answers is reached the Successful User Input will still be triggered: you should check the contents of your Target Variable to verify if the input was successful or not.
Recorded speech is stored inside your account storage and can be accessed directly from the conversation.
Successful User Input. This action will trigger any child operation as soon as the user input is matching the specified Control Expression.
This action produces the following variables after being triggered:
Variable | Description |
last_detected_intent | The name of the detected intent |
detected_locale | The locale of the detected intent |
input_fail_count | The number of times the user has failed to match the control expression |
input_fail_triggered | True if the maximum number of wrong inputs has been reached. Otherwise empty. |
Channel specific availability follows the table below:
Channel | Availability |
Fully Available. | |
Fully Available. | |
Telegram | Fully Available. |
Web | Not Available. |
Alexa | Not Available. Alexa does not allow direct input halting. |
Google Assistant | Not Available. |
Slack | Not Available. |
API | Fully Available. |
This action can be used only inside interactions and not as child of other actions.
