VOGO Voice – Knowledge Base

Saved value vs Incoming value

Estimated reading time: 6 min

VOGO Voice, a highly tenable platform offers a series of diverse, color-coded components that vary in its capability and function to design interaction flows and create purposeful and unique custom skills.

Adopting a comprehensive methodology, this tutorial is dedicated to presenting a guided step-by-step walk-through to provide practical hands-on experience on how to configure different color-coded component cards that showcases a comparison between the saved value and incoming value within a custom interaction model. Besides illustrating the aforementioned comparison by means of an elementary use-case, this instructional tutorial will also walk you through on how to curate tailor-made voice responses to provide a better experience for the end-user.

Prerequisites: 

  •  VOGO Voice account: https://www.vogovoice.com/
  • Access rights to the Intents section under Settings.
  • Access rights to the Interaction builder platform.

Create a custom intent to capture the incoming value

Create an appropriate intent to be invoked within the custom interaction model, the purpose here being to capture the incoming value i.e. the end-users input which represents the given name of the user visiting the skill.

Create an intent titled ‘Name’ with a set of suitable sample utterances mapped to it. Let’s say the sample utterances are: “I am {name}” and “My name is {name}”, and “{name}” where ‘name’ is the slot name. Assign the slot type to ENVIRONMENT_FirstName which is a global slot with predefined values. 

Create a custom intent for the interaction model

Create an appropriate intent to be invoked for executing an interaction flow mapped to it, the purpose here being to illustrate a comparison of Saved value vs Incoming value.

Create an intent titled ‘Welcome Page’ with suitable sample utterances mapped to it. The sample utterance for this intent would be: “Take me to the welcome page”.

To learn how to create custom intents refer the guide: https://university.vogovoice.com/kb/creating-intents/

Steps to create an interaction flow

Let’s walk you through the step-by-step process on how to build an interaction model that will illustrate the significance of inputs.value vs settings.value and how it can be used to drive dynamic content within a custom interaction model depending on the requirements of the skill.

