System Variables
Overview
System Variables are integral to Flow projects and the integrated Generative Models. They allow you to manage consistent and essential settings across your project. Unlike regular variables, System Variables have a fixed structure and usage and cannot be created or removed by conversational designers.
System Variables in Project Configuration
Description
System Variables are predefined and required for Generative Models, too. Unlike other variables:
- Users cannot create or remove them.
- The input fields for the name and usage of these variables are disabled, preventing modification.
Configuration
- Overwriting/Resetting Values: You can overwrite or reset the value of a System Variable using code actions, just like with any other text variable or parameter.
- Project Creation: The values entered during the project creation wizard are used for System Variables instead of text variables.
- Brand Name and Bot Name: These are required fields, and the Create button will be disabled until valid values are provided.
- Tone of Voice: This field is optional. Define the tone of voice of the persona.
Task: Creating a New Project
- Create a New Project
- Enter Required System Variables:
- Brand Name: Enter the brand name.
- Bot Name: Enter the bot name.
- Tone of Voice: This field is optional. Define the tone of voice of the persona. For example, Brief, gentle & honest.
- Validate Entries: Ensure the brand name and bot name fields are filled. The Create button will remain disabled until these fields are valid.
- Create Project: Once all required fields are valid, click Create to initiate the project.
System Variables
The description of the system variables is as follows:
| System Variables | Description |
|---|---|
| Brand Name | The brand name |
| Bot Name | The bot name |
| Tone of Voice | Define the tone of voice of the persona. For example, "Brief, gentle & honest" |
| Business Phone Number | The business phone number |
| Bot Expertise | This variable allows you to pass the persona expertise. For example, "Answering questions about different products A, B, and C" |
| Knowledge Required | Knowledge about the question is required. The persona will respond if it knows the question; if it doesn't, it will trigger a failure event. |
| Concise | The persona will respond in a concise bot's voice tone and wording of the bot response. |
| Handover Suggestions | This variable functions when a user mentions that the previous bot response as not helpful or did not resolve the issue or the user wants to speak with support or customer support; the conversation will be handed over to the agent. |
| Strict language | This variable will ensure that the bot language and the input language are the same. |
| Markdown | The formatting of the bot response is in markdown and makes the text response look better. |
| Follow up | The persona will ask follow-up questions to narrow down the user's search if the user asks generic questions. |
| Citations | Sends the citation in the bot's follow-up question. |
Result
Upon successfully creating the project, System Variables are populated with the values provided during the setup. These variables are ready for use in your Generative Models, ensuring consistent and correct data throughout the project lifecycle.
Conclusion
System Variables are essential for maintaining consistency and reliability in Generative Models. They enforce uniform settings across projects. Their importance lies in ensuring that critical configurations are consistently applied, contributing to your models' overall stability and functionality.
Updated 2 months ago