Learn the terms that are used within the Workativ Assistant User Interface through this Glossary.
The following condition options appear whenever you select an entity/variable inside the recognize dialog pop up.
A
Analytics
Analytics is a provision in Workativ Assistant that allows users to view statistics on Intents, Entities, Dialogs, and Automations in the form of bar graphs and pie charts.
Assistant
This is the virtual assistant that you can use to test your dialog flows or deploy in chat-channels. This enables your employees to make use of the assistant in the chat channel to self-resolve their workplace IT issues.
Ask a Question
The option to add a question inside a dialog that prompts the user and waits for their input. The user’s input is then stored inside a variable.
Add Child Node
A child node can be thought of as creating a whole new dialog flow with new intents, entities, and automations inside another dialog (parent node). The child node is executed only after the execution of the parent node.
Anything else
Use this field under Feedback Dialog on the Dialog Creator’s Settings page to specify the message that needs to be displayed when the virtual assistant exits a conversation on its own if there’s no feedback from the user.
Avg. Conversation per user
This, under Conversation Analytics, displays the average number of conversations per user for over a month.
Avg. Msg. Per Conversation
This, under Conversation Analytics, displays the average number of messages per conversation for over a month for a user.
Add
Use this button which is on the top left corner of an Intent’s examples page/Entity’s values page to add new examples/values respectively.
Add options
Use this field on the Ask a Question’s Options Question pop up to specify the options for a question.
Add more
Use this button to either add more examples for an intent or synonyms for an entity or messages or options depending on the context.
C
Card View
This is a view option that you can choose to view your Automations, Intents, and Entities in a more detailed format. Details such as an intent or entities’ description and the number of examples you have added to a particular intent/entity can be seen through this view option.
Create New
The option that allows you to either create an entity, an intent, a dialog or an automation.
Context Variables
Context Variables under the Automations option inside a dialog are used to store a user input corresponding to a field in an automation. The respective context variables are then mapped to their corresponding input fields inside an automation so that the automation can perform the specified actions.
Catalog
This, which is displayed on the top left corner of the Dialog Homepage shows the total number of dialogs created by a user. (Not including the Welcome and Fallback dialogs that are created by default by Workativ Assistant as soon as a user creates their first dialog)
SYS-email
This is a default system entity that’s created by us to make it easier for you while creating dialogs with automations in Workativ Assistant. Use this pattern-based entity to enable Workativ Assistant to recognize an email input by a user during their conversation with the Assistant.
SYS-mobilenumber
Use this pattern-based entity to enable Workativ Assistant to recognize a mobile number input by a user during their conversation with the Assistant.
SYS-ticketid
Use this pattern-based entity to enable Workativ Assistant to recognize a Ticket ID input by a user during their conversation with the Assistant.
SYS-currency
Use this pattern-based entity to enable Workativ Assistant to recognize a currency input by a user during their conversation with the Assistant.
SYS-date
Use this pattern-based entity to enable Workativ Assistant to recognize a date input by a user during their conversation with the Assistant.
SYS-time
Use this pattern-based entity to enable Workativ Assistant to recognize a time input by a user during their conversation with the Assistant.
Client Name
This, under Conversation Analytics, displays the client in which a conversation with the virtual assistant took place. The client can be Slack or Microsoft Teams.
Conversations
Use the view button under this to view all the messages inside a conversation on the Try Me option.
Comments
Use the view button under this option to view the feedback comment given by a user at the end of a conversation with the virtual assistant.
Clear chat
Use this button on the Try Me to clear the current conversation test and to start a new conversation.
Create Child Node
This switch on the Options pop up inside a dialog is used to specify whether you want the options specified on this pop up to have separate dialog flows (child nodes) inside the same dialog (parent node). The child node corresponding to an option gets executed when the user selects that option.
This option is also available on the Call Automation pop up inside a dialog which, when selected between success and failed child nodes, creates child nodes for those respectively.
Cancel
Use this button if you want to cancel a create new dialog/node/intent/entity/automation process.
D
Dialog
This is the conversation that you create for the virtual assistant by combining intents, entities, and automations.
Detail View
A view option that allows the user to view dialogs in a detailed format. In Detail View, you can see the intents, entities, variables, condition or text responses used inside a dialog.
Description
This module allows you to view the description (optional for anything you create) of the intent, entity, dialog or automation that you create.
Date
This is a column present in all modules and analytics that reveal the date on which any workflow was created.
Date & Time
The Date & Time column under the Conversation Analytics Homepage displays the date as well as the time a conversation with the virtual assistant took place.
Delete
Use the Trash Bin icon that appears on a dialog/dialog node/intent/intent example/entity/entity example when you hover the mouse over it to delete it permanently.
E
Entity
Entities are used for identifying interesting parts of the user’s query, such as names and dates. Workativ Assistant already provides system entities (for date, time, email, currency, etc.,), and lets you define entities with synonyms as well as defining pattern-based entities.
Exit
It is the fallback node that marks the end of a dialog flow and is appropriately named End.
Examples
These are the instances of a dialog from a users’ perspective that you provide under any intent that you create. An intent can have multiple examples.
End the conversation if there is no response from user in
Use this field under Settings on the Dialog Creator to specify to the virtual assistant when to end a conversation with a user if the user doesn’t reply to it.
Executions Time
This column under the Conversation Analytics displays how long a conversation with a user took place.
Examples
You can specify the different ways in which a user can input a query during their conversation with the virtual assistant by adding examples under the Examples homepage inside an intent.
Edit
You can use the pencil icon that appears on a dialog/dialog node/intent/intent example/entity/entity value when you hover over it to change the name of that item.
F
Fallback
The fallback node is one of the default dialogs that Workativ Assistant comes equipped with. You can use this node to create a closing or fallback response tailored for users when there is no other appropriate response to fall back to.
Feedback Dialog
You can use the following field under this:
Feedback Message: Use this field to specify the message that the virtual assistant displays to the user at the end of a conversation.
Feedback Options: Use this to specify the message that needs to be displayed beside the thumbs up and thumbs down icons that the user can select at the end of a conversation.
Feedback
This column on the Conversation Analytics page displays whether the user has given a thumbs up or a thumbs down for a conversation.
Failed
This option on the Call Automation pop up inside a dialog can be used to specify whether a child node for automation failure conversation must be created inside a dialog (Parent Node).
G
Get details
This pop up in a dialog can be used to specify an intent or an entity that a user’s input must satisfy before it can be stored inside a variable.
H
Homepage
This is the canvas page under the Dialog Creator that displays all the default as well as the user-created dialogs for the virtual assistant.
I
Intent
As the word implies, an Intent is used to determine the user’s intention for a query. You can give any number of examples for a single intent. The examples inside an intent (words/phrases) will then be used by the virtual assistant to identify if the user’s query comes under that intent.
Icon view
Use this button on the top right corner inside a dialog to view only the icons and names of the nodes created inside that dialog.
If not present, ask user
This field on the Get Details pop up can be used to specify a message that needs to be displayed to the user by the virtual assistant if the user’s query doesn’t satisfy the intent/entity specified on that Get Details pop up.
If bot recognizes
Select this option on the Jump pop up if you want the Virtual Assistant to jump to a node automatically if it recognizes the intent/entity related to that node.
J
Jump
The jump node allows you to direct the flow of a conversation to another dialog. You can use this functionality to break the flow of a dialog.
L
Least Used Automations
This section in Analytics shows you the Automations you have deployed and used the least by end-users.
List view
Use this button on the top right corner of the Intent/Entity homepage to view the intents/entities on it as a list of items.
M
Most Used Automations
This section in Analytics shows you the Automations you have deployed and used the most by end-users.
Messages to display in chat channels
You can use the fields under this on the Dialog Creator’s Settings page to specify the:
- Onboarding message to display to end users after Virtual Assistant is deployed in chat channel
- Offboarding message to display to end users after Virtual Assistant is removed from the chat channel
- Message to display if Virtual Assistant service is not available at the movement
- Message to display to user after exiting from conversation when user interacts next time
Max. Conversations in one day
This displays the maximum number of conversations that took place in a day over 30 days.
N
No condition required
This condition is used to tell the virtual assistant to not check for any other condition when the virtual assistant checks a user’s query for an intent/entity/variable.
Name
This column on the Intent/Entity homepage displays the name of the intents/entities on the page.
Name your automation
Use this field on the Call Automation pop up to specify a name for that node in that dialog.
O
Options
This is a functionality in the Dialog creator that allows you to present an option-based prompt to the user. You can provide multiple options and set values for each one of them.
Options question
Select this option on the Ask a Question pop up if you want to add multiple options to a question that the user can select with the click of a button.
P
Patterns
An option in the entity functionality that allows you to set a pattern that the assistant can recognize. Some common examples of patterns could be, a phone number pattern, a password pattern, or an email pattern. Some patterns may require the usage of the Spring Expression Language.
Q
Question
Use this field on the Ask a Question pop up to specify the question that the virtual assistant must ask during a conversation with a user.
R
Respond
Select this option on the Jump pop up if you want the virtual assistant to respond to a user directly after a dialog without waiting for the user’s input.
S
Send Message
Send a message as a response to the user who is interacting with Workativ Assistant through this option.
Save
The option to save your work progress for any functionality such as Intents, Entities, and Automations.
Synonyms
Synonyms under entities can be used to match the user’s input. With synonyms, you can categorize a bunch of terms.
Search
The Search field under the Dialog, Intent and Entity homepages as well as on the Jump feature inside a dialog can be used to search for an item.
Settings
Use this option on the Dialog Creator’s navigation pane to configure the virtual assistant to your needs.
SYS-Username
This is the system variable that can be used to check and store the Username from a user’s input by the virtual assistant.
SYS-UserEmail
This is the system variable that can be used to check and store the Email ID of a user from the user’s input by the virtual assistant.
SYS-Timezone
This is the system variable that can be used to check and store the time zone of a user from the user’s input by the virtual assistant.
SYS-Slack_client
This is the system variable that can be used to check and store the Slack Client ID of a user from the user’s input by the virtual assistant.
SYS-slack_workspace_ID
This is the system variable that can be used to check and store the Slack Workspace ID of a user from the user’s input by the virtual assistant
SYS-try_me_client
This is the system variable that can be used to check and store the Try Me Client ID of a user from the user’s input by the virtual assistant.
Show
Use this dropdown on the Conversation Analytics Page to filter and display the analytics for only the:
- Last 30 days
- Last 7 days
- Yesterday
- Today
Set values
Use this button on the Try Me feature to add new variables and set value for that variable.
Success
Select this option on the Call Automation pop up in a dialog (Parent Node) to create a separate dialog flow (child node) if an automation gets successfully executed.
Select automation
Use this dropdown on the Call Automation pop up in a dialog to select an automation that you want the virtual assistant to execute.
Save the answer as
Use this field which is present on both Ask a Question and Get Details pop-ups in a Dialog to specify the variable inside which you want a user’s input to be saved.
Simple question
Select this option on the Ask a Question pop up in a dialog to specify a simple question that the virtual assistant must ask a user during a conversation.
Set to sequential
Select this option on the Send Message pop up to instruct the virtual assistant to display the messages added inside the pop up in sequential order to the user during a conversation.
Set to random
Select this option on the Send Message pop up to instruct the virtual assistant to display the messages added inside the pop up in a random order.
T
Total Conversations
This is the total number of conversations that have been made between the end-users and VA and can be found under the analytics section in Workativ Assistant.
Try Me
The Try Me option in the Dialogs section allows users to test out dialog flows and thereby also testing out the intents, entities, and automations that have been created.
Top Intents
This table on the Conversation Analytics page displays the topmost identified intents by the virtual assistant during its conversations with different users.
Top Entities
This table on the Conversation Analytics page displays the topmost identified entities by the virtual assistant during its conversations with different users.
Total messages
This field on the Conversation Analytics page displays the total number of messages including all the virtual assistant’s conversations with different users.
Type message
This field under the Exit option in a dialog can be used to specify a message that the virtual assistant must display to the user before it exits a conversation.
V
Virtual Assistant
This is the medium through which users communicate and get their issues resolved. It can either be deployed in chat channels or prompted through the Try Me option in the Dialogs section.
Variable
Think of a variable like a data box inside which related data is stored dynamically from the user’s input by the virtual assistant. The variable can be used to check a user’s query or to get and store new related data inside it.
Value
These are the entity values that can be synonyms or pattern-based depending on the use case.
W
Welcome
This is a default dialog created by Workativ Assistant automatically when a user creates their first dialog. The welcome dialog can be used to specify what the virtual assistant says first to the user as soon as it’s opened.
When to exit from the user conversation
Use the fields under this on the Dialog Creator’s Settings page to specify what the virtual assistant should do if there’s no response from the user.
Wait for user input
Select this option on the Jump pop up in a dialog to make the virtual assistant wait for the user’s input before it jumps on to the specified dialog’s node.