Skip to content

Duplicate Rename Maia sessions PR #9273 in Mendix-11 branch #9404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: Mendix-11
Choose a base branch
from
2 changes: 1 addition & 1 deletion content/en/docs/refguide10/modeling/domain-model/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,4 +120,4 @@ The entity `OrderLine` is stored in the table `module$orderline` which is shown
## Read More

* [Configuring a Domain Model](/refguide/configuring-a-domain-model/)
* [Maia Domain Model Generator](/refguide/domain-model-generator/)
* [Maia for Domain Model](/refguide/maia-for-domain-model/)
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ This document also presents [an example for defining the domain model](#example-
To create entities and their attributes, follow the steps below.

{{% alert color="info" %}}
If you are using Mendix version 10.13.0 or above, you can use the Maia domain model generator to create a domain model based on a description of your requirements. For more information, see [Maia Domain Model Generator](/refguide/domain-model-generator/).
If you are using Mendix version 10.13.0 or above, you can use Maia for Domain Model to create a domain model based on a description of your requirements. For more information, see [Maia for Domain Model](/refguide/maia-for-domain-model/).

The domain model generator is currently an experimental feature. For more information on experimental features, see [Beta and Experimental Releases](/releasenotes/beta-features/).
Maia for Domain Model is currently an experimental feature. For more information on experimental features, see [Beta and Experimental Releases](/releasenotes/beta-features/).
{{% /alert %}}

1. Open your [domain model](/refguide/domain-model/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ Recommenders:

Generators:

* **Domain Model Generator** (currently an [experimental feature](/releasenotes/beta-features/) introduced in Studio Pro 10.13.0) - an AI-powered tool that you can use for generating a [domain model](/refguide/domain-model/). It helps you to generate entities and associations based on text input. It currently only works for empty domain models. For more information, see [Domain Model Generator](/refguide/domain-model-generator/).
* **Page Generator** (currently an [experimental feature](/releasenotes/beta-features/) introduced in Studio Pro 10.21.0) - an AI-powered tool that lets you generate a [page](/refguide/page/). It helps you add and configure widgets based on a text input and an optional image. For more information, see [Page Generator](/refguide/page-generator/).
* **Maia for Domain Model** (currently an [experimental feature](/releasenotes/beta-features/) introduced in Studio Pro 10.13.0) - an AI-powered tool that you can use for generating new [domain models](/refguide/domain-model/) as well as explaining and providing suggestions for existing domain models. For more information, see [Maia for Domain Model](/refguide/maia-for-domain-model/).
* **Maia for Pages** (currently an [experimental feature](/releasenotes/beta-features/) introduced in Studio Pro 10.21.0) - an AI-powered tool that lets you generate a [page](/refguide/page/). It helps you add and configure widgets based on a text input and an optional image. After a page is generated, you can continue in the same session to ask Maia for further improvements and explanations. For more information, see [Maia for Pages](/refguide/maia-for-pages/).
* **Translation Generator** (currently an [experimental feature](/releasenotes/beta-features/) introduced in Studio Pro 10.12.0) - an AI-powered translation tool available in Mendix Studio Pro. Currently, it can be used for [batch translate](/refguide/translation-generator/#batch-translate) and [translating system texts](/refguide/translation-generator/#translate-system-text) in the new web-based system texts editor (in Studio Pro 10.14.0 and above). For more information, see [Translation Generator](/refguide/translation-generator/).

## Maia in Mendix Portal
Expand All @@ -64,9 +64,9 @@ The table below presents all the third-party services each Maia capability uses
| Logic Recommender | No third-party services used | N/A |
| UI Recommender | No third-party services used | N/A |
| Workflow Recommender | No third-party services used | N/A |
| Domain Model Generator | [Claude in Amazon Bedrock](https://aws.amazon.com/bedrock/claude/) | Project context to fulfill user prompt request |
| Page Generator | [Claude in Amazon Bedrock](https://aws.amazon.com/bedrock/claude/) | Project context to fulfill user prompt request |
| Maia for Domain Model | [Claude in Amazon Bedrock](https://aws.amazon.com/bedrock/claude/) | Project context to fulfill user prompt request |
| Maia for Pages | [Claude in Amazon Bedrock](https://aws.amazon.com/bedrock/claude/) | Project context to fulfill user prompt request |
| Translation Generator | [Amazon Translate](https://aws.amazon.com/translate/) | All translatable texts in the application, for example, labels, button names, and menu items |
| Maia Rewrite | [Mistral 7B](https://mistral.ai/news/announcing-mistral-7b/) hosted in Mendix AWS environment | The draft question description from users |
| Maia Summarize | [Mistral 7B](https://mistral.ai/news/announcing-mistral-7b/) hosted in Mendix AWS environment | [Community](https://community.mendix.com/p/community) threads |
[Maia Create User Story | [Mistral 7B](https://mistral.ai/news/announcing-mistral-7b/) hosted in Mendix AWS environment | User prompts ]
| Maia Create User Story | [Mistral 7B](https://mistral.ai/news/announcing-mistral-7b/) hosted in Mendix AWS environment | User prompts |

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -38,29 +38,29 @@ In Studio Pro 10.12 and above, it is enabled by default. You can disable it via

Logic Recommender is displayed as a blue plus in the flow. When you want to view recommendations on a particular flow, you can hover the mouse over that flow and click on the blue plus, or navigate to it with the keyboard and press <kbd>Enter</kbd>.

{{< figure src="/attachments/refguide10/modeling/mendix-ai-assistance/logic-bot-recommender/assist-bulb.png" max-width=50% >}}
{{< figure src="/attachments/refguide10/modeling/mendix-ai-assistance/logic-recommender/assist-bulb.png" max-width=50% >}}

{{% alert color="info" %}}
In Studio Pro 10.20 and above, if the sequence flow is too short or is selected, the blue plus is hidden. To open Logic Recommender in such cases, right-click the flow to open its context menu, and click **Open recommender**.
{{% /alert %}}

A dialog box is shown with recommendations of objects or activities to insert. This list initially contains the top 10 contextual suggestions. You can select an element directly from the recommendation list:

{{< figure src="/attachments/refguide10/modeling/mendix-ai-assistance/logic-bot-recommender/initial-recommendations.png" max-width=80% >}}
{{< figure src="/attachments/refguide10/modeling/mendix-ai-assistance/logic-recommender/initial-recommendations.png" max-width=80% >}}

You can also type in the search box to search for the elements that you want to add to the flow. Logic Recommender works with fuzzy search, which means that it finds direct matches first and then any matches in the recommendations. For instance, you can use `cr ob` to search for the recommendations that contain **Create Object**.

The search is based on your microflow or nanoflow parameters, domain model entities, or the documents in your app. You can search for generic activities or elements from the toolbox:

{{< figure src="/attachments/refguide10/modeling/mendix-ai-assistance/logic-bot-recommender/search-toolbox.png" max-width=80% >}}
{{< figure src="/attachments/refguide10/modeling/mendix-ai-assistance/logic-recommender/search-toolbox.png" max-width=80% >}}

You can search for sub-actions of an aggregate list or list operation activity, such as sum, count, or average:

{{< figure src="/attachments/refguide10/modeling/mendix-ai-assistance/logic-bot-recommender/search-sub-actions.png" max-width=100% >}}
{{< figure src="/attachments/refguide10/modeling/mendix-ai-assistance/logic-recommender/search-sub-actions.png" max-width=100% >}}

You can also use the search to call microflows or nanoflows with a concrete document:

{{< figure src="/attachments/refguide10/modeling/mendix-ai-assistance/logic-bot-recommender/search-sub-flows.png" max-width=80% >}}
{{< figure src="/attachments/refguide10/modeling/mendix-ai-assistance/logic-recommender/search-sub-flows.png" max-width=80% >}}

Choose a suggestion and click it to accept it. You can also choose a suggestion with the arrow keys and press the <kbd>Enter</kbd> key to accept it. The suggested element will be added to the flow and the Recommender will open on the next flow so that you can continue adding activities.

Expand All @@ -74,7 +74,7 @@ To use this older version of Logic Recommender, do the following:

1. Click the icon to see the next best action recommendations:

{{< figure src="/attachments/refguide10/modeling/mendix-ai-assistance/logic-bot-recommender/mx-assist-recommendations.png" alt="Logic Bot Recommendations" class="no-border" >}}
{{< figure src="/attachments/refguide10/modeling/mendix-ai-assistance/logic-recommender/mx-assist-recommendations.png" alt="Logic Bot Recommendations" class="no-border" >}}

2. Click one of the recommended activities to insert it into a microflow.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
title: "Maia for Domain Model"
url: /refguide/maia-for-domain-model/
weight: 50
description: "Describes the features in Maia for Domain Model."
aliases:
- /refguide/domain-model-generator/
#If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details.
---

## Introduction

{{% alert color="info" %}}
Maia for Domain Model is currently an experimental feature introduced in Studio Pro 10.13.0. For more information on experimental features, see [Beta and Experimental Releases](/releasenotes/beta-features/). From Studio Pro 10.13 to 10.21, it was called Domain Model Generator.
{{% /alert %}}

{{% alert color="info" %}}
To use Maia for Domain Model, an internet connection and signing in to Studio Pro are required.
{{% /alert %}}

Maia for Domain Model is an AI-powered tool that you can use for generating new [domain model](/refguide/domain-model/) as well as explaining and providing suggestions for existing domain models. Accessing Maia for Domain Model directly in existing domain models is supported in Studio Pro 10.18 and above. As an experimental feature, Maia for Domain Model still has several limitations. For more information, see the [Limitations](#limitation) section below.

## Using Maia for Domain Model

In Studio Pro 10.18 and above, Maia for Domain Model is enabled by default.

You can find it in the the toolbar of a domain model:

{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-for-domain-model/maia-for-domain-model.png" max-width=80% >}}

If you want to disable this feature, go to **Edit** > **Preferences** > the **New Features** tab > the **Maia** section.

After clicking **Maia for Domain Model**, a dedicated chat interface will appear at the right side of Studio Pro under the **Maia** tab:

{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-for-domain-model/chat-interface.png" max-width=42% >}}

Describe your application or its main goals in the chat. Maia will use this information to generate a relevant domain model for you. After a domain model is generated and if the dedicated chat is still active, you can continue asking Maia to add more entities and associations to the generated domain model. You can also ask Maia to explain or improve the generated domain model through further requests.

In Studio Pro 10.17 and above, it also supports adding more attributes to an existing entity in the generated domain model. In Studio Pro 10.18 and above, you can access Maia for Domain Model directly in existing domain models.

{{% alert color="info" %}}
Maia for Domain Model does not support deleting items in the domain model. You can always delete them manually.
{{% /alert %}}

{{% alert color="info" %}}
In this dedicated chat, only requests related to domain model will be properly handled. If you have other questions, close this chat and go back to the general [Maia Chat](/refguide/maia-chat/) interface.
{{% /alert %}}

### Best Practices for Text Input

To achieve optimal results, provide context about your application by describing its main use cases, customer needs, or other relevant details. The more Maia knows about your application, the more tailored and accurate the generated domain model will be.

Below are some examples of prompts you can use as a starting point:

* The app will help users ...
* This module handles ...
* Customers need to be able to ...
* I want to send notifications when ...
* The app will analyze and report on ...
* This feature allows users to ...

Below are examples of prompts you can use to ask Maia for explanations or suggestions to improve a domain model:

* Can you explain the function and purpose of this domain model?
* I want to add an attribute `ATTRIBUTE_NAME` to the entity `ENTITY_NAME`.
* I want to make the domain model more efficient. Can you suggest optimizations?
* Could you identify any potential issues with this domain model and recommend solutions?

## Limitations {#limitation}

As an experimental feature, Maia for Domain Model has some limitations.

### Enumeration Generation

In Studio Pro 10.17 and below, it is not possible to generate [enumerations](/refguide/enumerations/). In Studio Pro 10.18 and above, it can generate an attribute of type Enumeration if there is an existing enumeration in the module to refer to.

### Generalization Not Supported

Currently, it cannot set [generalization](/refguide/generalization-and-association/) for an entity.

## Read More

* [Data in the Domain Model](/refguide/domain-model/)
* [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/)
* [Maia Chat](/refguide/maia-chat/)
Loading