# Prompt node - Revamp

---
title: Prompt Nodes
sidebar_label: Prompts
---

Prompts are interactive or conversational nodes that expect user input. When a user provides an invalid input to the prompt, a fallback message will be displayed.

In this article, you will learn about the different types of prompt nodes:
1. [Frequently used prompts](#used)
2. [Other prompts](#others)
3. [Make prompt smarter](#smarter)

> All these prompts must be followed by another node as a response to this node.

---

Randomization is a feature available in nodes that can ask questions or display text. It allows chatbots show different variation of greeting messages/ questions to users, making the conversation feel more natural and human-like.

1. To add multiple texts, click **Add multiple text for randomizing** on the node.
2. Enter variations of the text that you want your users to see.

---

**Format the text displayed on the bot**

To know more about formatting(bold,italicize,etc) the text on the bot, click [here](https://docs.yellow.ai/docs/cookbooks/studio/text-format).

**Delay**

You can set a delay in displaying each of these nodes.

**Fetch from**

A Fetch from field will be provided to most of the fields, this field


---

## <a name="ud"></a> 1. Frequently used promts

### 1.1 Question

> This node is available for voice bots.

Ask a simple question with this node.


Click **Fetch from** to see the dynamic value. You can edit the value of the question by entering the code.

{
  "type": "text",
  "value": "What is your query?"
}

---
### 1.2 Name

> This node is available for voice bots.

Ask and validate the user name with this node.

**Validator**

In the **If validation fails field**, enter the message to be displayed when the user enters an invalid response.

For example, if users enter anything instead of their names(first + last name), validation will fail and the bot will display ‘Can you please repeat this, looks like an invalid name’.

:::note
If you are building a multilingual bot, it's recommended to use a Question node instead of a Name node.
:::


[To store this response in a variable](https://docs.yellow.ai/docs/platform_concepts/studio/build/bot-variables#41-store-variables), create a Name [Variable](https://docs.yellow.ai/docs/platform_concepts/studio/build/bot-variables) and store the user name in it.


---

### 1.3 Phone

> This node is available for voice bots.

Ask and validate phone numbers with this node. If the bot is customised for a specific region, select a **default ISD** value.

In the **If validation fails field**, enter the message to be displayed when the user enters an invalid response.

For example, if users enters a number of length greater or less than the expected number (10 for India +91), validation fails and the bot replies, 'Enter a valid phone number'.


:::info
One phone node can only support validation of one country code.
:::

[To store this response in a variable](https://docs.yellow.ai/docs/platform_concepts/studio/build/bot-variables#41-store-variables), create a Phone [Variable](https://docs.yellow.ai/docs/platform_concepts/studio/build/bot-variables) and store the phone number in it.

---

### 1.4 Quick Replies

Display a question along with quick reply buttons as the response for this node.Users can send their response by either clicking the buttons or manually typing them out.

You can connect each quick reply to a flow that should be triggered when this button is clicked. You can also configure fallback, which will work when none of the quick replies are validated from the user's input.


You can customize these buttons. To do so, click **Configure buttons**.

<img src="https://i.imgur.com/HlAIlst.png" alt="drawing" width="80%"/>

* **Button value** - This refers to the value that a button will hold if configured, which can either be stored in a variable or inserted into a database.
* **Text aliases**: Other phrases users can type which means the same as the text in the button, for example number can also be typed as num. or no.
* **Link and Postback**: On clicking this button, the users will be redirected to this link.
* **Prefix Image**: Image icon that you want to show for the button.


#### Dynamic Quick Replies

In the above method to add quick replies you had to add each button yourself. You can also generate options from an API response or Database query where you either don't know what will be the option or the number of options can change from where you want to fetch it from.

In such cases, you need to dynamically generate quick replies. To do this, we have a **Fetch from** option in the quick reply prompt.


Here, instead of adding quick replies manually, you can select a variable containing a quick reply object. Format of quick reply object:

{
  "title": [
    "Select an option",
    "Pick an option"
  ],
  "options": [
    {
      "text": "cold drink",
      "title": "Cold Drink",
      "advancedSettings": true,
      "aliases": [
        "coke",
        "soft drink"
      ],
      "url": "https://www.tasty-food.com",
      "postback": "post-back",
      "image": "https://cdn.abc.com/coke-img.jpeg",
      "textColor": "#4384f5",
      "backgroundColor": "#FFFF",
      "id": "quick_01d78e38b44e1915",
      "analytics": {
        "aevent": "test-analytics"
      }
    },
    {
      "text": "",
      "title": "Btn #2",
      "advancedSettings": false,
      "id": "quick_d9eda393404266d4"
    },
    {
      "text": "",
      "title": "Btn #3",
      "advancedSettings": false,
      "id": "quick_39563a54f6889f4d"
    }
  ]
}

To dynamically generate quick replies, you can apply any logic in code (functions) around quick replies and store the value of the final object in an intended [variable](https://docs.yellow.ai/docs/platform_concepts/studio/build/bot-variables#-1-variables). For example, you can apply for a loop around options to dynamically add to them while parsing through some API responses etc.

### 1.5 Email

Ask, validate and store the user's email with this node.


**Validator**

Bot checks if the entered email is in [e-mail] format.

[To store the resopnse](https://docs.yellow.ai/docs/platform_concepts/studio/build/bot-variables#41-store-variables) (email address) in a variable, create an email [Variable](https://docs.yellow.ai/docs/platform_concepts/studio/build/bot-variables) and store the email ID in it.

---

### 1.6 Carousel

Display interactive carousel cards with buttons with this node. Carousel can be used in places like displaying a list of products.


Carousel response contains an option to add an image (less than 10MB), title, and description.
You can also add multiple buttons to a carousel. Clicking on the button can display a text, another flow, a URL entered, or will be sent to the phone number. Configure this in the Carousel settings.

:::info
On WhatsApp, carousel cards do not support hyperlinking and allow for up to 3 clickable buttons.
:::


:::note
Carousels without buttons will act as Messages instead of Prompts.
:::

**Success** and **Fallback** cases must be handled by connecting them to other nodes to continue the flow.

#### Dynamic Carousels

Similar to quick replies, Carousels can also be dynamically created using **Fetch from** option. Carousel object is an array of each card (JSON objects). Sample Carousel object:

[
  {
    "title": "Item1",
    "description": "Description",
    "actions": [
      {
        "title": "Button #1",
        "buttonDefault": "text",
        "text": "Message1"
      },
      {
        "title": "Button #2",
        "buttonDefault": "triggerJourney",
        "analytics": "analytics",
        "triggerJourney": "test"
      },
      {
        "title": "Button #3",
        "buttonDefault": "url",
        "analytics": "analytics",
        "url": "https://www.sample-site.com",
        "postback": "post-back"
      },
      {
        "title": "Button #4",
        "buttonDefault": "phoneNumber",
        "analytics": "test-analytics",
        "phoneNumber": "9876543210"
      }
    ],
    "image": "https://cdn.abc.com/sample-img.jpeg",
    "text": "Description for item1"
  },
  {
    "title": "Title",
    "description": "Description",
    "actions": [
      {
        "title": "Button #1"
      },
      {
        "title": "Button #2"
      }
    ],
    "image": "",
    "video": "",
    "text": ""
  }
]

The actions above describe the card button. You can add multiple actions to a single card in a carousel.

For example, to add a URL type action, the format becomes:

    {
        "title": "Explore more",
        "buttonDefault": "url",
        "url": "https://sampleurl.com",
    }                

**Sample dynamic function to add carousels**

You can call this function from the [function node](https://docs.yellow.ai/docs/platform_concepts/studio/build/code) and store the returning value in a variable.

return new Promise(resolve => {
    // Your logic goes here
    let cars = data.variables.cars_h; //this bot variable contains an API response
    let cars_cards = []; 

    for (let i = 0; i < cars.length; i++) {
        
            cars_cards.push({
                "title": cars[i].model,

                "actions": [
                    {
                        "title": "Explore more",
                        "buttonDefault": "text",
                        "text": cars[i].model,

                    }
                ],
                "image": cars[i].main_img,
                // "video" : "",
                // "text" : "Desc1",

            });

    }

    return resolve(cars_cards);
});

---

## <a name="feature"></a> 2. Other prompts

### 2.1 Date

Users will be able to select a date on the calendar widget with this node. If the user input contains a date or a time, it will pass the validator. Else the specified validation fail message will be sent.

**Widget type** is optional. Users can also choose to type in their response.


:::info
This node is supported only on Web and Mobile apps.
:::

Different types of date pickers are available to be displayed to the users. The following is an example of a **Single Date Picker**.


[**Storing date variables**](https://docs.yellow.ai/docs/platform_concepts/studio/build/bot-variables#41-store-variables): Post validation, the entered date by the users will be stored in the specified variable as an object.

The structure of the object is as follows:

**Store date for a single value**

{
    "value": {
        "timestamp": "2021-09-08T00:00:00.000Z",
        "year": 2021,
        "month": 8,
        "date": 8,
        "day": "Sunday",
        "hour": 0,
        "minute": 0
    },
    "range": {
        "exists": false
    }
}

**Store date for a date range**

{
    "value": {
        "timestamp": "2021-09-08T00:00:00.000Z",
        "year": 2021,
        "month": 8,
        "date": 8,
        "day": "Sunday",
        "hour": 0,
        "minute": 0
    },
    "range": {
        "exists": false
    }
}

---

### 2.2 WhatsApp List

This node lets you configure the lists displayed on the WhatsApp channel. WhatsApp API provides a better UI for businesses to send List items (within 24 hours window).

To create a WhatsApp List:

1. Select **WhatsApp List** under P**rompt Nodes**.
2. Populate the fields **Message Body**, **Title** and **Row**.
3. To provide row details, click a row and populate the fields **Title**, **Value** and **Description**.


**Dynamic WA List**

Enable **Advanced options** and `i` option next to **fetch from** to see the dynamic data. Dynamic data helps you to generate options from an API response or Database query where you either don’t know what will be the option or the number of options that can change from where you can retrieve it.

{
  "title": "Please select your preferred slot for Appointment",
  "optionText": "Appointment Slots",
  "options": [
    {
      "section": "June 5, 2021",
      "options": [
        {
          "title": "9am-11am",
          "text": "5.9-5",
          "description": "General Medicine"
        },
        {
          "title": "12pm-2pm",
          "text": "5.12-2",
          "description": "Orthopedic"
        },
        {
          "title": "2pm-4pm",
          "text": "5.2-4",
          "description": "Physiotherapy"
        }
      ]
    },
    {
      "section": "June 6, 2021",
      "options": [
        {
          "title": "9am-11am",
          "text": "6.9-5",
          "description": "General Medicine"
        },
        {
          "title": "12pm-2pm",
          "text": "6.12-2",
          "description": "Orthopedic"
        },
        {
          "title": "2pm-4pm",
          "text": "6.2-4",
          "description": "Physiotherapy"
        }
      ]
    },
    {
      "section": "June 7, 2021",
      "options": [
        {
          "title": "9am-11am",
          "text": "7.9-5",
          "description": "General Medicine"
        },
        {
          "title": "12pm-2pm",
          "text": "7.12-2",
          "description": "Orthopedic"
        },
        {
          "title": "2pm-4pm",
          "text": "7.2-4",
          "description": "Physiotherapy"
        }
      ]
    }
  ],
  "footer": "Please follow Covid Guideline while consulting."
}

**Limitations**

* Maximum of 10 Buttons can be added. Multiple buttons cannot be selected in one go and are not supported in notifications.
* Character limit of Body is 1024.
* Character limit of Footer is 60.
* Character limit of Button Text and Response is 24.
* Section Title and List Headers are optional.

---

### 2.3 Multi Select

:::info
- Supported for all the mobile SDKs (Flutter, Android , iOS) and web.
- Not Supported for WhatsApp, Instagram, Facebook , Teams, and Slack.
:::

Similar to the Quick Replies node, this node displays a question along with quick reply buttons where the user can select multiple responses.

**Success** and **Fallback** cases must be handled by connecting them to other nodes to continue the flow.


---

### 2.4 Location

Ask, validate and store user location with this node.

User input will be validated based on the data in the fields specified in **Required fields**. This does not mean users have to fill all these fields, any info provided by the user is extracted.

It is then stored in the specified variable with the following format:

 { userMessage: '', coordinates: { lat: "", lng: "", }, fullAddress: '', city: '', state: '', country: '', postalCode: '', }


You can also send a **Share location** button to allow users to share their current location. Customize the text in this button by clicking on it.

<img src="https://i.imgur.com/vRKzKv4.png" alt="drawing" width="50%"/>

The following screenshot is how **Share your location** will look on your bot.


---

### 2.5 Store comment

This node helps you to collect user input such as feedback, questions, suggestions, and so on.

User inputs are stored in a variable through the **Store comment node** without triggering the NLU of that particular flow.

For example, you have created a bot to order food from a restaurant. You want to allow the user to provide feedback after delivering the food. In such cases, you can use the store comment node to provide feedback without triggering the NLU of the respective flow.


:::note
It is recommended not to use Quick reply option for Store comment node.
:::

In the store comment node, there is a toggle to enable **Quick reply**. Quick reply in the comment store node captures both the comment and the Quick reply response. The comment will be stored as a fallback when the user hits enter after writing the comment, and if the user clicks on Quick reply, then that Quick reply response will be stored in the variable.

---

### 2.6 File Prompt

Ask, validate and store JPG/PNG/MP4/MOV/HEVC files/attachments using this node. The file size limits can be set to a certain number.

It will validate if the uploaded file is in JPG/PNG/MP4/MOV/HEVC format and if its size is less than or equal to the mentioned file size.


Create a file [Variable](https://docs.yellow.ai/docs/platform_concepts/studio/build/bot-variables) and store the file in it.

---

### 2.7 Feedback

:::info
- Supported for all the mobile SDKs (Flutter, Android, iOS) and web.
- Not Supported for WhatsApp, Instagram, Facebook , Teams, and Slack.
:::

Use this node to show a feedback widget and get ratings and feedback from users. You can customize the questions you ask for feedback. The feedback widget will ask for a rating on a scale of 1 to 5. If the user wants to give additional comments, they can enter them in a text field.


:::info
- Feedback data can be found in the Insights section > Data Explorer. You do not need to store it separately.
- You can access this data if needed by using {{variables.var_name.rating}} and {{variables.var_name.comment}}
:::

---

### 2.8 Speak

> This node is available for voice bots.

Users can input the SSML text and can play the configured/generated audio on the go.

This node can be used for two purposes:
1. When voice bot developers can test the SSML inputs directly from this node (with the help of the **Test Audio** button).
2. As an alternative for the **Question** node but as a voice message.

You can enter what a bot must ask the user in SSML format. This can be tested by clicking **Test Audio** and playing the produced audio. When this node is reached in the flow, the user will be sent a voice message (when the bot is configured for it).

The response message (user utterance) obtained for this node can be stored as a variable (similar to the question node)


Sample SSML code:

<speak xmlns="http://www.w3.org/2001/10/synthesis" xmlns:mstts="http://www.w3.org/2001/mstts" xmlns:emo="http://www.w3.org/2009/10/emotionml" version="1.0" xml:lang="en-US"><voice name="en-US-JennyNeural"><prosody rate="0%" pitch="0%"> What is your  query</prosody></voice></speak>

---

### 2.9 Input

Ask and store user input and other comments with this node.

:::note
Use this node only to store text comments from users - these replies will not trigger NLP.
:::

In many use cases, there is a need for a non-linear flow. For example, if the phone number node asks "Please enter your phone number"- the user enters a number in the wrong format, the bot displays the validation message saying "Entered number is wrong. Please enter again". For the same, if the user enters "Why do you want my phone number?" the reply will still be "Entered number is wrong. Please enter again". To handle such cases, the Input node can be used to handle different types of user replies.

For better & dynamic conversation design, use the following functionalities of the input node:

1. Customized validator designs.
2. Attachment of different custom flows/messages every time validation fails. Validation failure messages need not be monotonous as it can be configured for each of the failed attempt separately.
3. Can attach the new [Context handler](https://docs.yellow.ai/docs/platform_concepts/studio/build/nodes/logic-nodes) locally for dynamic conversations.


---

## 3. Make prompt smarter

Make Prompt Smarter option is available on all the prompt nodes. **Auto-complete**, **Auto-skip** and other **Additional** options are the three options available to make your prompt node smarter.


----

### 3.1 Auto complete

Autocomplete is set so that the bot can start predicting the rest of the word or sentence for users as they start typing. For example, if you want to find your location and you start typing Jai, you will get the city names starting with Jai - Jaipur. Similarly, if you type Ban, you will get suggestions such as Bangalore, Bangla, Banswara, etc.

This feature can be used:
* When the end user wants to easily discover what a bot or a point does.
* When there are multiple options available and a limit is set on the display, autocomplete is a good singular or assisting alternative to show options.
* Faster typing, and improved user experience.

:::note
Autocomplete shows results after 3 characters are typed and it keeps filtering the results as the customer continues typing / or selects an option.
:::

<img src="https://i.imgur.com/anyDc8z.png" alt="drawing" width="40%"/>

Auto complete is available at a [global level](https://docs.yellow.ai/docs/platform_concepts/studio/tools#22-conversation) and prompt level (that is triggered inside a prompt).


The following options can be chosen to auto-complete:

1. **Database column** - Select a database table column directly to autocomplete using that.
2. **List entity** - Select a list entity , items of which will be used to populate autocomplete.

> Only List Item names are considered, the is no search based on all synonyms.

3. **User properties** - Select a user property(string type ) from Users table to autocomplete. (Note: Only distinct results will be shown) and add up to one filter on any column.
4. **FAQs** - Multi-select categories of FAQs which you want to include in Autocomplete. FAQ descriptions are populated in autocomplete (which are by default same as the question itself)
5. **Function** - If the use case is complicated and none of the above steps work, select a function where you can write your custom logic to return an array of string items that will populate the autocomplete.

**Sample code snippet for function: **

return new Promise(resolve => {
    console.log("inside autoSuggestion");
    let result = data.variables.autoComponents;
    const { term } = data;
    let suggestions = [];
    result.forEach((hit) => {
        if (hit.component.toLowerCase().includes(term.toLowerCase())) {
            suggestions.push([hit.component, hit.component]);
        }
    });
    resolve(suggestions);
});

--------

### 3.2 Autoskip

You can keep your conversations from being repetitive by auto-skipping the prompt with entities or variables if you have already received the value and have stored it.

In the below example, the user wont be asked for the name, phone number and email again in any of the flows.


Configure Auto-skip at a global level (from tools section), click [here](https://docs.yellow.ai/docs/platform_concepts/studio/tools#224-autoskipping-settings).

---

### 3.3 Additional

1. **Use this as Unique ID for User**: Info entered in this node will be used as a unique identification for a user. For example, instead of setting a new user ID, you can use the phone number as a unique ID to recognize this user. Other nodes that can be used as Unique IDs are Car Number, Aadhar Card, SSN, etc. that are unique to an individual.
2. **Mark user message as sensitive info**: Mask this user info from appearing in conversation logs.
3. **Mark bot message as sensitive info**: Mask this bot info from appearing in conversation logs.


#### Use-case

* There are two nodes in this flow, one asking for a password (marked user message as sensitive info) and the other providing a new password (marked bot message as sensitive info).


* Text entered at these nodes will be displayed as "sensitive information" on the chat log.


:::note
Click the tools icon and configure the node. For more details, see [Nodes](https://docs.yellow.ai/docs/platform_concepts/studio/build/nodes).
:::

---
## 4. Voice input node

A voice input node is used to gather user information, process it, and manage various scenarios of conversing in a human-like manner. This node is in auto-sync with the conversation design so all the designs you add there will appear here automatically. To learn about using this node, click [here](https://docs.yellow.ai/docs/cookbooks/voice-as-channel/build/usingvoiceinput).

:::note
Voice input node will work only for voice bots, i.e you should have enabled **Voice bot** while creating your bot.

:::

## 5. Function autovalidation in nodes

**Function autovalidation in nodes**

Yellow.ai automatically validates the **Name** node. Therefore, the QA team need not conduct any validation checks on bots for these nodes as they are already taken care of by the platform. The following tables consist of the accepted inputs and how the platform processes it for each node.

Yellow.ai automatically validates prompt nodes like **Name**, **Email**, **Phone**, and **Location**. Therefore, the QA team need not conduct any validation checks on bots for these nodes as they are already taken care of by the platform. The following tables consist of the accepted inputs and how the platform processes it for each node.

**1. Name**

|Input Type|User Input|Accepted/Not Accepted as a valid name|Name processed by the platform|
|------|------|-------|------|
|Only numbers|139344|Not Accepted|-|
|Numbers + Special characters|13143=?|Not Accepted|-|
|At least one alphabet, Numbers + Special character|1243242swqw=?|Accepted|1243242swqw=?|
|Gibberish|scsadf|Accepted|scsadf|
|Sentence|My Name is Vikash|Accepted|Vikash|
|Sentence in any language |मेरा नाम विकाश कुमार |Accepted|काश कुमार|

**2. Email**

|Input Type|User Input|Accepted/Not Accepted as a valid email address|Email address processed by the platform|
|------|------|-------|------|
|number@valid email domain|[e-mail]|Not Accepted|-|
|Text @valid email domain |[e-mail]|Not Accepted|-
|nothing@valid email domain|@gmail.com |Not Accepted|-|
|Sentence (validator works on other languages too)|My email is [e-mail]|Accepted|[e-mail]|

**3. Phone**

If default ISD is not selected, the platform will fetch India's ISD and try to validate the user inputs based on the Indian Phone numbers. If the ISD is selected, then it will validate the user inputs based on the selected country's phone numbers.

|Input Type|User Input|Accepted/Not Accepted as a valid phone number|Phone number processed by the platform|
|------|------|-------|------|
|Gibberish |sdsad1211|Not Accepted|-|
|Gibberish with special characters|eqwrj#|Not Accepted|-
|9 digit no (If India selected as ISD/ Nothing selected in ISD)|704430890|Not Accepted|-|
|10 digit No( If India selected as ISD)|7044308905|Accepted|7044308905
|Sentences with 9 digit no (If India is selected)|My No is 703330890|Not Accepted|-|

**4. Location Node**

Location has various attributes. For e.g., lets say that we have stored the user response in obj type variable named “address”,

You can fetch Pin Code through : variables.address.postalcode
You can also fetch the City code through: variables.address.city

|Input Type|User Input|Accepted/Not Accepted as a valid location|Pincode processed by the platform|City processed by the platform
|------|------|-------|------|---------|
|Only Pincode |800007|Accepted|800007|-
|City+ Pincode|Patna 800007|Accepted|800007|Patna
|City+ wrong pincode|Patna 110007|Accepted (with corrected Pin code)|800001 (Pincode will be corrected by the platform)|Patna
|City + wrong format pin code|Patna 80007|Accepted (with corrected pin code)|800001 (Pincode will be corrected by platform)|Patna
|Only Address (without city and pin)|Hauz Khas|Accepted|110016 (correct)| Delhi|