From a32e70cac50dac151893beca2cd73daa0ca3a855 Mon Sep 17 00:00:00 2001 From: liamsommer-mx Date: Wed, 2 Apr 2025 09:53:19 +0200 Subject: [PATCH 01/16] SAS-1165: updated supported models (Bedrock/OpenAI) and SP versions; changed all occurences of GenAI For Mendix for new MP listings --- .../modules/aws/amazon-bedrock.md | 2 +- .../modules/genai/_index.md | 31 ++++++++++--------- .../modules/genai/how-to/_index.md | 4 ++- .../genai/how-to/ground_your_llm_in_data.md | 4 +-- .../how-to/integrate_function_calling.md | 4 +-- .../genai/how-to/start_from_a_starter_app.md | 2 +- .../genai/how-to/start_from_blank_app.md | 4 +-- .../mendix-cloud-genai/Mx GenAI Connector.md | 8 ++--- .../mendix-cloud-genai/navigate_mxgenai.md | 2 +- .../external-platforms/openai.md | 2 +- .../pg-vector-knowledge-base/_index.md | 2 +- .../genai-for-mendix/conversational-ui.md | 7 ++--- .../genai-for-mendix/genai-commons.md | 20 ++---------- .../genai-for-mendix/prompt-management.md | 4 +-- 14 files changed, 43 insertions(+), 53 deletions(-) diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/aws/amazon-bedrock.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/aws/amazon-bedrock.md index 4906202a665..43e7ee9bd07 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/aws/amazon-bedrock.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/aws/amazon-bedrock.md @@ -27,7 +27,7 @@ The Amazon Bedrock connector requires Mendix Studio Pro version 9.24.2 or above. To authenticate with Amazon Web Service (AWS), you must install and configure the [AWS Authentication connector version 3.0.0 or higher](https://marketplace.mendix.com/link/component/120333). It is crucial for the Amazon Bedrock connector to function correctly. For more information about installing and configuring the AWS Authentication connector, see [AWS Authentication](/appstore/modules/aws/aws-authentication/). -You must have the latest [GenAI Commons](/appstore/modules/genai/commons/) version, available in the [GenAI for Mendix](https://marketplace.mendix.com/link/component/227931) bundle. To make integration of generative AI capabilities as easy as possible, the Amazon Bedrock connector depends on the generic domain model and operations provided by the GenAI Commons module. +You must have the latest [GenAI Commons](https://marketplace.mendix.com/link/component/239448) version. To make integration of generative AI capabilities as easy as possible, the Amazon Bedrock connector depends on the generic domain model and operations provided by the GenAI Commons module. To ensure that your app can connect to Bedrock, you must also install and configure the [Encryption module](/appstore/modules/encryption/#configuration). diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/_index.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/_index.md index 1d23c73e665..5f7be7af6ea 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/_index.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/_index.md @@ -45,18 +45,20 @@ To help you get started, the following sections list the available GenAI compone | Asset | Description | Type | Studio Pro Version | |-------------------|---------------------------------------------------|----------------------------------|------------| -| [AI Bot Starter App](https://marketplace.mendix.com/link/component/227926) | Lets you kick-start the development of enterprise-grade AI chatbot experiences. For example, you can use it to create your own private enterprise-ready ChatGPT-like app. | Starter App | 10.12 | -| [Blank GenAI App](https://marketplace.mendix.com/link/component/227934) | Start from scratch to create a new application with GenAI capabilities and without any dependencies. | Starter App | 10.12 | -| [GenAI Showcase App](https://marketplace.mendix.com/link/component/220475) | Understand what you can build with generative AI. Understand how to implement the Mendix Cloud GenAI, OpenAI, and Amazon Bedrock connectors and how to integrate them with the Conversational UI module. |Showcase App | 9.24.2 | -| [RFP Assistant Starter App / Questionnaire Assistant Starter App](https://marketplace.mendix.com/link/component/235917) | The RFP Assistant Starter App and the Questionnaire Assistant Starter App leverage historical RFPs (or question-answer pairs) and a continuously updated knowledge base to generate and assist in editing responses to RFPs, offering a time-saving alternative to manually finding similar responses and enhancing the knowledge management process. | Starter App | 9.24.2 | -| [Support Assistant Starter App](https://marketplace.mendix.com/link/component/231035) | Learn how to combine common GenAI patterns, such as function calling and RAG to build your support assistant. Connect it to a model like Anthropic Claude via Mendix Cloud GenAI or Amazon Bedrock or use an (Azure) OpenAI subscription. | Starter App | 10.12 | -| [GenAI For Mendix](https://marketplace.mendix.com/link/component/227931) |[GenAI Commons](/appstore/modules/genai/commons/): Common capabilities that allow all GenAI connectors to be integrated with the other modules. You can also implement your own connector based on this. | Common Module | 9.24.2 | -| |[Conversational UI](/appstore/modules/genai/conversational-ui/): Create a Conversational UI for a new or existing app. | UI Module | 9.24.2 | -| |[Mendix Cloud GenAI Connector](/appstore/modules/genai/MxGenAI/): Connect to Mendix Cloud and utilize Mendix Cloud GenAI resource packs directly within your Mendix application. | Connector Module | 9.24.2 | -| [OpenAI Connector](/appstore/modules/genai/openai/) | Connect to (Azure) OpenAI. | Connector Module | 9.24.2 | -| [Amazon Bedrock Connector](/appstore/modules/aws/amazon-bedrock/) | Connect to Amazon Bedrock. Use Retrieve and Generate or Bedrock agents. | Connector Module | 9.24.2 | -| [PgVector Knowledge Base](/appstore/modules/genai/pgvector/) | Manage and interact with a PostgreSQL *pgvector* Knowledge Base. | Connector Module | 9.24.2 | -| [Snowflake Showcase App](https://marketplace.mendix.com/link/component/225845) | Learn how to implement the Cortex functionalities in your app. | Showcase App | 10.12 | +| [AI Bot Starter App](https://marketplace.mendix.com/link/component/227926) | Lets you kick-start the development of enterprise-grade AI chatbot experiences. For example, you can use it to create your own private enterprise-ready ChatGPT-like app. | Starter App | 10.21 | +| [Blank GenAI App](https://marketplace.mendix.com/link/component/227934) | Start from scratch to create a new application with GenAI capabilities and without any dependencies. | Starter App | 10.21 | +| [GenAI Showcase App](https://marketplace.mendix.com/link/component/220475) | Understand what you can build with generative AI. Understand how to implement the Mendix Cloud GenAI, OpenAI, and Amazon Bedrock connectors and how to integrate them with the Conversational UI module. |Showcase App | 10.21 | +| [RFP Assistant Starter App / Questionnaire Assistant Starter App](https://marketplace.mendix.com/link/component/235917) | The RFP Assistant Starter App and the Questionnaire Assistant Starter App leverage historical RFPs (or question-answer pairs) and a continuously updated knowledge base to generate and assist in editing responses to RFPs, offering a time-saving alternative to manually finding similar responses and enhancing the knowledge management process. | Starter App | 10.21 | +| [Support Assistant Starter App](https://marketplace.mendix.com/link/component/231035) | Learn how to combine common GenAI patterns, such as function calling and RAG to build your support assistant. Connect it to a model like Anthropic Claude via Mendix Cloud GenAI or Amazon Bedrock or use an (Azure) OpenAI subscription. | Starter App | 10.21 | +| [GenAI Commons](/appstore/modules/genai/commons/) | Common capabilities that allow all GenAI connectors to be integrated with the other modules. You can also implement your own connector based on this. | Common Module | 10.21 | +| [Conversational UI](/appstore/modules/genai/conversational-ui/) | Create a Conversational UI, manage prompts or monitor token consumption in your app. | UI Module | 10.21 | +| [Mendix Cloud GenAI Connector](/appstore/modules/genai/MxGenAI/) | Connect to Mendix Cloud and utilize Mendix Cloud GenAI resource packs directly within your Mendix application. | Connector Module | 10.21 | +| [OpenAI Connector](/appstore/modules/genai/openai/) | Connect to (Azure) OpenAI. | Connector Module | 10.21 | +| [Amazon Bedrock Connector](/appstore/modules/aws/amazon-bedrock/) | Connect to Amazon Bedrock. Use Retrieve and Generate or Bedrock agents. | Connector Module | 10.21 | +| [PgVector Knowledge Base](/appstore/modules/genai/pgvector/) | Manage and interact with a PostgreSQL *pgvector* Knowledge Base. | Connector Module | 10.21 | +| [Snowflake Showcase App](https://marketplace.mendix.com/link/component/225845) | Learn how to implement the Cortex functionalities in your app. | Showcase App | 10.21 | + +Older versions of the marketplace modules and GenAI Showcase App are available in Studio Pro 9.24.2. ### Available Models {#models} @@ -67,7 +69,7 @@ Mendix connectors offer direct support for the following models: | Mendix Cloud GenAI | Anthropic Claude 3.5 Sonnet | Chat Completions | text, image, document | text | Function calling | | | Cohere Embed English, Cohere Embed Multilingual | Embeddings | text | embeddings | | | Azure / OpenAI | gpt-3.5-turbo | Chat completions | text | text | Function calling | -| | gpt-4, gpt-4-turbo, gpt-4o, gpt-4o mini | Chat completions | text, image | text | Function calling | +| | gpt-4, gpt-4-turbo, gpt-4o, gpt-4o mini gpt-4.5-preview | Chat completions | text, image | text | Function calling | | | DALL·E 2, DALL·E 3 | Image generation | text | image | | | | text-embedding-ada-002, text-embedding-3-small, text-embedding-3-large | Embeddings | text | embeddings| | | Amazon Bedrock | Amazon Titan Text G1 - Express, Amazon Titan Text G1 - Lite, Amazon Titan Text G1 - Premier | Chat Completions | text, document (except Titan Premier) | text | | @@ -77,11 +79,12 @@ Mendix connectors offer direct support for the following models: | | Amazon Titan Image Generator G1 | Image generation | text | image | | | | Amazon Titan Embeddings Text v2 | Embeddings | text | embeddings| | | | Anthropic Claude 2.0, Anthropic Claude 2.1| Chat Completions | text, document | text | | -| | Anthropic Claude 3 Sonnet, Anthropic Claude 3.5 Sonnet, Anthropic Claude 3.5 Sonnet v2, Anthropic Claude 3 Haiku, Anthropic Claude 3 Opus | Chat Completions | text, image, document | text | Function calling | +| | Anthropic Claude 3 Sonnet, Anthropic Claude 3.5 Sonnet, Anthropic Claude 3.5 Sonnet v2, Anthropic Claude 3 Haiku, Anthropic Claude 3 Opus, Anthropic Claude 3.5 Haiku, Anthropic Claude 3.7 Sonnet | Chat Completions | text, image, document | text | Function calling | | | Cohere Command | Chat Completions | text, document | text | | | | Cohere Command Light | Chat Completions | text | text | | | | Cohere Command R, Cohere Command R+ | Chat Completions | text, document | text | Function calling | | | Cohere Embed English, Cohere Embed Multilingual | Embeddings | text | embeddings | | +| | DeepSeek, DeepSeek-R1 | Text | text | document | | | | Meta Llama 2, MetaLlama 3| Chat Completions | text, document | text | | | | Meta Llama 3.1| Chat Completions | text, document | text | Function calling | | | Mistral AI Instruct | Chat Completions | text. document | text | | diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/_index.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/_index.md index e6529723450..828037d157d 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/_index.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/_index.md @@ -30,7 +30,9 @@ Generative Artificial Intelligence (GenAI) transforms business applications, emp ### Additional Resources * Basic documentation on [GenAI Concepts](/appstore/modules/genai/get-started/) is an essential resource for anyone beginning their GenAI journey. -* The [GenAI For Mendix](https://marketplace.mendix.com/link/component/227931) is a bundle containing [GenAI Commons](/appstore/modules/genai/commons/), [Conversational UI](/appstore/modules/genai/conversational-ui/), and the [Mendix Cloud GenAI Resource Packs](/appstore/modules/genai/MxGenAI/) offering a comprehensive overview of the technical aspects. +* The [GenAICommons](/appstore/modules/genai/commons/) module as a prerequisite for all GenAI components. +* The [ConversationalUI](/appstore/modules/genai/conversational-ui/) module that offers UI snippets for chat, token consumption monitoring and prompt management. +* The [Mendix Cloud GenAI Resource Packs](/appstore/modules/genai/MxGenAI/) to learn how to quickly access GenAI capabilities from a Mendix app. * The [OpenAI](/appstore/modules/genai/openai/) provides essential information about the OpenAI connector. * The [Amazon Bedrock](/appstore/modules/aws/amazon-bedrock/) provides key information about the AWS Bedrock connector. * The [PGVector Knowledge Base](/appstore/modules/genai/pgvector/) offers the option for a private knowledge base outside of the LLM infrastructure. diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/ground_your_llm_in_data.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/ground_your_llm_in_data.md index a24777e25ef..67dbaca8b14 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/ground_your_llm_in_data.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/ground_your_llm_in_data.md @@ -21,7 +21,7 @@ Before implementing this capability into your app, make sure you meet the follow * Start from scratch: to simplify your first use case, start building from a preconfigured setup [Blank GenAI Starter App](https://marketplace.mendix.com/link/component/227934). For more information, see [Build a Chatbot from Scratch Using the Blank GenAI App](/appstore/modules/genai/how-to/blank-app/). -* Install the [GenAI For Mendix](https://marketplace.mendix.com/link/component/227931) bundle (version 2.2.0 and above) from the Mendix Marketplace. If you start with the Blank GenAI App, you can skip this installation. +* Install the [Mendix GenAI Connector](https://marketplace.mendix.com/link/component/239449) and [GenAICommons](https://marketplace.mendix.com/link/component/239448) modules (version 2.2.0 and above) from the Mendix Marketplace. If you start with the Blank GenAI App, you can skip this installation. * Set up a Knowledge Base resource within the [Mendix Cloud GenAI Resource Packs](/appstore/modules/genai/mx-cloud-genai/resource-packs/). @@ -37,7 +37,7 @@ Before implementing this capability into your app, make sure you meet the follow ### Choosing the Infrastructure -Since this document focuses on the [Mendix Cloud GenAI Resource Packs](/appstore/modules/genai/mx-cloud-genai/resource-packs/), ensure that you have the [Mendix Cloud GenAI Connector](/appstore/modules/genai/mx-cloud-genai/MxGenAI-connector/), which is part of the [GenAI For Mendix](https://marketplace.mendix.com/link/component/227931) bundle on the Marketplace. +Since this document focuses on the [Mendix Cloud GenAI Resource Packs](/appstore/modules/genai/mx-cloud-genai/resource-packs/), ensure that you have the [Mendix Cloud GenAI Connector](https://marketplace.mendix.com/link/component/239449) installed. Follow the [Navigate through the Mendix Cloud GenAI Portal](/appstore/modules/genai/mx-cloud-genai/Navigate-MxGenAI/) instructions to collect the resources keys. diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/integrate_function_calling.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/integrate_function_calling.md index 9e0b712d4b0..ed92e619ab8 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/integrate_function_calling.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/integrate_function_calling.md @@ -25,7 +25,7 @@ Before integrating function calling into your app, make sure you meet the follow * Be on Mendix Studio Pro 10.12.4 or higher. -* Installation: Install the [GenAI For Mendix](https://marketplace.mendix.com/link/component/227931) bundle from the Mendix marketplace. If you start with the Blank GenAI App, skip this installation. +* Install the [Mendix GenAI Connector](https://marketplace.mendix.com/link/component/239449) and [GenAICommons](https://marketplace.mendix.com/link/component/239448) modules (version 2.2.0 and above) from the Mendix Marketplace. If you start with the Blank GenAI App, you can skip this installation. * Intermediate knowledge of the Mendix platform: Familiarity with Mendix Studio Pro, microflows, and modules. @@ -46,7 +46,7 @@ In this example, two functions will be implemented with the following purposes: Selecting the infrastructure for integrating GenAI into your Mendix application is the first step. Depending on your use case and preferences, you can choose from the following options: -* [Mendix Cloud GenAI Resource Packs](/appstore/modules/genai/MxGenAI/): The Mendix Cloud GenAI Connector is part of the [GenAI For Mendix](https://marketplace.mendix.com/link/component/227931) bundle on the marketplace, allowing you to utilize Mendix Cloud GenAI Resource Packs directly within your Mendix application. +* [Mendix Cloud GenAI Resource Packs](/appstore/modules/genai/MxGenAI/): The [Mendix Cloud GenAI Connector](https://marketplace.mendix.com/link/component/239449) allows you to utilize Mendix Cloud GenAI Resource Packs directly within your Mendix application. * [OpenAI](/appstore/modules/genai/openai/): The [OpenAI Connector](https://marketplace.mendix.com/link/component/220472) supports both OpenAI’s platform and Azure’s OpenAI service. diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/start_from_a_starter_app.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/start_from_a_starter_app.md index 6768d3ba60d..cc934e4cf4b 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/start_from_a_starter_app.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/start_from_a_starter_app.md @@ -44,7 +44,7 @@ To simplify your first use case, start building a chatbot using the [AI Bot Star Selecting the infrastructure for integrating GenAI into your Mendix application is the first step. Depending on your use case and preferences, you can choose from the following options: -* [Mendix Cloud GenAI Resources Packs](/appstore/modules/genai/MxGenAI/): Part of the [GenAI For Mendix](https://marketplace.mendix.com/link/component/227931), integrates LLMs by dragging and dropping common operations from its toolbox in Studio Pro. +* [Mendix Cloud GenAI Resources Packs](/appstore/modules/genai/MxGenAI/): The [Mendix Cloud GenAI Connector](https://marketplace.mendix.com/link/component/239449) integrates LLMs by dragging and dropping common operations from its toolbox in Studio Pro. * [OpenAI](/appstore/modules/genai/openai/): The [OpenAI Connector](https://marketplace.mendix.com/link/component/220472) supports OpenAI’s platform and Azure’s OpenAI service. diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/start_from_blank_app.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/start_from_blank_app.md index da8cdee1ca8..46c13cd3b5a 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/start_from_blank_app.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/start_from_blank_app.md @@ -42,7 +42,7 @@ To start building your smart app with a blank GenAI App template, download the [ ### Important Modules -The [Blank GenAI App Template](https://marketplace.mendix.com/link/component/227934) includes an essential pre-installed bundle called [GenAI For Mendix](https://marketplace.mendix.com/link/component/227931), which is beneficial to familiarize yourself with the GenAI functionalities Mendix can offer, as it includes: +The [Blank GenAI App Template](https://marketplace.mendix.com/link/component/227934) has the essential GenAI modules pre-installed, which is beneficial to familiarize yourself with the GenAI functionalities Mendix can offer, as it includes: * The [GenAI Commons](/appstore/modules/genai/commons/) module: provides pre-built operations and data structures for seamless integration with platform-supported GenAI connectors, such as the Mendix Cloud GenAI, OpenAI, or Amazon Bedrock. @@ -54,7 +54,7 @@ The [Blank GenAI App Template](https://marketplace.mendix.com/link/component/227 Selecting the infrastructure for integrating GenAI into your Mendix application is the first step. Depending on your use case and preferences, you can choose from the following options: -* [Mendix Cloud GenAI Resources Packs](/appstore/modules/genai/MxGenAI/): Part of [GenAI For Mendix](https://marketplace.mendix.com/link/component/227931), integrates LLMs by dragging and dropping common operations from its toolbox in Studio Pro. +* [Mendix Cloud GenAI Resources Packs](/appstore/modules/genai/MxGenAI/): The [Mendix Cloud GenAI Connector](https://marketplace.mendix.com/link/component/239449) integrates LLMs by dragging and dropping common operations from its toolbox in Studio Pro. * [OpenAI](/appstore/modules/genai/openai/): The [OpenAI Connector](https://marketplace.mendix.com/link/component/220472) supports both OpenAI’s platform and Azure’s OpenAI service. * [Amazon Bedrock](/appstore/modules/genai/bedrock/): The [Amazon Bedrock Connector](https://marketplace.mendix.com/link/component/215042) allows you to leverage Amazon Bedrock’s fully managed service to integrate foundation models from Amazon and leading AI providers. diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md index 7fe5777ccdb..056e83623dd 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md @@ -10,7 +10,7 @@ aliases: ## Introduction -The Mendix Cloud GenAI connector (delivered as part of [GenAI for Mendix](https://marketplace.mendix.com/link/component/227931)) lets you utilize Mendix Cloud GenAI resource packs directly within your Mendix application. It allows you to integrate generative AI by dragging and dropping common operations from its toolbox. Feel free to contact [genai-resource-packs@mendix.com](mailto:genai-resource-packs@mendix.com) to learn more. +The [Mendix Cloud GenAI connector](https://marketplace.mendix.com/link/component/239449) lets you utilize Mendix Cloud GenAI resource packs directly within your Mendix application. It allows you to integrate generative AI by dragging and dropping common operations from its toolbox. Feel free to contact [genai-resource-packs@mendix.com](mailto:genai-resource-packs@mendix.com) to learn more. ### Typical Use Cases @@ -70,17 +70,17 @@ To use this connector, you need configuration keys to authenticate to the Mendix ### Dependencies {#dependencies} -* Mendix Studio Pro version [9.24.2](/releasenotes/studio-pro/9.24/#9242) or above +* [GenAICommons](https://marketplace.mendix.com/link/component/239448) * [Encryption](https://marketplace.mendix.com/link/component/1011) * [Community Commons](https://marketplace.mendix.com/link/component/170) ## Installation -Add the [dependencies](#dependencies) listed above from the Marketplace. On the Marketplace, the Mendix Cloud GenAI connector is bundled inside of the [GenAI for Mendix](https://marketplace.mendix.com/link/component/227931) which also contains GenAI commons operations and logic. To import this module into your app, follow the instructions in the [Use Marketplace Content](/appstore/use-content/). +Add the [dependencies](#dependencies) listed above from the Marketplace. To import this module into your app, follow the instructions in the [Use Marketplace Content](/appstore/use-content/). ## Configuration {#configuration} -After installing the Mendix Cloud GenAI connector, you can find it in the **App Explorer** inside of the **Add-ons** section. The connector includes a domain model and several activities to help integrate your app with the Mendix Cloud GenAI service. To implement the connector, simply use its actions in a microflow. You can find the Mendix GenAI actions in the microflow toolbox. Note that the module is protected, meaning it cannot be modified and the microflow logic is not visible. For details about each exposed operation, see the [Operations](#operations) section below or refer to the documentation provided within the module. For more information on Add-on modules, see [Consuming Add-on Modules and Solutions](/refguide/consume-add-on-modules-and-solutions/). +After installing the Mendix Cloud GenAI connector, you can find it in the **App Explorer** inside of the **Add-ons** section. The connector includes a domain model and several activities to help integrate your app with the Mendix Cloud GenAI service. To implement the connector, simply use its actions in a microflow. You can find the Mendix GenAI actions in the microflow toolbox. Follow the steps below to get started: diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/navigate_mxgenai.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/navigate_mxgenai.md index f8f1523d1a5..3718fd547ec 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/navigate_mxgenai.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/navigate_mxgenai.md @@ -51,7 +51,7 @@ To create a new key, click **Create Key**, add a description, and save the chang {{< figure src="/attachments/appstore/platform-supported-content/modules/genai/navigate_mxgenai/GenAIResource_KeyGeneration.png" >}} -Once created, the key can be used in the Mendix application via the Mendix Cloud GenAI Connector, which is part of the GenAI for the Mendix bundle. When you create a key for a knowledge base, an embedding key is automatically generated and marked accordingly in the keys overview. +Once created, the key can be used in the Mendix application via the Mendix Cloud GenAI Connector. When you create a key for a knowledge base, an embedding key is automatically generated and marked accordingly in the keys overview. ### Content (Only for Knowledge Bases) diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/external-platforms/openai.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/external-platforms/openai.md index 1ce528f4640..23b131c56b6 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/external-platforms/openai.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/external-platforms/openai.md @@ -87,7 +87,7 @@ To use this connector, you need to either sign up for an [OpenAI account](https: The following modules from the Marketplace need to be installed: -* GenAI Commons module, available in the [GenAI for Mendix](https://marketplace.mendix.com/link/component/227931) marketplace listing. +* [GenAI Commons](https://marketplace.mendix.com/link/component/239448) module * [Encryption](https://marketplace.mendix.com/link/component/1011) module * [Community Commons](https://marketplace.mendix.com/link/component/170) module diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/external-platforms/pg-vector-knowledge-base/_index.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/external-platforms/pg-vector-knowledge-base/_index.md index dedf4689e80..e1f6ddf3ebd 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/external-platforms/pg-vector-knowledge-base/_index.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/external-platforms/pg-vector-knowledge-base/_index.md @@ -47,7 +47,7 @@ You should have access to your own (remote) PostgreSQL database server with the * [Encryption](https://marketplace.mendix.com/link/component/1011) module * [Community Commons](https://marketplace.mendix.com/link/component/170) module * [Database Connector](https://marketplace.mendix.com/link/component/2888) module -* GenAI Commons module in the [GenAI For Mendix](https://marketplace.mendix.com/link/component/227931) bundle +* [GenAI Commons](https://marketplace.mendix.com/link/component/239448) ## Installation {#installation} diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/conversational-ui.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/conversational-ui.md index fdb930f24ab..af669dc55cb 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/conversational-ui.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/conversational-ui.md @@ -10,7 +10,7 @@ aliases: ## Introduction {#introduction} -With the Conversational UI module (available as part of [GenAI for Mendix](https://marketplace.mendix.com/link/component/227931)), you can create a GenAI-based chat user interface. It contains the needed data model, pages, snippets, and building blocks. You can integrate with any LLM and knowledge base to create your full-screen, sidebar, or modal chat. It integrates with the Atlas framework and is the basis for the [AI Bot Starter App](https://marketplace.mendix.com/link/component/227926). It is also included in the [Blank GenAI App](https://marketplace.mendix.com/link/component/227934), the [Support Assistant Starter App](https://marketplace.mendix.com/link/component/231035), and the [RFP Assistant Starter App](https://marketplace.mendix.com/link/component/235917). +With the [Conversational UI](https://marketplace.mendix.com/link/component/239450) module you can create a GenAI-based chat user interface. It contains the needed data model, pages, snippets, and building blocks. You can integrate with any LLM and knowledge base to create your full-screen, sidebar, or modal chat. It integrates with the Atlas framework and is the basis for the [AI Bot Starter App](https://marketplace.mendix.com/link/component/227926). It is also included in the [Blank GenAI App](https://marketplace.mendix.com/link/component/227934), the [Support Assistant Starter App](https://marketplace.mendix.com/link/component/231035), and the [RFP Assistant Starter App](https://marketplace.mendix.com/link/component/235917). Mendix has produced a [Conversational AI Design Checklist](/howto/front-end/conversation-checklist/) with some best practices for introducing conversational AI into your app. @@ -47,16 +47,15 @@ This module is intended to enable building chat interactions between a human use To use the Conversational UI module, your Mendix Studio Pro version must be [9.24.2](/releasenotes/studio-pro/9.24/#9242) or higher. -When you download [GenAI for Mendix](https://marketplace.mendix.com/link/component/227931) from the marketplace, [GenAI Commons](/appstore/modules/genai/commons/) and the [Mendix Cloud GenAI Connector](/appstore/modules/genai/MxGenAI/) are already included. - You must also ensure you have the other prerequisite modules that Conversational UI requires. These modules are included by default in the [Blank GenAI App](https://marketplace.mendix.com/link/component/227934), the [AI Bot Starter App](https://marketplace.mendix.com/link/component/227926), the [Support Assistant Starter App](https://marketplace.mendix.com/link/component/231035), and the [RFP Assistant Starter App](https://marketplace.mendix.com/link/component/235917). If not, you need to install them manually. +* [GenAI Commons](https://marketplace.mendix.com/link/239448) * [Atlas Core](https://marketplace.mendix.com/link/component/117187) * [Data Widgets](https://marketplace.mendix.com/link/component/116540) * [Nanoflow Commons](https://marketplace.mendix.com/link/component/109515) * [Web Actions](https://marketplace.mendix.com/link/component/114337) -Finally, you must also set up a connector that is compatible with [GenAI Commons](/appstore/modules/genai/commons/). One option is to use the Mendix Cloud GenAI connector, which is part of the above Marketplace listing package. For more information on how to configure this connector, see the [Configuration](/appstore/modules/genai/mx-cloud-genai/MxGenAI-connector/#configuration) section of *Mendix Cloud GenAI connector*. Additionally, Mendix offers platform-supported integration with [(Azure) OpenAI](/appstore/modules/genai/openai/) and [Amazon Bedrock](/appstore/modules/aws/amazon-bedrock/). If desired, you need to download these integrations manually from the Marketplace. Alternatively, you can integrate with custom models by creating your own connector and making its operations and object structure compatible with the [GenAI Commons](/appstore/modules/genai/commons/) `Request` and `Response`. +Finally, you must also set up a connector that is compatible with [GenAI Commons](/appstore/modules/genai/commons/). One option is to use the [Mendix Cloud GenAI connector](https://marketplace.mendix.com/link/component/239449). For more information on how to configure this connector, see the [Configuration](/appstore/modules/genai/mx-cloud-genai/MxGenAI-connector/#configuration) section of *Mendix Cloud GenAI connector*. Additionally, Mendix offers platform-supported integration with [(Azure) OpenAI](/appstore/modules/genai/openai/) and [Amazon Bedrock](/appstore/modules/aws/amazon-bedrock/). If desired, you need to download these integrations manually from the Marketplace. Alternatively, you can integrate with custom models by creating your own connector and making its operations and object structure compatible with the [GenAI Commons](/appstore/modules/genai/commons/) `Request` and `Response`. ## Installation {#installation} diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/genai-commons.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/genai-commons.md index 59631f903d6..726173b9c6b 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/genai-commons.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/genai-commons.md @@ -11,7 +11,7 @@ aliases: ## Introduction {#introduction} -The GenAI Commons module, included in the [GenAI For Mendix](https://marketplace.mendix.com/link/component/227931) bundle, combines common generative AI patterns found across various models on the market. Platform-supported GenAI-connectors use the underlying data structures and their operations. This makes it easier to develop vendor-agnostic AI-enhanced apps with Mendix, for example by using one of the connectors or the [Conversational UI](/appstore/modules/genai/conversational-ui/) module. +The [GenAI Commons](https://marketplace.mendix.com/link/component/239448) module combines common generative AI patterns found across various models on the market. Platform-supported GenAI-connectors use the underlying data structures and their operations. This makes it easier to develop vendor-agnostic AI-enhanced apps with Mendix, for example by using one of the connectors or the [Conversational UI](/appstore/modules/genai/conversational-ui/) module. If two different connectors both adhere to the GenAI Commons module, they can be easily swapped, which reduces dependency on the model providers. In addition, the initial implementation of AI capabilities using the connectors becomes a drag-and-drop experience, so that developers can quickly get started. The module exposes useful operations which developers can use to build a request to a large language model (LLM) and to handle the response. @@ -31,16 +31,14 @@ You must also download the [Community Commons](/appstore/modules/community-commo If you are starting from the [Blank GenAI app](https://marketplace.mendix.com/link/component/227934), or the [AI Bot Starter App](https://marketplace.mendix.com/link/component/227926), the GenAI Commons module is already included and does not need to be downloaded manually. -If you start from a blank app, or have an existing project where you want to include a connector for which the GenAI Commons module is required, you must install GenAI Commons manually. First, install the [Community Commons](/appstore/modules/community-commons-function-library/) module, and then follow the instructions in [How to Use Marketplace Content](/appstore/use-content/) to install the [GenAI For Mendix](https://marketplace.mendix.com/link/component/227931) bundle that includes the GenAI Commons, Conversational UI and Mendix Cloud GenAI Connector modules. +If you start from a blank app, or have an existing project where you want to include a connector for which the GenAI Commons module is required, you must install GenAI Commons manually. First, install the [Community Commons](/appstore/modules/community-commons-function-library/) module, and then follow the instructions in [How to Use Marketplace Content](/appstore/use-content/) to install the [GenAI Commons](https://marketplace.mendix.com/link/component/239448) module. ## Implementation {#implementation} -GenAI Commons is the foundation of large language model implementations within the [Mendix Cloud GenAI Connector](/appstore/modules/genai/MxGenAI/), [OpenAI connector](/appstore/modules/genai/openai/), and the [Amazon Bedrock connector](/appstore/modules/genai/bedrock/), but may also be used to build other GenAI service implementations on top of it by reusing the provided domain model and exposed actions. +GenAI Commons is the foundation of large language model implementations within the [Mendix Cloud GenAI Connector](/appstore/modules/genai/MxGenAI/), [OpenAI connector](/appstore/modules/genai/openai/), and the [Amazon Bedrock connector](/appstore/modules/genai/bedrock/), but may also be used to build other GenAI service implementations on top of it by reusing the provided domain model and exposed actions. Although GenAI Commons technically defines additional capabilities typically found in chat completion APIs, such as image processing (vision) and tools (function calling), it depends on the connector module of choice for whether these are actually implemented and supported by the LLM. To learn which additional capabilities a connector supports and for which models these can be used, refer to the documentation of that connector. -The GenAI Commons module is [protected](/refguide/consume-add-on-modules-and-solutions/), which means that it cannot be changed and the logic of the microflows is not visible. For information about what each exposed operation does, see [Microflows](#microflows), or refer to the documentation inside the module. - ### Token Usage GenAI Commons can help store usage data which allows admins to understand the token usage. Usage data is only persisted if the constant `StoreUsageMetrics` is set to `true` and the GenAI connector of choice has implemented the operation to store token usage. In general, this is only supported for chat completions and embedding operations. @@ -840,18 +838,6 @@ This microflow creates a new [MetadataCollection](#metadatacollection-entity) an This section lists possible solutions to known issues. -### Internal Errors in Hidden Documents - -Adding the GenAI Commons module to an existing project causes internal errors in hidden documents in Studio Pro. - -#### Cause - -The Java actions from the [CommunityCommons](https://marketplace.mendix.com/link/component/170) module are not compatible with the current version of the GenAI Commons module. - -#### Solution - -Update the [CommunityCommons](https://marketplace.mendix.com/link/component/170) module to the latest version. - ### Outdated JDK Version Causing Errors while Calling a REST API {#outdated-jdk-version} The Java Development Kit (JDK) is a framework needed by Mendix Studio Pro to deploy and run applications. For more information, see [Studio Pro System Requirements](/refguide/system-requirements/). Usually, the correct JDK version is installed during the installation of Studio Pro, but in some cases, it may be outdated. An outdated version can cause exceptions when calling REST-based services with large data volumes, like for example embeddings operations or chat completions with vision. diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/prompt-management.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/prompt-management.md index bdca1461b06..7be00869455 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/prompt-management.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/prompt-management.md @@ -9,7 +9,7 @@ description: "Describes the Prompt Management functionality that assists develop ## Introduction Prompt management allows users to develop, test, and optimize their GenAI use cases by creating effective prompts to interact with large language models (LLM). -Using the Conversational UI module (available as part of [GenAI for Mendix](https://marketplace.mendix.com/link/component/227931)), you can use the prompt management interface in your app to define prompts at runtime and manage multiple versions over time. It also supports defining variables that serve as placeholders for data from the app session context which are replaced by actual values when the end user interacts with the app. The module contains the necessary data model, pages, and snippets to include a prompt management interface to your app and get started. +Using the [Conversational UI](https://marketplace.mendix.com/link/component/239450) module you can use the prompt management interface in your app to define prompts at runtime and manage multiple versions over time. It also supports defining variables that serve as placeholders for data from the app session context which are replaced by actual values when the end user interacts with the app. The module contains the necessary data model, pages, and snippets to include a prompt management interface to your app and get started. ### Typical Use Cases @@ -69,7 +69,7 @@ For example, download and run the [GenAI Showcase App](https://marketplace.mendi You need at least one GenAI connector that follows the principles of GenAI commons to interact with LLMs from the Prompt Management logic. To test a prompt, you must configure at least one Deployed Model for your chosen connector. Refer to the specific connector’s documentation for detailed setup instructions on configuring the Deployed Model. -* For [Mendix Cloud GenAI](https://marketplace.mendix.com/link/component/227931), included by default, importing the **Key** from the Mendix portal automatically creates a MxCloud Deployed Model. This is part of the [configuration](/appstore/modules/genai/mx-cloud-genai/MxGenAI-connector/#configuration). +* For [Mendix Cloud GenAI](https://marketplace.mendix.com/link/component/239449) importing the **Key** from the Mendix portal automatically creates a MxCloud Deployed Model. This is part of the [configuration](/appstore/modules/genai/mx-cloud-genai/MxGenAI-connector/#configuration). * For [Amazon Bedrock](https://marketplace.mendix.com/link/component/215042), the creation of Bedrock Deployed Models is part of the [model synchronization mechanism](/appstore/modules/aws/amazon-bedrock/#sync-models). * For [OpenAI](https://marketplace.mendix.com/link/component/220472), the configuration of OpenAI Deployed Models is part of the [configuration](/appstore/modules/genai/reference-guide/external-connectors/openai/#general-configuration). From cb2f23e93f37b80e7d35c78e3133110b4f3815a5 Mon Sep 17 00:00:00 2001 From: liamsommer-mx Date: Wed, 2 Apr 2025 09:54:08 +0200 Subject: [PATCH 02/16] SAS-1165: wording fixes --- .../platform-supported-content/modules/genai/how-to/_index.md | 2 +- .../modules/genai/how-to/start_from_a_starter_app.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/_index.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/_index.md index 828037d157d..29f9113a459 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/_index.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/_index.md @@ -37,6 +37,6 @@ Generative Artificial Intelligence (GenAI) transforms business applications, emp * The [Amazon Bedrock](/appstore/modules/aws/amazon-bedrock/) provides key information about the AWS Bedrock connector. * The [PGVector Knowledge Base](/appstore/modules/genai/pgvector/) offers the option for a private knowledge base outside of the LLM infrastructure. -For any additional feedback, send a message in the #genai-connectors channel on the Mendix Community Slack. You can sign up for the Mendix Community [here](https://mendixcommunity.slack.com/join/shared_invite/zt-270ys3pwi-kgWhJUwWrKMEMuQln4bqrQ#/shared-invite/email). +For any additional feedback, send a message in the [#genai-connectors](https://mendixcommunity.slack.com/archives/C07P8NRBLN9) channel on the Mendix Community Slack. You can sign up for the Mendix Community [here](https://mendixcommunity.slack.com/join/shared_invite/zt-270ys3pwi-kgWhJUwWrKMEMuQln4bqrQ#/shared-invite/email). ## Documents in this Category diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/start_from_a_starter_app.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/start_from_a_starter_app.md index cc934e4cf4b..4d59d653edb 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/start_from_a_starter_app.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/start_from_a_starter_app.md @@ -50,7 +50,7 @@ Selecting the infrastructure for integrating GenAI into your Mendix application * [Amazon Bedrock](/appstore/modules/genai/bedrock/): The [Amazon Bedrock Connector](https://marketplace.mendix.com/link/component/215042) allows you to leverage Amazon Bedrock’s fully managed service to integrate foundation models from Amazon and leading AI providers. -* Your Own Connector: Optionally, if you prefer a custom connector, you can integrate your chosen infrastructure. However, this document focuses on the OpenAI and Bedrock connectors, as they offer comprehensive support and ease of use to get started. +* Your Own Connector: Optionally, if you prefer a custom connector, you can integrate your chosen infrastructure. However, this document focuses on the platform-supported connectors, as they offer comprehensive support and ease of use to get started. ### Getting Started From 4e426ad47d35f7a5883fa588f0fcec0f9e7c1acc Mon Sep 17 00:00:00 2001 From: liamsommer-mx Date: Wed, 2 Apr 2025 11:27:40 +0200 Subject: [PATCH 03/16] SAS-1165: resolved GenAI for Mendix section --- .../conversational-ui/_index.md | 22 +++++++++++++++++++ .../conversational-ui.md | 4 ++-- .../prompt-management.md | 4 +++- .../external-platforms/_index.md | 2 +- .../{genai-for-mendix => }/genai-commons.md | 2 +- .../genai-for-mendix/_index.md | 22 ------------------- 6 files changed, 29 insertions(+), 27 deletions(-) create mode 100644 content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/_index.md rename content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/{genai-for-mendix => conversational-ui}/conversational-ui.md (99%) rename content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/{genai-for-mendix => conversational-ui}/prompt-management.md (98%) rename content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/{genai-for-mendix => }/genai-commons.md (99%) delete mode 100644 content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/_index.md diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/_index.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/_index.md new file mode 100644 index 00000000000..a19306b34dd --- /dev/null +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/_index.md @@ -0,0 +1,22 @@ +--- +title: "Conversational UI" +url: /appstore/modules/genai/conversational-ui/ +linktitle: "Conversational UI Module" +weight: 20 +description: "Provides information on the ConversationalUI Module." +no_list: false +aliases: + - /appstore/modules/genai/genai-for-mx/ +--- + +## Introduction {#introduction} + +The [ConversationalUI](https://marketplace.mendix.com/link/component/239450) module provides page snippets to easily facilate a GenAI use case. + +By leveraging the tools and features provided in this module, you can: + +* Create a [Conversational UI](/appstore/modules/genai/conversational-ui/conversational-ui) with prebuilt pages and snippets to facilitate user-friendly chat interactions. +* Perform [Prompt Engineering](/appstore/modules/genai/prompt-engineering/) at runtime to optimize your AI-generated results via [Prompt Management](/appstore/modules/genai/conversational-ui/prompt-management/). +* Monitor your token consumption with the [Token Consumption Monitor](/appstore/modules/genai/conversational-ui/conversational-ui/#snippet-token-monitor), ensuring efficient use of resources. + +## Documents in This Category diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/conversational-ui.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/conversational-ui.md similarity index 99% rename from content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/conversational-ui.md rename to content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/conversational-ui.md index af669dc55cb..e0bf3c78270 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/conversational-ui.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/conversational-ui.md @@ -1,11 +1,11 @@ --- title: "Conversational UI" -url: /appstore/modules/genai/genai-for-mx/conversational-ui/ +url: /appstore/modules/genai/conversational-ui/conversational-ui/ linktitle: "Conversational UI" weight: 20 description: "Describes the Conversational UI marketplace module that assists developers in implementing conversational use cases such as an AI Bot." aliases: - - /appstore/modules/genai/conversational-ui/ + - /appstore/modules/genai/genai-for-mx/conversational-ui/ --- ## Introduction {#introduction} diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/prompt-management.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/prompt-management.md similarity index 98% rename from content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/prompt-management.md rename to content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/prompt-management.md index 7be00869455..ee6d818dfbd 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/prompt-management.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/prompt-management.md @@ -1,9 +1,11 @@ --- title: "Prompt Management" -url: /appstore/modules/genai/genai-for-mx/prompt-management/ +url: /appstore/modules/genai/conversational-ui/prompt-management/ linktitle: "Prompt Management" weight: 20 description: "Describes the Prompt Management functionality that assists developers and data scientists in implementing prompts in their GenAI Mendix applications use cases." +aliases: + - /appstore/modules/genai/genai-for-mx/prompt-management/ --- ## Introduction diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/external-platforms/_index.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/external-platforms/_index.md index ffb9f35d576..c469ce7cb00 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/external-platforms/_index.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/external-platforms/_index.md @@ -2,7 +2,7 @@ title: "Connectors to External Platforms" url: /appstore/modules/genai/reference-guide/external-connectors/ linktitle: "Connectors to External Platforms" -weight: 20 +weight: 30 description: "Provides information on connectors that enable seamless integration between Mendix applications and external platforms." no_list: false --- diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/genai-commons.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-commons.md similarity index 99% rename from content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/genai-commons.md rename to content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-commons.md index 726173b9c6b..4cc6f2e8c2c 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/genai-commons.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-commons.md @@ -3,7 +3,7 @@ title: "GenAI Commons" url: /appstore/modules/genai/genai-for-mx/commons/ linktitle: "GenAI Commons" description: "Describes the purpose, configuration and usage of the GenAI Commons module from the Mendix Marketplace that allows developers to integrate GenAI common principles and patterns into their Mendix app." -weight: 50 +weight: 10 aliases: - /appstore/modules/genai-commons/ - /appstore/modules/genai/commons/ diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/_index.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/_index.md deleted file mode 100644 index c39005deb1a..00000000000 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/_index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "GenAI For Mendix" -url: /appstore/modules/genai/genai-for-mx/ -linktitle: "GenAI For Mendix" -weight: 10 -description: "Provides information on the GenAI For Mendix Module." -no_list: false ---- - -## Introduction {#introduction} - -The [GenAI For Mendix](https://marketplace.mendix.com/link/component/227931) bundle provides comprehensive guidance on enhancing your Mendix applications with Generative AI. It contains [GenAI Commons](/appstore/modules/genai/commons/), [Conversational UI](/appstore/modules/genai/conversational-ui/), and the [Mendix Cloud GenAI Resource Packs](/appstore/modules/genai/MxGenAI/) offering a comprehensive overview of the technical aspects. - -By leveraging the tools and features provided in this bundle, you can: - -* Integrate with any LLM and knowledge base using the included [GenAI Commons](/appstore/modules/genai/commons/) module. -* Create a [Conversational UI](/appstore/modules/genai/conversational-ui/) with prebuilt pages and snippets to facilitate user-friendly interactions. -* Perform [Prompt Engineering](/appstore/modules/genai/prompt-engineering/) at runtime to optimize your AI-generated results via [Prompt Management](/appstore/modules/genai/genai-for-mx/prompt-management/). -* Monitor your token consumption with the Token Consumption Monitor, ensuring efficient use of resources. -* Integrate directly with Mendix Cloud GenAI Models and Knowledge Bases via [Mendix Cloud GenAI Resource Packs](/appstore/modules/genai/MxGenAI/), enhancing your application’s intelligence and responsiveness. - -## Documents in This Category From b7c60a5675307caba792438b629fbd43cd689efd Mon Sep 17 00:00:00 2001 From: liamsommer-mx Date: Fri, 4 Apr 2025 12:42:26 +0200 Subject: [PATCH 04/16] SAS-1180: changed configuration section to new open module page/snippet --- .../modules/genai/mendix-cloud-genai/Mx GenAI Connector.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md index 056e83623dd..0ee3f0e9699 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md @@ -86,7 +86,7 @@ Follow the steps below to get started: * Make sure to configure the [Encryption module](/appstore/modules/encryption/#configuration) before you connect your app to Mendix Cloud GenAI. * Add the module role `MxGenAIConnector.Administrator` to your Administrator **User roles** in the **Security** settings of your app. -* Add the `NAV_ConfigurationOverview_Open` microflow (**USE_ME** > **Configuration**) to your **Navigation** or register your key using the `Configuration_RegisterByString` microflow. +* Add the `Configuration_Overview` page (**USE_ME > Configuration**) to your navigation, or add the `Snippet_Configuration` to a page that is already part of your navigation. Alternatively, you can register your key by using the `Configuration_RegisterByString` microflow. * Complete the runtime setup of Mendix Cloud GenAI configuration by navigating to the page through the microflow mentioned above. Import a key generated in the [portal](https://genai.home.mendix.com) or provided to you and click **Test Key** to validate its functionality. ## Operations From c93ea450eee7252750e4d4d097aa4c2d64d470ab Mon Sep 17 00:00:00 2001 From: liamsommer-mx Date: Fri, 4 Apr 2025 12:44:29 +0200 Subject: [PATCH 05/16] SAS-1180: changed configuration in how-to --- .../modules/genai/how-to/ground_your_llm_in_data.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/ground_your_llm_in_data.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/ground_your_llm_in_data.md index 67dbaca8b14..1f30e2ca437 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/ground_your_llm_in_data.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/ground_your_llm_in_data.md @@ -204,7 +204,7 @@ For the application to function as expected, ensure that the following microflow * Create Demo Data and Populate KB: Add the `MyFirstModule.ACT_TicketList_CreateData_InsertIntoKnowledgeBase` which was created in the [Joining the Microflows section](#joining-microflows). -* Mendix Cloud Configuration: If you started from a Blank GenAI App, the configuration page should already be included. In case you started from your application, add the `MxGenAIConnector.NAV_ConfigurationOverview_Open` microflow. +* Mendix Cloud Configuration: If you started from a Blank GenAI App, the configuration page should already be included. In case you started from your application, add the `Configuration_Overview` page. * Ensure that your admin role has the following module roles assigned: MxGenAIConnector.Administrator, ConversationalUI.User, and MyFirstModule.Administrator. From d3f6bc388dcc93cc13d0a9b9f749beefd4ef8821 Mon Sep 17 00:00:00 2001 From: Karuna-Mendix Date: Fri, 4 Apr 2025 16:18:37 +0530 Subject: [PATCH 06/16] Small changes in URLs and aliases --- .../modules/genai/how-to/_index.md | 2 +- .../genai/reference-guide/conversational-ui/_index.md | 6 +++--- .../reference-guide/conversational-ui/conversational-ui.md | 3 ++- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/_index.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/_index.md index 29f9113a459..f38b0e2dabc 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/_index.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/_index.md @@ -30,7 +30,7 @@ Generative Artificial Intelligence (GenAI) transforms business applications, emp ### Additional Resources * Basic documentation on [GenAI Concepts](/appstore/modules/genai/get-started/) is an essential resource for anyone beginning their GenAI journey. -* The [GenAICommons](/appstore/modules/genai/commons/) module as a prerequisite for all GenAI components. +* The [GenAICommons](/appstore/modules/genai/genai-for-mx/commons/) module as a prerequisite for all GenAI components. * The [ConversationalUI](/appstore/modules/genai/conversational-ui/) module that offers UI snippets for chat, token consumption monitoring and prompt management. * The [Mendix Cloud GenAI Resource Packs](/appstore/modules/genai/MxGenAI/) to learn how to quickly access GenAI capabilities from a Mendix app. * The [OpenAI](/appstore/modules/genai/openai/) provides essential information about the OpenAI connector. diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/_index.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/_index.md index a19306b34dd..394f9d9a8d0 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/_index.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/_index.md @@ -1,6 +1,6 @@ --- -title: "Conversational UI" -url: /appstore/modules/genai/conversational-ui/ +title: "Conversational UI Module" +url: /appstore/modules/genai/conversational-ui-module/ linktitle: "Conversational UI Module" weight: 20 description: "Provides information on the ConversationalUI Module." @@ -11,7 +11,7 @@ aliases: ## Introduction {#introduction} -The [ConversationalUI](https://marketplace.mendix.com/link/component/239450) module provides page snippets to easily facilate a GenAI use case. +The [ConversationalUI](https://marketplace.mendix.com/link/component/239450) module provides page snippets to easily facilitate a GenAI use case. By leveraging the tools and features provided in this module, you can: diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/conversational-ui.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/conversational-ui.md index e0bf3c78270..fc68370e073 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/conversational-ui.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/conversational-ui.md @@ -1,11 +1,12 @@ --- title: "Conversational UI" -url: /appstore/modules/genai/conversational-ui/conversational-ui/ +url: /appstore/modules/genai/conversational-ui-module/conversational-ui/ linktitle: "Conversational UI" weight: 20 description: "Describes the Conversational UI marketplace module that assists developers in implementing conversational use cases such as an AI Bot." aliases: - /appstore/modules/genai/genai-for-mx/conversational-ui/ + - /appstore/modules/genai/conversational-ui/ --- ## Introduction {#introduction} From c90ef3f648ce6345fdec6bc24d137b21fda9631b Mon Sep 17 00:00:00 2001 From: Karuna-Mendix Date: Fri, 4 Apr 2025 16:21:14 +0530 Subject: [PATCH 07/16] small change --- .../modules/genai/mendix-cloud-genai/Mx GenAI Connector.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md index 0ee3f0e9699..1a72fcbef3c 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md @@ -86,7 +86,7 @@ Follow the steps below to get started: * Make sure to configure the [Encryption module](/appstore/modules/encryption/#configuration) before you connect your app to Mendix Cloud GenAI. * Add the module role `MxGenAIConnector.Administrator` to your Administrator **User roles** in the **Security** settings of your app. -* Add the `Configuration_Overview` page (**USE_ME > Configuration**) to your navigation, or add the `Snippet_Configuration` to a page that is already part of your navigation. Alternatively, you can register your key by using the `Configuration_RegisterByString` microflow. +* Add the `Configuration_Overview` page (**USE_ME** > **Configuration**) to your navigation, or add the `Snippet_Configuration` to a page that is already part of your navigation. Alternatively, you can register your key by using the `Configuration_RegisterByString` microflow. * Complete the runtime setup of Mendix Cloud GenAI configuration by navigating to the page through the microflow mentioned above. Import a key generated in the [portal](https://genai.home.mendix.com) or provided to you and click **Test Key** to validate its functionality. ## Operations From 6e8ec314c9cf4a2b717de6c11d7fdbc6e9368037 Mon Sep 17 00:00:00 2001 From: oenerayca <123177148+oenerayca@users.noreply.github.com> Date: Mon, 7 Apr 2025 17:23:05 +0200 Subject: [PATCH 08/16] Update Mx GenAI Connector.md - migration section added to troubleshooting --- .../genai/mendix-cloud-genai/Mx GenAI Connector.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md index 1a72fcbef3c..f29d05a2ef0 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md @@ -279,6 +279,17 @@ To check your JDK version and update it if necessary, follow these steps: 1. You might get an error saying `FAILURE: Build failed with an exception. The supplied javaHome seems to be invalid. I cannot find the java executable.` In this case, verify that you have selected the correct JDK directory containing the updated JDK version. 2. You may also need to update Gradle. To do this, go to **Edit** > **Preferences** > **Deployment** > **Gradle directory**. Click **Browse** and select the appropriate Gradle version from the Mendix folder. For Mendix 10.10 and above, use Gradle 8.5. For Mendix 10 versions below 10.10, use Gradle 7.6.3. Then save your settings by clicking **OK**. 3. Rerun the project. + +### Migration from Add-On module to App module +As the module has been changed from an add-on to an app module, if you are updating the module the install from marketplace will need a migration to work properly with your application. +The process may look like this: +1. Backup of data; either as database backup or individual: + - Keys to MxCloud GenAI Resource Packs can be reimported afterwards + - Incoming associations to protected module’s entities will be deleted +2. Delete Add-On module: MxGenAIConnector +3. Download module from the marketplace; note that the module is from now on located under the “Marketplace modules” category in the app explorer. +4. Test your application locally and verify that everything works as before. +5. Restore lost data on deployed environments. Usually keys and incoming associations to the protected modules need to be reset. ## Read More{#readmore} From 3b92687bb254ba18644b0cebc395cd4937e03376 Mon Sep 17 00:00:00 2001 From: oenerayca <123177148+oenerayca@users.noreply.github.com> Date: Mon, 7 Apr 2025 17:25:36 +0200 Subject: [PATCH 09/16] Update genai-commons.md - migration section added under troubleshooting --- .../modules/genai/reference-guide/genai-commons.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-commons.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-commons.md index 4cc6f2e8c2c..23a997c9ea9 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-commons.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-commons.md @@ -857,4 +857,16 @@ To check your JDK version and update it if necessary, follow these steps: 1. You might get an error saying `FAILURE: Build failed with an exception. The supplied javaHome seems to be invalid. I cannot find the java executable.` In this case, verify that you have selected the correct JDK directory containing the updated JDK version. 2. You may also need to update Gradle. To do this, go to **Edit** > **Preferences** > **Deployment** > **Gradle directory**. Click **Browse** and select the appropriate Gradle version from the Mendix folder. For Mendix 10.10 and above, use Gradle 8.5. For Mendix 10 versions below 10.10, use Gradle 7.6.3. Then save your settings by clicking **OK**. 3. Rerun the project. - \ No newline at end of file + +### Migration from Add-On module to App module +As the module has been changed from an add-on to an app module, if you are updating the module the install from marketplace will need a migration to work properly with your application. + +The process may look like this: +1. Backup of data; either as database backup or individual: + - Incoming associations to protected module’s entities will be deleted + - Usage data will be lost but can be exported in the ConversationalUI module via the Token Consumption Monitor snippets +2. Delete Add-On module: GenAICommons +3. Download the module from the marketplace; note that the module is from now on located under the “Marketplace modules” category in the app explorer. +4. Test your application locally and verify that everything works as before. +5. Restore lost data on deployed environments. Usually incoming associations to the protected modules need to be reset. + From 72a5a95ff34884cfabcc704234bf9769d4f72f77 Mon Sep 17 00:00:00 2001 From: oenerayca <123177148+oenerayca@users.noreply.github.com> Date: Mon, 7 Apr 2025 17:26:02 +0200 Subject: [PATCH 10/16] Update Mx GenAI Connector.md - small fix --- .../modules/genai/mendix-cloud-genai/Mx GenAI Connector.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md index f29d05a2ef0..aec0da897e6 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md @@ -282,6 +282,7 @@ To check your JDK version and update it if necessary, follow these steps: ### Migration from Add-On module to App module As the module has been changed from an add-on to an app module, if you are updating the module the install from marketplace will need a migration to work properly with your application. + The process may look like this: 1. Backup of data; either as database backup or individual: - Keys to MxCloud GenAI Resource Packs can be reimported afterwards From 0fbfa5e5c221b1dffe15b514cb2c2412b566a3cb Mon Sep 17 00:00:00 2001 From: Karuna-Mendix Date: Tue, 8 Apr 2025 12:07:07 +0530 Subject: [PATCH 11/16] correction --- .../mendix-cloud-genai/Mx GenAI Connector.md | 29 ++++++++++--------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md index aec0da897e6..f34b4697ad2 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md @@ -280,19 +280,22 @@ To check your JDK version and update it if necessary, follow these steps: 2. You may also need to update Gradle. To do this, go to **Edit** > **Preferences** > **Deployment** > **Gradle directory**. Click **Browse** and select the appropriate Gradle version from the Mendix folder. For Mendix 10.10 and above, use Gradle 8.5. For Mendix 10 versions below 10.10, use Gradle 7.6.3. Then save your settings by clicking **OK**. 3. Rerun the project. -### Migration from Add-On module to App module -As the module has been changed from an add-on to an app module, if you are updating the module the install from marketplace will need a migration to work properly with your application. - -The process may look like this: -1. Backup of data; either as database backup or individual: - - Keys to MxCloud GenAI Resource Packs can be reimported afterwards - - Incoming associations to protected module’s entities will be deleted -2. Delete Add-On module: MxGenAIConnector -3. Download module from the marketplace; note that the module is from now on located under the “Marketplace modules” category in the app explorer. -4. Test your application locally and verify that everything works as before. -5. Restore lost data on deployed environments. Usually keys and incoming associations to the protected modules need to be reset. - -## Read More{#readmore} +### Migrating From Add-on Module to App Module + +Since the module has been changed from an add-on to an app module, updating it via the marketplace will require a migration to ensure it works properly with your application. + +To do this, follow the steps below: + +1. Back up your data — either as a full database backup or by exporting individual components: + + * Keys for MxCloud GenAI Resource Packs can be reimported later. + * Incoming associations to the protected module’s entities will be deleted. +2. Delete the add-on module: MxGenAIConnector. +3. Download the updated module from the Marketplace. Note that the module is now listed under the **Marketplace modules** category in the **App Explorer**. +4. Test your application locally to ensure everything functions as expected. +5. Restore any lost data in deployed environments. Typically, keys and incoming associations to the protected module need to be reset. + +## Read More For Anthropic Claude-specific documentation, refer to: From 6e952d6195af8e992685e0a35f285a7256077c5b Mon Sep 17 00:00:00 2001 From: Karuna-Mendix Date: Tue, 8 Apr 2025 12:23:40 +0530 Subject: [PATCH 12/16] Fixed broken links --- .../modules/genai/mendix-cloud-genai/Mx GenAI Connector.md | 2 +- .../modules/genai/reference-guide/conversational-ui/_index.md | 4 ++-- .../reference-guide/conversational-ui/prompt-management.md | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md index f34b4697ad2..184f23a4a3b 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md @@ -295,7 +295,7 @@ To do this, follow the steps below: 4. Test your application locally to ensure everything functions as expected. 5. Restore any lost data in deployed environments. Typically, keys and incoming associations to the protected module need to be reset. -## Read More +## Read More {#readmore} For Anthropic Claude-specific documentation, refer to: diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/_index.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/_index.md index 394f9d9a8d0..e75ad5638c1 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/_index.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/_index.md @@ -15,8 +15,8 @@ The [ConversationalUI](https://marketplace.mendix.com/link/component/239450) mod By leveraging the tools and features provided in this module, you can: -* Create a [Conversational UI](/appstore/modules/genai/conversational-ui/conversational-ui) with prebuilt pages and snippets to facilitate user-friendly chat interactions. +* Create a [Conversational UI](/appstore/modules/genai/conversational-ui-module/conversational-ui/) with prebuilt pages and snippets to facilitate user-friendly chat interactions. * Perform [Prompt Engineering](/appstore/modules/genai/prompt-engineering/) at runtime to optimize your AI-generated results via [Prompt Management](/appstore/modules/genai/conversational-ui/prompt-management/). -* Monitor your token consumption with the [Token Consumption Monitor](/appstore/modules/genai/conversational-ui/conversational-ui/#snippet-token-monitor), ensuring efficient use of resources. +* Monitor your token consumption with the [Token Consumption Monitor](/appstore/modules/genai/conversational-ui-module/conversational-ui/#snippet-token-monitor), ensuring efficient use of resources. ## Documents in This Category diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/prompt-management.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/prompt-management.md index ee6d818dfbd..c7a41dfeea9 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/prompt-management.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/conversational-ui/prompt-management.md @@ -34,7 +34,7 @@ The Prompt Management functionality provides the following: ### Prerequisites -The prerequisites of the [Conversational UI module](/appstore/modules/genai/genai-for-mx/conversational-ui/#prerequisites) apply here. +The prerequisites of the [Conversational UI module](/appstore/modules/genai/conversational-ui-module/conversational-ui/#prerequisites) apply here. ## Installation @@ -97,7 +97,7 @@ New prompts will be created in the draft status by default, meaning they are st For a Single-Call type prompt, use `Get Prompt for Context Object`, which can be found in the **Toolbox** in Studio Pro while editing a microflow, under the category **GenAI (Request Building)**. This operation returns both a system prompt and a user prompt strings, on a combined `PromptToUse` object. These string attributes can be passed to the chat completions operation. Retrieve the prompt (e.g. by name) and pass it with your custom context object to the operation. For an example of this pattern, see the product description generation example in the [GenAI Showcase app](https://marketplace.mendix.com/link/component/220475). -For a conversational prompt, the chat context can be created based on the prompt in one operation. Use the `New Chat for Prompt` operation from the **Toolbox** under the **Conversational UI** category. Retrieve the prompt (e.g. by name) and pass it with your custom context object to the operation. Note that this sets the system prompt for the chat context, making it applicable to the entire (future) conversation. Similar to other chat context operations, an [action microflow needs to be selected](/appstore/modules/genai/genai-for-mx/conversational-ui/#action-microflow) for this microflow action. +For a conversational prompt, the chat context can be created based on the prompt in one operation. Use the `New Chat for Prompt` operation from the **Toolbox** under the **Conversational UI** category. Retrieve the prompt (e.g. by name) and pass it with your custom context object to the operation. Note that this sets the system prompt for the chat context, making it applicable to the entire (future) conversation. Similar to other chat context operations, an [action microflow needs to be selected](/appstore/modules/genai/conversational-ui-module/conversational-ui/#action-microflow) for this microflow action. With this microflow logic, the prompt version is ready to be tested from the end-user flow (in a local or test environment). The prompt can be exported/imported for transport to other environments if needed. From f73e2299a8422c18583d7c1acc3c0ed33cfef376 Mon Sep 17 00:00:00 2001 From: Karuna-Mendix Date: Tue, 8 Apr 2025 12:45:38 +0530 Subject: [PATCH 13/16] Actions from the PR comments --- .../mendix-cloud-genai/Mx GenAI Connector.md | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md index 184f23a4a3b..a5b281f3afc 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md @@ -89,6 +89,21 @@ Follow the steps below to get started: * Add the `Configuration_Overview` page (**USE_ME** > **Configuration**) to your navigation, or add the `Snippet_Configuration` to a page that is already part of your navigation. Alternatively, you can register your key by using the `Configuration_RegisterByString` microflow. * Complete the runtime setup of Mendix Cloud GenAI configuration by navigating to the page through the microflow mentioned above. Import a key generated in the [portal](https://genai.home.mendix.com) or provided to you and click **Test Key** to validate its functionality. +## Migrating From Add-on Module to App Module + +Since the module has been changed from an add-on to an app module, updating it via the marketplace will require a migration to ensure it works properly with your application. + +To do this, follow the steps below: + +1. Back up your data — either as a full database backup or by exporting individual components: + + * Keys for MxCloud GenAI Resource Packs can be reimported later. + * Incoming associations to the protected module’s entities will be deleted. +2. Delete the add-on module: MxGenAIConnector. +3. Download the updated module from the Marketplace. Note that the module is now listed under the **Marketplace modules** category in the **App Explorer**. +4. Test your application locally to ensure everything functions as expected. +5. Restore any lost data in deployed environments. Typically, keys and incoming associations to the protected module need to be reset. + ## Operations {{< figure src="/attachments/appstore/platform-supported-content/modules/genai/mxgenAI-connector/MxGenAIConnector_Configuration.png" >}} @@ -256,7 +271,7 @@ The **Documentation** pane displays the documentation for the currently selected ## Implementing GenAI with the Showcase App -For more inspiration or guidance on how to use microflows in your logic, Mendix recommends downloading the [GenAI Showcase App](https://marketplace.mendix.com/link/component/220475), which demonstrates a variety of example use cases and applies almost all of the Mendix Cloud GenAI operations. The starter apps in the [Mendix Components](/appstore/modules/genai/#mendix-components) list can also be used as inspiration or simply adapted for a specific use case. +For more guidance on how to use microflows in your logic, Mendix recommends downloading the [GenAI Showcase App](https://marketplace.mendix.com/link/component/220475), which demonstrates a variety of example use cases and applies almost all of the Mendix Cloud GenAI operations. The starter apps in the [Mendix Components](/appstore/modules/genai/#mendix-components) list can also be used as inspiration or simply adapted for a specific use case. ## Troubleshooting {#troubleshooting} @@ -280,21 +295,6 @@ To check your JDK version and update it if necessary, follow these steps: 2. You may also need to update Gradle. To do this, go to **Edit** > **Preferences** > **Deployment** > **Gradle directory**. Click **Browse** and select the appropriate Gradle version from the Mendix folder. For Mendix 10.10 and above, use Gradle 8.5. For Mendix 10 versions below 10.10, use Gradle 7.6.3. Then save your settings by clicking **OK**. 3. Rerun the project. -### Migrating From Add-on Module to App Module - -Since the module has been changed from an add-on to an app module, updating it via the marketplace will require a migration to ensure it works properly with your application. - -To do this, follow the steps below: - -1. Back up your data — either as a full database backup or by exporting individual components: - - * Keys for MxCloud GenAI Resource Packs can be reimported later. - * Incoming associations to the protected module’s entities will be deleted. -2. Delete the add-on module: MxGenAIConnector. -3. Download the updated module from the Marketplace. Note that the module is now listed under the **Marketplace modules** category in the **App Explorer**. -4. Test your application locally to ensure everything functions as expected. -5. Restore any lost data in deployed environments. Typically, keys and incoming associations to the protected module need to be reset. - ## Read More {#readmore} For Anthropic Claude-specific documentation, refer to: From e63cd408e0697e9dae1a493b9f5e294b05f2a09c Mon Sep 17 00:00:00 2001 From: Karuna-Mendix Date: Tue, 8 Apr 2025 12:47:14 +0530 Subject: [PATCH 14/16] replacing Add-on with Marketplace modules --- .../modules/genai/mendix-cloud-genai/Mx GenAI Connector.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md index a5b281f3afc..cb7325ddcf0 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md @@ -80,7 +80,7 @@ Add the [dependencies](#dependencies) listed above from the Marketplace. To impo ## Configuration {#configuration} -After installing the Mendix Cloud GenAI connector, you can find it in the **App Explorer** inside of the **Add-ons** section. The connector includes a domain model and several activities to help integrate your app with the Mendix Cloud GenAI service. To implement the connector, simply use its actions in a microflow. You can find the Mendix GenAI actions in the microflow toolbox. +After installing the Mendix Cloud GenAI connector, you can find it in the **App Explorer** inside of the **Marketplace modules** section. The connector includes a domain model and several activities to help integrate your app with the Mendix Cloud GenAI service. To implement the connector, simply use its actions in a microflow. You can find the Mendix GenAI actions in the microflow toolbox. Follow the steps below to get started: From 5d35ef30e9f6b835bfe7eaf0a0d5295f2fcbeb80 Mon Sep 17 00:00:00 2001 From: Karuna-Mendix Date: Tue, 8 Apr 2025 13:08:54 +0530 Subject: [PATCH 15/16] Small fixes --- .../platform-supported-content/modules/genai/how-to/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/_index.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/_index.md index f38b0e2dabc..23c2e68d9c8 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/_index.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/how-to/_index.md @@ -31,8 +31,8 @@ Generative Artificial Intelligence (GenAI) transforms business applications, emp * Basic documentation on [GenAI Concepts](/appstore/modules/genai/get-started/) is an essential resource for anyone beginning their GenAI journey. * The [GenAICommons](/appstore/modules/genai/genai-for-mx/commons/) module as a prerequisite for all GenAI components. -* The [ConversationalUI](/appstore/modules/genai/conversational-ui/) module that offers UI snippets for chat, token consumption monitoring and prompt management. -* The [Mendix Cloud GenAI Resource Packs](/appstore/modules/genai/MxGenAI/) to learn how to quickly access GenAI capabilities from a Mendix app. +* The [ConversationalUI](/appstore/modules/genai/conversational-ui-module/conversational-ui/) module that offers UI snippets for chat, token consumption monitoring and prompt management. +* The [Mendix Cloud GenAI Resource Packs](/appstore/modules/genai/mx-cloud-genai/resource-packs/) to learn how to quickly access GenAI capabilities from a Mendix app. * The [OpenAI](/appstore/modules/genai/openai/) provides essential information about the OpenAI connector. * The [Amazon Bedrock](/appstore/modules/aws/amazon-bedrock/) provides key information about the AWS Bedrock connector. * The [PGVector Knowledge Base](/appstore/modules/genai/pgvector/) offers the option for a private knowledge base outside of the LLM infrastructure. From a7073b51dfd22d70a5f5d7db76f6568441aabe05 Mon Sep 17 00:00:00 2001 From: Karuna-Mendix Date: Tue, 8 Apr 2025 13:20:43 +0530 Subject: [PATCH 16/16] Reverting 'Migrating From Add-on Module to App Module' section back to Troubleshooting --- .../mendix-cloud-genai/Mx GenAI Connector.md | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md index cb7325ddcf0..f9cca1447d8 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/mendix-cloud-genai/Mx GenAI Connector.md @@ -89,21 +89,6 @@ Follow the steps below to get started: * Add the `Configuration_Overview` page (**USE_ME** > **Configuration**) to your navigation, or add the `Snippet_Configuration` to a page that is already part of your navigation. Alternatively, you can register your key by using the `Configuration_RegisterByString` microflow. * Complete the runtime setup of Mendix Cloud GenAI configuration by navigating to the page through the microflow mentioned above. Import a key generated in the [portal](https://genai.home.mendix.com) or provided to you and click **Test Key** to validate its functionality. -## Migrating From Add-on Module to App Module - -Since the module has been changed from an add-on to an app module, updating it via the marketplace will require a migration to ensure it works properly with your application. - -To do this, follow the steps below: - -1. Back up your data — either as a full database backup or by exporting individual components: - - * Keys for MxCloud GenAI Resource Packs can be reimported later. - * Incoming associations to the protected module’s entities will be deleted. -2. Delete the add-on module: MxGenAIConnector. -3. Download the updated module from the Marketplace. Note that the module is now listed under the **Marketplace modules** category in the **App Explorer**. -4. Test your application locally to ensure everything functions as expected. -5. Restore any lost data in deployed environments. Typically, keys and incoming associations to the protected module need to be reset. - ## Operations {{< figure src="/attachments/appstore/platform-supported-content/modules/genai/mxgenAI-connector/MxGenAIConnector_Configuration.png" >}} @@ -294,6 +279,21 @@ To check your JDK version and update it if necessary, follow these steps: 1. You might get an error saying `FAILURE: Build failed with an exception. The supplied javaHome seems to be invalid. I cannot find the java executable.` In this case, verify that you have selected the correct JDK directory containing the updated JDK version. 2. You may also need to update Gradle. To do this, go to **Edit** > **Preferences** > **Deployment** > **Gradle directory**. Click **Browse** and select the appropriate Gradle version from the Mendix folder. For Mendix 10.10 and above, use Gradle 8.5. For Mendix 10 versions below 10.10, use Gradle 7.6.3. Then save your settings by clicking **OK**. 3. Rerun the project. + +### Migrating From Add-on Module to App Module + +Since the module has been changed from an add-on to an app module, updating it via the marketplace will require a migration to ensure it works properly with your application. + +To do this, follow the steps below: + +1. Back up your data — either as a full database backup or by exporting individual components: + + * Keys for MxCloud GenAI Resource Packs can be reimported later. + * Incoming associations to the protected module’s entities will be deleted. +2. Delete the add-on module: MxGenAIConnector. +3. Download the updated module from the Marketplace. Note that the module is now listed under the **Marketplace modules** category in the **App Explorer**. +4. Test your application locally to ensure everything functions as expected. +5. Restore any lost data in deployed environments. Typically, keys and incoming associations to the protected module need to be reset. ## Read More {#readmore}