From 6dabf136be9cdc6afc58d302947bc420d5fb4ab4 Mon Sep 17 00:00:00 2001 From: Chedli Ben Yaghlane Date: Fri, 13 Sep 2024 20:29:37 +0000 Subject: [PATCH] GITBOOK-39: Update Context Vars user guide --- docs/user-guide/manage-context-variables.md | 30 +++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/docs/user-guide/manage-context-variables.md b/docs/user-guide/manage-context-variables.md index 9cec4e66..8de2bd92 100644 --- a/docs/user-guide/manage-context-variables.md +++ b/docs/user-guide/manage-context-variables.md @@ -1,3 +1,33 @@ # Manage Context Variables
+ +Context variables are powerful tools in Hexabot that allow you to store and manage information gathered during a conversation with a user. This information can then be used to personalize the chatbot's responses, make decisions within the conversation flow, or trigger specific actions. + +Think of context variables as temporary storage containers that hold data specific to a particular conversation. For example, you could store the user's name, their preferred language, or their order details. + +**1. Access Context Variables page:** + +* Navigate to the "Context Vars" or "Context Variables" section. This is typically found in the main menu. + +**2. Creating a New Context Variable:** + +* **Click "Add Context Variable" or a similar button:** This will open a form where you can define a new context variable. +* **Provide Variable label:** Choose a descriptive label for your variable, reflecting the type of information it will store. For example: + * user\_name + * preferred\_language + * order\_id + * location +* **Save Changes:** Click the "Submit" button to create your new context variable. + +**5. Managing Existing Context Variables:** + +* **View Existing Variables:** In the "Context Vars" section, you can view a list of the context variables you've created. +* **Edit Variable label:** You can edit a variable's label. However, you cannot change it name once it's created. +* **Delete a Variable:** If a context variable is no longer needed, you can delete it from the list. Be careful because deleting a variable will remove all data stored within it. + +{% hint style="info" %} +**Additional Notes** + +Context variables are temporary and are specific to a single conversation. They are not shared between different conversations. +{% endhint %}