Conversational UI
Content Type: Module
Categories: User Interface,AWS,Artificial Intelligence
Overview
Create an AI based Conversational UI with the provided data model, pages, snippets and building blocks. You can integrate with any LLM and knowledge base to create your own full screen, sidebar or modal chat. It integrates with the Atlas framework and is the basis of our AI Bot Starter App and included in the Blank GenAI App.
Typical use cases:
- Create a chat interface for users to chat with Large Language Models (LLM). Use our pages for a full screen, sidebar, floating popup and history layout.
- Allow users to switch between different implementations by switching "providers".
- Include advanced capabilities to control the model's behavior, for example by setting the temperature parameter.
- Easily extend the chat interface with advanced concepts, such as RAG or the ReAct pattern.
As an additional feature, this module provides pages/snippets and logic to display GenAI usage data for monitoring purposes.
For more information, visit the official documentation.
Documentation
Documentation
See official documentation.
Dependencies
- Atlas Core
- DataWidgets v2.22.0 or higher
- GenAI Commons v1.3.0 or higher
- Nanoflow Commons
- Web Actions
- Community Commons module v10.0.6 or higher
GenAI Showcase app
For implementation examples, see the GenAI showcase app.
Releases
Version: 1.5.1
Framework Version: 9.24.2
Release Notes: We have made a number of small changes to facilitate easier implementation in custom projects.
- The exposed names of the operations in Conversational UI have been made clearer.
- Custom action microflows can now receive specializations of ChatContext as well.
- The text below the chat input box can now be customized easily using a constant (@UserInputInstructions).
- Additional css classes have been added to allow for styling customization in the chat conversation UI. For a full overview, see the https://docs.mendix.com/appstore/modules/genai/conversational-ui/
For the end user a button to clear the current chat was added.
Additionally to version 1.5.0 we have fixed a bug where scrolling to the last message wasn’t working properly anymore.
Version: 1.5.0
Framework Version: 9.24.2
Release Notes: We have made a number of small changes to facilitate easier implementation in custom projects.
- The exposed names of the operations in Conversational UI have been made clearer.
- Custom action microflows can now receive specializations of ChatContext as well.
- The text below the chat input box can now be customized easily using a constant (@UserInputInstructions).
- Additional css classes have been added to allow for styling customization in the chat conversation UI. For a full overview, see the https://docs.mendix.com/appstore/modules/genai/conversational-ui/
For the end user a button to clear the current chat was added.
Version: 1.4.0
Framework Version: 9.24.2
Release Notes: We added UI components to visualize GenAI token consumption for monitoring purposes. Pages, snippets and logic can be found in USE_ME under “Usage Monitoring”. The latest version of the GenAI Commons module is required and the latest version of the OpenAI Connector supports this feature.
An example can be observed in the newest version of the GenAI Showcase App.
Finally, a styling bug for conversation starters in a horizontal gallery was fixed.
Version: 1.3.0
Framework Version: 9.24.2
Release Notes: We added three building blocks for conversation starters that can be added to the conversational UI. As an illustration, we added a page with an example of how the conversation starter building blocks can be used. Additionally, a constant was introduced that enables Markdown rendering (a common markup language for creating formatted text). This applies to the assistant messages in a chat conversation.
Version: 1.2.1
Framework Version: 9.24.2
Release Notes: We fixed an error in the Retrieve-And-Generate action microflow example in ConversationalUI so that it is again fully compatible with the latest Amazon Bedrock Connector version.
Version: 1.2.0
Framework Version: 9.24.2
Release Notes: In chat conversations, users can now use the Enter key to send messages and Shift+Enter to add a new line.
Version: 1.1.1
Framework Version: 9.24.2
Release Notes: - Improved toolbox actions are exposed which provide more flexibility in creating new chat contexts with action microflows.
- Included an example action microflow that demonstrates how to use Amazon Bedrock Retrieve and Generate.
- Included three microflows to open a chat page as examples for Amazon Bedrock and OpenAI.
Version: 1.0.0
Framework Version: 9.24.2
Release Notes: Initial release.