Merge remote-tracking branch 'upstream/development' into development

Author: github-actions[bot]

content/en/docs/marketplace/genai/how-to/byo_connector.md

@@ -65,7 +65,7 @@ The Echo connector is a module in the [GenAI Showcase App](https://marketplace.m
 
 ### Chat Completions: With History
 
-This section allows you to focus on implementing chat completions, a fundamental capability supported by most LLMs. To make the process more practical, develop an example connector—the Echo Connector. This simple connector returns the similar text as output provided as input while remaining fully compatible with the chat capabilities of GenAICommons and ConversationalUI.
+This section allows you to focus on implementing chat completions, a fundamental capability supported by most LLMs. To make the process more practical, Mendix has developed an example connector—the Echo Connector. This simple connector returns the similar text as output provided as input while remaining fully compatible with the chat capabilities of GenAICommons and ConversationalUI.
 During development, you will get the key considerations to keep in mind when creating your own connector. You can either start from scratch and build your own connector or use the finished Echo Connector from the GenAI Showcase App and modify it to fit your use case.
 
 To enable chat completion, the key microflow to consider is `ChatCompletions_WithHistory`, located in the GenAICommons module. This microflow plays a crucial role as it derives and calls the appropriate microflow from the provided DeployedModel, ensuring that the module remains independent of individual connectors. This is especially important for modules like ConversationalUI, which should work seamlessly with any connector following the same principles.
@@ -87,7 +87,7 @@ Just as the `Request` entity structures input for the LLM, the Response entity d
 
 The `Response` entity includes key attributes such as:
 
-* Messages - A single message that the model generated. 
+* Message - A single message that the model generated. 
 * Tool Call - A request from the model to call one or multiple tools, for example, a microflow. Available tools are defined in the request via the [ToolCollection](/appstore/modules/genai/genai-for-mx/commons/#toolcollection).
 
 Since different providers return responses in different formats, when implementing a new connector, map the provider’s response to match the `Response` entity’s structure. If it is required to have additional attributes on the `Request` or `Response` entity, it is recommended to extend those entities in your own connector by either creating an association or a specialization. For example, you can find both patterns being applied in the OpenAIConnector (association to `Request`) and AmazonBedrockConnector (specialization of `Response`).
@@ -98,7 +98,7 @@ Since different providers return responses in different formats, when implementi
 
 The `Request` and `Response` objects are essential for enabling chat functionalities in ConversationalUI. However, to correctly call and interact with an LLM, the model must be properly configured. This is where the `DeployedModel` entity becomes essential.
 
-The `DeployedModel` represents a GenAI model that the Mendix application can invoke, ensuring connector knows which microflow to call and how to communicate with the model. It also includes a set of generic attributes commonly used across different LLM providers. However, since each provider may require additional model-specific details, the `DeployedModel` entity does not cover all necessary attributes.
+The `DeployedModel` represents a GenAI model that the Mendix app can invoke, ensuring your app module knows which microflow to call and how to communicate with the model. It also includes a set of generic attributes commonly used across different LLM providers. However, since each provider may require additional model-specific details, the `DeployedModel` entity does not cover all necessary attributes.
 
 To accommodate this, you will need to create a new entity within your connector that inherits from `GenAICommons.DeployedModel`. This allows you to extend it with any provider-specific attributes required for your integration.
 

content/en/docs/marketplace/genai/reference-guide/migration-guide.md

@@ -14,7 +14,7 @@ This document is intended for consumers of GenAI modules. For releases that intr
 {{% alert color="warning" %}}
 Do not skip major versions as they may contain deprecations or require migration.
 
-Modules remove deprecated entities, associations, and attributes in the subsequent major release, after they have been marked as deprecated. Deprecated domain model elements are indicated by the `_DEPR` suffix in the previous major version. 
+Modules remove deprecated entities, associations, and attributes in the subsequent major release, after they have been marked as deprecated. Deprecated domain model elements are indicated by an annotation in the documentation field. 
 
 This means that major versions containing deprecations should not be skipped during upgrades.
 
@@ -57,12 +57,12 @@ The following module versions are released as compatible with each other and sho
 | Module | Previous Version | New Version | Contains deprecations | Requires migration |
 | --------------------- | ----------------- | ------------- | ----------------- | ---- |
 | GenAI Commons | 5.x.x | 6.0.0 | No | Yes, as part of dependent modules. |
-| Agent Commons | 2.x.x | 3.0.0 | Yes | Yes |
-| MCP Client | 2.x.x | 3.0.0 | Yes | No, but update required for other migrations. |
-| OpenAI Connector | 7.x.x | 8.0.0 | Yes | Yes |
-| Amazon Bedrock Connector | 9.x.x | 10.0.0 | No | Yes | 
-| PgVector Knowledge Base | 5.x.x | 6.0.0 | Yes | Yes |
-| Mendix Cloud GenAI Connector | 5.x.x | 6.0.0 | No | Yes |
+| Agent Commons | 2.x.x | 3.0.1 | Yes | Yes |
+| MCP Client | 2.x.x | 3.0.1 | Yes | No, but update required for other migrations. |
+| OpenAI Connector | 7.x.x | 8.0.1 | Yes | Yes |
+| Amazon Bedrock Connector | 9.x.x | 10.0.1 | No | Yes | 
+| PgVector Knowledge Base | 5.x.x | 6.0.1 | Yes | Yes |
+| Mendix Cloud GenAI Connector | 5.x.x | 6.0.1 | No | Yes |
 
 {{% alert color="info" %}}
 Even if a module does not include any deprecations, Mendix strongly recommends upgrading all modules together according to the table above. This ensures that migrations in dependent modules execute correctly.
@@ -76,8 +76,8 @@ In this section, migration steps are grouped together by topic rather than by mo
 
 The following modules require an upgrade:
 
-* Agent Commons: migrate from V2.x.x to V3.0.0 
-* MCP Client: migrate from V2.x.x to V3.0.0 
+* Agent Commons: migrate from V2.x.x to V3.0.1 
+* MCP Client: migrate from V2.x.x to V3.0.1 
 
 ###### Key Changes {#changes}
 
@@ -97,17 +97,18 @@ In order to resolve consistency errors for the renamed `ConsumedMCPService` enti
 
 To prevent the need to recreate existing data related to Agent definitions, perform the following steps:
 
-1. Upgrade the [MCP Client](https://marketplace.mendix.com/link/component/244893) module to V3.0.0 in your Mendix app.
-2. Upgrade the [Agent Commons](https://marketplace.mendix.com/link/component/240371) module to V3.0.0 in your Mendix app.
+1. Upgrade the [MCP Client](https://marketplace.mendix.com/link/component/244893) module to V3.0.1 in your Mendix app.
+2. Upgrade the [Agent Commons](https://marketplace.mendix.com/link/component/240371) module to V3.0.1 in your Mendix app.
 3. Run the data migration microflow upon starting your application (for example, include it in the after-startup microflow).
 
    The **AgentCommons** > **USE_ME** > **Migration** > `SingleMCPTool_Migrate` microflow will set the new association and attribute on existing `SingleMCPTool` records.
 
-4. Update any custom logic or pages in your app that refer the old entity or its attributes `MCPTool_DEPR` in the MCPClient module. Available tools are not cached anymore. In cases where the actual list of available tools is required, refer to the `ConsumedMCPService_ListTools` microflow.
-5. Verify your application compiles and runs correctly before deploying to cloud environments.
+4. Update any custom logic or pages in your app that refer to the old entity or its attributes `MCPTool` in the MCPClient module. Available tools are not cached anymore. In cases where the actual list of available tools is required, refer to the `ConsumedMCPService_ListTools` microflow.
+5. In your running apps, configure your MCP connections again on the `ConsumedMCPService_Overview` page. Furthermore, in existing agents where those MCP connections were used, you need to add them again. Ensure to save a new version when using the agent in microflows.
+6. Verify your application compiles and runs correctly before deploying to cloud environments.
 
 {{% alert color="info" %}}
-The `SingleMCPTool` entity and related attributes and association will be permanently removed in the next major version (V4.0.0) of the MCP Client module.
+The `MCPTool` entity and related attributes and association will be permanently removed in the next major version of the MCP Client (V4.0.0) and Agent Commons (V4.0.0) modules.
 
 Ensure to run the migration microflow before upgrading to the next major version.
 {{% /alert %}}
@@ -116,11 +117,11 @@ Ensure to run the migration microflow before upgrading to the next major version
 
 The following modules require an upgrade:
 
-* [GenAI Commons](https://marketplace.mendix.com/link/component/239448): migrate from V5.x.x TO V6.0.0 
-* [Amazon Bedrock Connector](https://marketplace.mendix.com/link/component/215042): migrate from V9.x.x to V10.0.0
-* [Mendix Cloud GenAI Connector](https://marketplace.mendix.com/link/component/239449): migrate from V5.x.x to V6.0.0
-* [OpenAI Connector](https://marketplace.mendix.com/link/component/220472): migrate from V7.x.x to V8.0.0
-* [PgVector Knowledge Base](https://marketplace.mendix.com/link/component/225063): migrate from V5.x.x to V6.0.0
+* [GenAI Commons](https://marketplace.mendix.com/link/component/239448): migrate from V5.x.x to V6.0.0 
+* [Amazon Bedrock Connector](https://marketplace.mendix.com/link/component/215042): migrate from V9.x.x to V10.0.1
+* [Mendix Cloud GenAI Connector](https://marketplace.mendix.com/link/component/239449): migrate from V5.x.x to V6.0.1
+* [OpenAI Connector](https://marketplace.mendix.com/link/component/220472): migrate from V7.x.x to V8.0.1
+* [PgVector Knowledge Base](https://marketplace.mendix.com/link/component/225063): migrate from V5.x.x to V6.0.1
 
 ###### Key Changes {#keychanges}
 
@@ -133,7 +134,7 @@ The following modules require an upgrade:
 ###### Impact
 
 Agent definitions using knowledge bases require migration to prevent failing agent calls at runtime. 
-Existing knowledge base configurations in any of the mentioned connector modules require migration to prevent failing knowledge base calls at runtime.
+Existing knowledge base configurations in any of the mentioned connector modules require migration to prevent failing knowledge base calls at runtime. In addition, any data in the display name field may be lost and needs to be set again manually.
 
 Migration is only required if your app interacts with knowledge bases from any of the modules mentioned in the [Key Changes](#keychanges) section, or contains existing data for such knowledge base configurations.
 
@@ -142,47 +143,46 @@ Migration is only required if your app interacts with knowledge bases from any o
 To prevent the need to recreate existing data related to Agent definitions and knowledge base configurations, do the following:
 
 1. Upgrade the GenAI Commons module to V6.0.0 in your Mendix app.
-2. If available, upgrade the Agent Commons module to V3.0.0.
+2. If available, upgrade the Agent Commons module to V3.0.1.
 
 3. If your app has the Amazon Bedrock Connector module:
 
-   1. Upgrade the Amazon Bedrock Connector module to V10.0.0
+   1. Upgrade the Amazon Bedrock Connector module to V10.0.1
    2. Include logic to run the data migration microflow upon starting your app (for example, include it in the after-startup microflow): **AmazonBedrockConnector** > **USE_ME** > **Migration** > `ConsumedKnowledgeBase_Migrate`. This microflow makes sure the new attributes on the generalization are set properly, and the `DisplayName` field is migrated.
    3. If Agent Commons is included in your app and Agents are defined using knowledge bases, you must include the following initially excluded sub-microflow in the app and add it as a microflow call, as specified in the annotation in the above-mentioned microflow: **AmazonBedrockConnector** > **USE_ME** > **Migration** > `AmazonBedrock_KnowledgeBase_Migrate`. This microflow sets the `CollectionIdentifier` field on the `KnowledgeBase` entity, and an outgoing reference to the `ConsumedKnowledgeBase`.
 
 4. If your app has the Mendix Cloud GenAI Connector module:
 
-   1. Upgrade the Mendix Cloud GenAI Connector module to V6.0.0 in your Mendix app.
+   1. Upgrade the Mendix Cloud GenAI Connector module to V6.0.1 in your Mendix app.
    2. Include logic to run the data migration microflow upon starting your app (for example, include it in the after-startup): **MxGenAIConnector** > **USE_ME** > **Migration** > `ConsumedKnowledgeBase_Migrate`. This microflow makes sure the new attributes on the generalization are set properly, and the `DisplayName` field is migrated.
    3. If the Agent Commons is part of your app and there are Agents defined using knowledge bases, include the following initially excluded sub-microflow into the app and add it as a microflow call according to the annotation in the above-mentioned microflow: **MxGenAIConnector** > **USE_ME** > **Migration** > `MxGenAI_KnowledgeBase_Migrate`. This microflow sets the `CollectionIdentifier` field on the `KnowledgeBase` entity and outgoing reference to the `ConsumedKnowledgeBase`.
+   4. Set the `DisplayName` field for each `ConsumedKnowledgeBase` object by importing a key for the knowledge base. You can use the existing key that was imported earlier, or get a new key from the [Mendix Portal](https://genai.home.mendix.com/).
 
 5. If your app has the OpenAI Connector module:
 
-   1. Upgrade the OpenAI Connector module to V8.0.0 in your Mendix app.
+   1. Upgrade the OpenAI Connector module to V8.0.1 in your Mendix app.
    2. Include logic to run the data migration microflow upon starting your app (for example, include it in the after-startup): **OpenAIConnector** > **USE_ME** > **Migration** > `ConsumedKnowledgeBase_Migrate`. This microflow makes sure the new attributes on the generalization are set properly, and the `DisplayName` field is migrated.
    3. If the Agent Commons is part of your app and there are Agents defined using knowledge bases, include the following initially excluded sub-microflow into the app and add it as a microflow call according to the annotation in the above-mentioned microflow: **OpenAIConnector** > **USE_ME** > **Migration** > `Azure_KnowledgeBase_Migrate`. This microflow sets the `CollectionIdentifier` field on the `KnowledgeBase` entity and the outgoing reference to the `ConsumedKnowledgeBase`.
+   4. Set the `DisplayName` field for each `ConsumedKnowledgeBase` object by logging into the running app and using the `Configuration_Overview` page.
 
 6. If your app has the PgVector Knowledge Base module:
 
-   1. Upgrade the PgVector Knowledge Base module to V6.0.0 in your Mendix app.
+   1. Upgrade the PgVector Knowledge Base module to V6.0.1 in your Mendix app.
    2. Include logic to run the data migration microflow upon starting your application (forexample, include it in the after-startup): **PgVectorKnowledgeBase** > **USE_ME** > **Migration** > `ConsumedKnowledgeBase_Migrate`. This microflow makes sure the new attributes on the generalization are set properly, and the `DisplayName` field is migrated.
    3. If the **Agent Commons** is part of your app and there are Agents defined using knowledge bases, include the following initially excluded sub-microflow into the project and add it as a microflow call according to the annotation in the above-mentioned microflow: **PgVectorKnowledgeBase** > **USE_ME** > **Migration** > `PgVector_KnowledgeBase_Migrate`. This microflow sets the `CollectionIdentifier` field on the `KnowledgeBase` entity and outgoing reference to the `ConsumedKnowledgeBase`.
+   4. Set the `DisplayName` field for each `ConsumedKnowledgeBase` object by logging into the running app and using the `DatabaseConfiguration_Overview` page.
 
 7. Update any custom logic or pages in your application that reference:
-   1. The attributes `DisplayName_DEPR` on the `DatabaseConfiguration` and `AzureAISearchResource` entities. Instead, now use the `DisplayName` field that comes as part of the generalization. 
-   2. The association `KnowledgeBase_DeployedModel_DEPR`. Instead, now use the `CollectionIdentifier` attribute on the `KnowledgeBase` entity, if needed in combination with the `KnowledgeBase_ConsumedKnowledgeBase` association. 
+   1. The previously existing attributes `DisplayName` on the `DatabaseConfiguration` and `AzureAISearchResource` entities. Instead, now use the `DisplayName` field that comes as part of the generalization. 
+   2. The association `KnowledgeBase_DeployedModel`. Instead, now use the `CollectionIdentifier` attribute on the `KnowledgeBase` entity, if needed in combination with the `KnowledgeBase_ConsumedKnowledgeBase` association. 
 8. Verify your app compiles and runs correctly before deploying to cloud environments. 
 9. Remove the migration logic from the app logic the moment it has run at least once in every impacted environment. It can, however, be triggered multiple times without harm.
 
 {{% alert color="info" %}}
 
 Note the following:
 
-* The `KnowledgeBase_DeployedModel_DEPR` association will be permanently removed in the next major version of the Agent Commons module, which will be V4.0.0.
+* The `KnowledgeBase_DeployedModel` association will be permanently removed in the next major version of the Agent Commons module, which will be V4.0.0.
 
-* The `DisplayName_DEPR` attribute will be permanently removed in the next major version of the OpenAI Connector module, which will be V9.0.0.
-
-* The `DisplayName_DEPR` attribute will be permanently removed in the next major version of the PgVector Knowledge Base module, which will be V7.0.0.
- 
 * Ensure to run the migration microflow before upgrading to the next major version.
 {{% /alert %}}

content/en/docs/refguide/installation/install.md

@@ -50,7 +50,7 @@ The prerequisites are the following:
 
     | Studio Pro 11.0.0 - 11.6.2 | Studio Pro 11.6.3 and above |
     | --- | --- |
-    | [.NET Desktop Runtime 8.0.x (x64 or ARM64)](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) <br/> Mendix recommends using version 8.0.10 or above | [.NET Desktop Runtime 10.0.x (x64 or ARM64)](https://dotnet.microsoft.com/en-us/download/dotnet/10.0) <br/> Mendix recommends using version 10.0.0 or above |
+    | [.NET Desktop Runtime 8.0.x (x64 or ARM64)](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) <br/> Mendix recommends using version 8.0.10 or above | [.NET Desktop Runtime 10.0.x (x64 or ARM64)](https://dotnet.microsoft.com/en-us/download/dotnet/10.0) <br/> Mendix recommends using version 10.0.3 or above |
 
 * [Eclipse Temurin JDK 21 (x64 or ARM64)](https://adoptium.net/temurin/releases/?version=21)
 
@@ -86,8 +86,8 @@ It is possible to prepare the prerequisite installers beforehand so the setup pr
         * On x64, rename *windowsdesktop-runtime-8.0.10-win-x64.exe* to *windowsdesktop-runtime-8.0-x64.exe*
         * On ARM64, rename *windowsdesktop-runtime-8.0.10-win-arm64.exe* to *windowsdesktop-runtime-8.0-arm64.exe*
       * For Studio Pro versions 11.6.3 and above, rename the Microsoft .NET Desktop Runtime 10.0.x
-         * On x64, rename *windowsdesktop-runtime-10.0.0-win-x64.exe* to *windowsdesktop-runtime-10.0-x64.exe*
-         * On ARM64, rename *windowsdesktop-runtime-10.0.0-win-arm64.exe* to *windowsdesktop-runtime-10.0-arm64.exe*
+         * On x64, rename *windowsdesktop-runtime-10.0.3-win-x64.exe* to *windowsdesktop-runtime-10.0-x64.exe*
+         * On ARM64, rename *windowsdesktop-runtime-10.0.3-win-arm64.exe* to *windowsdesktop-runtime-10.0-arm64.exe*
    2. Eclipse Temurin JDK
       * Rename the Java Development Kit 21 *msi*
         * On x64, rename *OpenJDK21U-jdk_x64_windows_hotspot_21.0.5_11.msi* to *adoptiumjdk_21_x64.msi*