Carousel user input control
-
- UpdatedJan 18, 2024
- 6 minutes to read
- Vancouver
- Virtual Agent
Use the Carousel user input control in a Virtual Agent topic to present a prompt and a horizontal series of labeled images. The user can select a single item from the carousel.
Carousel input control properties for LLM topic discovery
| Property | Description |
|---|---|
| Node name | Name that identifies this Carousel user input control node in the topic flow. |
| Variable name | Name of the variable that stores the selection made by the user. The variable name is automatically created from the Node name property. |
| Detail description | Description of the information that you need from users. |
| Define carousel items | Use a script to create items for selection in your carousel. The script should return an array containing one or more items. See the Example carousel item expression section in this topic. |
| Advanced | |
| Enforce user prompt | |
| Enforce user prompt | Toggle to open the User prompt field. The value in the User prompt field is shown to users rather than the LLM-generated message. You can create custom messages using plain language, scripts, or define conditions with the data pill picker. |
| Hide this node | |
| Conditionally show this node if | No-code condition statement or low-code script that specifies a condition for presenting this node in the conversation. The condition must evaluate to true. |
Example Carousel input control for LLM topic discovery
| Carousel properties | Carousel prompt |
|---|---|
|
|
Carousel input control properties for NLU topic discovery
| Property | Description |
|---|---|
| Node name | Name that identifies this Carousel user input control node in the topic flow. |
| Variable name | Name of the variable that stores the selection made by the user. The variable name is automatically created from the Node name property. |
| Prompt | Prompt or question for the user. The prompt can be either a text string or a script that returns text. This value is used only when the default value is not specified. For example: What's your name? |
| NLU entity | Option to associate an NLU entity with the node. If an NLU entity is associated with the input variable for this node, Virtual Agent can slot-fill the specified value based on the user's utterance. Select an entity from the list of entities associated with the topic intent. When you specify an entity for the node, the Do not ask users to confirm recognized entity toggle switch displays. When enabled, users are not prompted to confirm the extracted entity. This field is available only when NLU discovery is enabled on the instance. |
| Define carousel items | Use a script to create items for selection in your carousel. The script should return an array containing one or more items. See the Example carousel item expression section in this topic. |
| No records response message | Message to the user indicating that no records were found. The message can be either a text string or a script that returns text. |
| Advanced | |
| Default value | |
| Default value | Predefined value for the user response to the question or prompt. The response defined in the Default value confirmation field asks the user to confirm the default value. If the user responds with no, the value becomes null. The default value can be either a text string or a script that returns text. For example, if you're using dot-walking, the default value might be: Script Variables > Last username. Or if you're using a script, the default value might be: {{vaScripts.lastUsername}}. |
| Confirmation messages | |
| Input completion confirmation | Bot response shown to the user when the node interaction is complete. The message can be either a text string or a script that returns text. For example, if you're using dot-walking: Thanks, (Input Variables > Username)! Or if you're using a script, the acknowledgment might be: Thanks, {{vaInputs.username}}!. |
| Default value confirmation | Message that asks the user to verify that the value in the Default value field is correct. This message is used instead of a value in the Prompt field. It can contain either a text string or a script that returns text. For example, if you're using dot-walking: Are you (Input Variables > Username)? Or if you're using a script, the confirmation message might be: Are you {{vaScripts.lastUsername}}?. |
| Conversation switching | |
| This section is available only when NLU discovery is enabled on the instance. | |
| Turn on to let users change the subject | Option to enable NLU prediction for this node. If enabled, users can enter text to answer questions, regardless of the type of input control being used. Virtual Agent uses this utterance to match another existing intent, letting the user switch topics. |
| Hide or skip this node | |
| Conditionally show this node if | No-code condition statement or low-code script that specifies a condition for presenting this node in the conversation. The condition must evaluate to true. |
| Allow user to skip this node if | No-code condition statement or low-code script that specifies a condition for letting users skip this node in the conversation. |
Example Carousel input control for NLU topic discovery
| Carousel properties | Carousel prompt |
|---|---|
|
|
|
Example carousel item expression
The script in the Carousel Item Expression property defines and returns an array containing the items that appear in your carousel. The elements of this array must contain Name,
Value, and Body keys. In the example, the script creates an array called options and adds two elements, each with the required keys. The images here are hard-coded as an
example.