1. Log into your VOGO Voice account to be directed to VOGO Voice Management Console (https://account.vogovoice.com)
2. Navigate to Interactions on the vertical bar displayed on the left-hand side of the Dashboard.
3. Click on the Interaction button at the bottom right-hand corner of the screen and select the ‘Welcome Page’ intent to be directed into the Interaction builder platform.

4. In the flow diagram area, you will be able to see the Start and Response component.
5. Unlink the Start component from the Response card by clicking the delete icon placed in the middle of the chain.

6. Drag and drop the Check variable component onto the flow diagram area.
7. Connect the Start component to the Check Variable component.

Note: To interconnect the different components click on their respective Anchor symbols so as to chain and hold them in the interaction flow.

8. Configure the Check Variable component with a test condition using the relational operator Exists to evaluate the value stored in the system through Save Settings. The flow for the returning user will proceed from Then because upon his previous visit his name which is the incoming value in this interaction was captured and saved. Now for the new user, the pathing of the flow will progress from Otherwise as he is visiting the skill for the first time.
1. Populate the left-hand side of the Configuration window as in the screenshot shown below. Set the data type based on the input.

  Left-Hand side: settings.name (choose data type as Path).

 To learn about different template engines to be followed to run functions visit https://university.vogovoice.com/kb/template-engine/

🖍 Note: Ensure to click the Save button to save the interaction flow as and when edits are made.

9. Now drag and drop a Response component onto the flow canvas and link it to the Then on the Check Variable component.

10. Roll the mouse over the Response component to see the voice, computer and camera icon on the top right-hand side of the component.
11. Click on the Voice icon of the Response card to open up the Speak pop-up window and type the voice action intended to be spoken to the returning user in the field titled Say to provide a suitable response if the test condition returns True i.e. if the user’s name is saved in the system.

Say: Welcome back {{settings.name}} to Nature’s hub. We have for you a new collection of relaxing music to help you relax and de-stress.

To add a display message in a video-enabled voice-assisted device

  1. Click on the Computer icon, and type in a condensed version of the voice message in the field titled Display Message of the Show pop-up window.
  2. Populate the required fields and click the Save button.
    Title: Nature’s hub
    Display Message: Welcome back {{settings.name}} to Nature’s hub. Enjoy our new collection of relaxing music. 

For further reference on how to populate the additional fields visit https://university.vogovoice.com/kb/guide-response-component/

12. Now drag and drop another Response component onto the flow diagram area and link it to the Otherwise on the Check Variable component.

13. Now configure the Response component attached to the Otherwise on the Check Variable component.
14. Click on the Voice icon of the Response card to open up the Speak pop-up window and type the voice action intended to be spoken to the new user in the field titled Say to provide a suitable response if the test condition returns False.

Say: Please tell me your first name so that we can introduce you to a wide range of relaxing music and know your musical preference.

15. Check the checkmark box in the Expect Response and type in the suitable Prompt message to proceed with the flow.
16. Prompt: Please tell me your first name.
The same message will be replicated in the Reprompt field.    
    Reprompt: Please tell me your first name.
17. Populate the field under Expectations by selecting the Intent Name from the drop-down list which will open up a field to capture the input value i.e. the given name of the new user visiting the skill.

To add a display message in a video-enabled voice-assisted device
1. Click on the Computer icon, and type in a condensed version of the voice message in the field titled Display Message of the Show pop-up window.
2. Populate the required fields and click the Save button. 
Title: Nature’s Hub
Display Message: Please tell me first your name so that we can introduce you to a wide range of relaxing music and know your musical preference.

18. Drag and drop a Save Settings component onto the flow canvas and connect the anchor symbol of Name on the Response card to the Save Settings component.

19. To configure the Save Settings component add the key-value pair. Input name as the key and inputs.name.value as its corresponding value. Set the data type as Path. 

🖍 Note: Herein, the saved value can be accessed at any stage within or beyond a session/interaction in a custom skill, whereas the incoming value cannot be used beyond an interaction or session in a skill.

20. Drag and drop a Response component onto the flow canvas and connect the anchor symbol of Next on the Save Settings component to the Response card.

21. Click on the Voice icon of the Response card to open up the Speak pop-up window and type the voice message welcoming the new user to the skill in the field titled Say.

Say: Hi {{settings.name}}. We are glad to have you visit our welcome page.

To add a display message in a video-enabled voice-assisted device.

  1. Click on the Computer icon, and type in a condensed version of the voice message in the field titled Display Message of the Show pop-up window.
  2. Populate the required fields and click the Save button. 
    Title: Nature’s Hub
    Display Message: Hi {{settings.name}}. We are glad to have you visit our welcome page.

The screenshot below captures the aforementioned interaction flow.

Testing and Validation

a.Testing for New User

  1. Click on the Test button next to the Flow Editor button on the interaction builder platform.

2. In the Tests pop-up window that appears click the + button on its top right-hand corner. 

3. Fill the Name field of the Test Response window that shows up.
4. In the Conversation section of the Test Response, the Welcome Page intent through which this interaction flow has been initiated will be auto-generated in the User invokes field.
5. Click the plus button within the Conversation Section to open up an additional field titled User Invokes. Ensure to populate this field by selecting the Name intent called to action within the interaction flow. 
1. An additional field will appear with the title With Slots, where the slot value i.e. the name of the new user visiting the skill is to be captured. Here, the given name is Bob.  

6. Finally, click the Save button to save the input and perform the test.
7. To validate the Test Response, click on the lightning symbol on the left-hand side of the test case. 

8. On the resultant Test Response window, the blue chat bubbles will present the previously input messages within the Response component.

9. Click on the chat bubble to see the details of the individual response. 

b. Testing for Returning User

Repeat the steps 1-4 as carried out while performing Testing for New User after which continue as follows:
5. Populate the User Settings sectionfield with the variable as defined in the Save Settings component. Input the variable as name andassign a value, which for this interaction model has been chosen as Bob.

6. Finally, click the Save button to save the input and perform the test.
7. To validate the Test Response, click on the lightning symbol on the left-hand side of the test case. 

8. On the resultant Test Response window, the blue chat bubbles will present the previously input message within the Response component.

9. Click on the chat bubble to see the details of the individual response.

To know more about testing an interaction refer https://university.vogovoice.com/kb/testings/

Congratulations! You have successfully created an interaction flow that illustrates the differentiating significance of Saved value & Incoming value, and also how to generate  curated voice responses to provide a better experience for the new and returning user visiting the skill.

👍 Note: To test the functioning of the interactions on your device you have to deploy the custom skill to facilitate the skill with the new edits. To accomplish this, click on the Deploy button seen at the bottom of the Skill Settings pop-up window.

To know how to deploy a custom skill visit https://university.vogovoice.com/kb/deploying-a-skill/

Tags:
Was this article helpful?
Dislike 0
Previous: Retrieve data from Airtable base
Next: Loop with Condition