User Interface Basics

Before starting work on any Conversation Flow, wether creating a new project or updating an existing one, it is important to understand the basics of the User Interface

Overview of the New Blank Project

To start from scratch, refer to the Creating Project page for detailed instructions.

Remember, you can also import projects based on your templates into your workspace.

To understand different versions, check out the Project Version History and refer to the video below.

1. Files:

The Files section serves as a gateway to manage your project files and configurations. It contains a dropdown menu with the following options:

  • Import: Allows you to import files or data into your project from external sources.

  • Export: Enables you to export project files or data for sharing or backup purposes, deal for creating various project cases and scenarios.

  • Shortcuts: Provides access to keyboard shortcuts overview for quick navigation and actions within the platform.

  • Settings: Allows you to customize project settings and configurations according to your preferences. See Setting tab for detail explanation.

2. Cursor Icons:

These icons offer flexibility in navigating and interacting with the project canvas:

  • Standard Cursor: Allows you to select and interact with nodes and elements on the canvas.

  • Hand Cursor: Enables you to grab and move nodes or scroll within the canvas for better navigation.

3. Comment Icon:

Clicking on this icon activates the commenting feature, allowing users to add comments.

4. Sync Toggle:

This toggle allows you to enable or disable synchronization between the flow diagram and the code.

5. Undo/Redo Icons:

These icons offer the ability to undo or redo previous actions, providing a safety net for experimentation and preventing accidental changes.

6. Search Panel:

The search panel provides a convenient way to search for nodes within your project by their names, allowing for quick navigation and location of specific elements.

Comments

To enhance cooperation and streamline communication, users have the flexibility to add two types of comments:

  • General comments General comments provide a space for users to share overall feedback, ask questions, or discuss ideas that are not tied to any specific node or element within the project. They can be placed anywhere on the canvas and are not tied to a specific node.

  • Node-specific comments Node-specific comments offer more targeted feedback by linking comments directly to specific nodes or elements within the project. This feature is invaluable for providing precise feedback on particular parts of a conversation flow, code segments, or design components.

Creating comments step-by-step
  1. Access the Comment Feature: Locate the comment icon in the top menu among other tools. Click on this icon to activate the comment feature.

  2. Placing Comments:

    • For general comments: Click anywhere within the project where you want to place the comment.

    • For node-specific comments: Click on the specific node or element within the project to tie the comment with that particular node.

  3. Compose Your Comment: A text box will appear where you can type your comment. Write the text of your comment, providing feedback, asking questions, or sharing ideas as needed.

  4. Save Your Comment: Once you've written your comment, click on the check mark icon to save it. Your comment will be added to the project, visible to all users with access to the project.

Editing comments step-by-step
  1. Select Comment: Click on the comment directly within the canvas or in the comment panel. This action fully opens the comment.

  2. Access Editing Mode: Once the comment is opened, click on the pencil icon. This action allows you to edit the content of the comment.

  3. Edit Comment: Update the text of the comment as needed, making any necessary changes or revisions.

  4. Save Changes: After editing the comment, click on the check mark icon to save your changes

Assigning comments to user step-by-step
  1. Write Your Comment: Begin writing your comment in the text box.

  2. Complete Your Comment: Continue writing the rest of your comment as needed.

  3. Save Your Comment: Once your comment is complete, click on the check mark icon to save it. The comment will now be assigned to the selected user

Managing comments step-by-step

Marking Comments:

  1. Mark as Read/Unread:

    • Similarly, if you want to mark a comment as unread to revisit it later, click on the icon again, and it will revert to an unread status.

Resolving Comments:

  1. Mark as Solved:

    • If a comment has been addressed or no longer requires attention, you can mark it as solved.

    • This action will remove the comment from the canvas or comment panel, streamlining the view for unresolved comments.

Filtering Comments:

  1. Filtering Options in Comment Panel:

    • You can filter comments in the comment panel based on different criteria:

      • Only comments you've made.

      • All comments marked as read.

      • All comments marked as solved.

    • By default, you'll see all unresolved comments in the order of their creation or last update.

Delete Comment:

  1. Deleting Comments:

  • If a comment is no longer needed or is redundant, you can delete it by clicking on the trash bin icon associated with the comment.

Notes

Within each project, a notepad is provided, offering a simple yet powerful tool for collaboration and organization.

The notepad features a user-friendly graphical interface with a blank space where you can jot down your thoughts, ideas, and reminders. Additionally, a formatting panel is available, allowing you to customize the appearance of your notes with options such as font styles, colors, and list formatting.


Overview of the Not-so-Blank Project

Here, you'll find the editor displaying an example project. We have a flow with connections and nodes as the primary building blocks shaping our conversational flow, featuring a starting node and an end node (phones). After training the version, we gain access to the chatbot widget, allowing us to toggle the left navigation bar and hide/show the node bar.

This straightforward project was built step-by-step (refer to the Creating My First Virtual Assistant page), utilizing nodes as fundamental building blocks, elaborated further in the upcoming chapter - Nodes Explained.

Step by step to train the project

See the more information about training / untraining version in page (Training model)

Prerequsities - having the completed conversation flow, see the example project in page - Creating my first Virtual Assistant

  1. Select the right project

  2. Click "Train version"

  3. Click chatbot widget in bottom right corner and start interacting with simple chatbot (Virtual assistant)

  4. Check the flow

  5. Untrain model, make modification and train again

You can see that we can expand the chatbot widget or move it to the middle by clicking the buttons in the top left corner


Simplified interactions using shortcuts

These shortcuts are designed to enhance your workflow and help you navigate the studio with ease. Check out the new shortcuts in action below:

Learn how to use shortcuts

You can find a comprehensive overview of all the new shortcuts within the app. Just navigate to FILE -> Shortcuts modal to learn more and incorporate them into your projects.

Ideal for training, deployment, and various project management tasks.

ShortcutName of the action

ALT + S

Save

ALT + SHIFT + S

Save model version

ALT + SHIFT + I

Import

ALT + SHIFT + E

Export

ALT + SHIFT + T

Train version / untrain

ALT + SHIFT + F

Test in debug

ALT + SHIFT + D

Project Deploy

Special Note for Mac Users:

Don't worry, we've got you covered! Mac users can enjoy these shortcuts by using the OPTION key in place of ALT, and the COMMAND key instead of CTRL.


Last updated