Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Mendix AI Assistance (Maia)"
url: /refguide/mendix-ai-assistance/
weight: 45
weight: 17
description: "Describes Mendix AI Assistance (Maia) in Studio Pro."
aliases:
- /refguide/mx-assist-studio-pro/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Best Practice Recommender is enabled by default and is designed as a pane. To ac

The pane gives you information on each anti-pattern and contains Best Practice Recommender settings and configurations:

{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/best-practice-recommender/best-practice-recommender-pane.png" alt="Best Practice Recommender Pane" class="no-border" >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/best-practice-recommender/best-practice-recommender-pane.png" alt="Best Practice Recommender Pane" class="no-border" >}}

### Options and Configuration {#options}

Expand All @@ -46,11 +46,11 @@ At the top of the **Best Practice Recommender** pane, you can see the following

* The **App Model** tab lists all relevant documents in your app. You can choose which specific modules or documents to inspect or leave out.

{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/best-practice-recommender/app-model.png" alt="App Model" width="300px" >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/best-practice-recommender/app-model.png" alt="App Model" width="300px" >}}

* The **Best Practice** tab lists the available best practice. You can choose your preferred best practices and inspect your model against it:

{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/best-practice-recommender/best-practice.png" alt="Best Practice" width="400px" >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/best-practice-recommender/best-practice.png" alt="Best Practice" width="400px" >}}

You can use both app model and best practice configuration together.

Expand All @@ -69,7 +69,7 @@ Each anti-pattern line in the pane provides you with the following information:

Right-clicking the message line of an anti-pattern in the pane opens the drop-down menu:

{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/best-practice-recommender/drop-down-menu.jpg" alt="Drop-Down Menu" class="no-border" >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/best-practice-recommender/drop-down-menu.jpg" alt="Drop-Down Menu" class="no-border" >}}

The following actions are available in the drop-down menu:

Expand All @@ -93,7 +93,7 @@ The **Inspect now** option will be disabled if there are consistency errors in t

The recommender will detect anti-patterns and list them in the pane under the associated anti-pattern type. To learn more about each anti-pattern type, click the anti-pattern code link. Click the arrow icon next to the anti-pattern type to see the detected cases of this type:

{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/best-practice-recommender/viewing-anti-pattern.jpg" alt="Viewing Anti-Pattern" class="no-border" >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/best-practice-recommender/viewing-anti-pattern.jpg" alt="Viewing Anti-Pattern" class="no-border" >}}

To view the element or the document where the anti-pattern is located, double-click the message line or right-click the message line and choose **Go to Cause** or **Go to Usage** in the drop-down menu.

Expand All @@ -110,24 +110,24 @@ There are two ways to view the recommendations:
1. Right-click an anti-pattern message on the pane and select **View Best Practice recommendation** in the drop-down menu.
2. Click an indicator in the visual editor to view the detected issue:

{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/best-practice-recommender/indicator-in-editor.jpg" alt="Indicator in the Editor" width="450px" class="no-border" >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/best-practice-recommender/indicator-in-editor.jpg" alt="Indicator in the Editor" width="450px" class="no-border" >}}

The recommendation contains the description of the identified issue, potential impact from it, the way to fix it, and a link to a more detailed guidance on fixing the issue:

{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/best-practice-recommender/best-practice-recommendation.png" alt="Best Practice Recommendation" width="500px" >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/best-practice-recommender/best-practice-recommendation.png" alt="Best Practice Recommendation" width="500px" >}}

### Auto-Fixing the Anti-Pattern {#auto-fixing}

The third level of assistance is **auto-fixing** where the recommender can automatically implement the best practice and fix the issue in just one click. To avoid undesirable changes, auto-fixing is only available when the recommender can safely refactor the code without creating an error or making other undesirable change in the model. Each anti-pattern has an icon in the pane that indicates whether it is auto-fixable. If the icon has the “A” letter, the issue can be auto-fixed:

{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/best-practice-recommender/auto-fixable.png" alt="Auto-Fixable Icon" width="45" class="no-border" >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/best-practice-recommender/auto-fixable.png" alt="Auto-Fixable Icon" width="45" class="no-border" >}}

To auto-fix the issue, follow the steps below:

1. Click the corresponding indicator in the editor to open the recommendation or right-click the message line in the pane and select **View Best Practice recommendation** in the drop-down menu.
2. In the **Recommendation from Best Practice Recommender** pop-up window, click **Fix**:

{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/best-practice-recommender/fix-issue.png" alt="Fix Issue" width="500px" >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/best-practice-recommender/fix-issue.png" alt="Fix Issue" width="500px" >}}

After the issue is auto-fixed, a pop-up window listing the changes appears. You can click **Show the fix** to view the changed document and element.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,29 +34,29 @@ Logic Recommender is enabled by default. You can disable it via **Edit** > **Pre

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/refguide/modeling/mendix-ai-assistance/logic-recommender/assist-bulb.png" max-width=50% >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/logic-recommender/assist-bulb.png" max-width=50% >}}

{{% alert color="info" %}}
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/refguide/modeling/mendix-ai-assistance/logic-recommender/initial-recommendations.png" max-width=80% >}}
{{< figure src="/attachments/refguide/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/refguide/modeling/mendix-ai-assistance/logic-recommender/search-toolbox.png" max-width=80% >}}
{{< figure src="/attachments/refguide/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/refguide/modeling/mendix-ai-assistance/logic-recommender/search-sub-actions.png" max-width=100% >}}
{{< figure src="/attachments/refguide/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/refguide/modeling/mendix-ai-assistance/logic-recommender/search-sub-flows.png" max-width=80% >}}
{{< figure src="/attachments/refguide/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 Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ There are two ways to access Maia Learn:

The learning interface appears at the right side of Studio Pro under the **Maia** tab:

{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-learn/maia-learn-interface.png" width="300px">}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-learn/maia-learn-interface.png" width="300px">}}

Click **Mendix Core Concepts**, you can start your learning journey with Maia Learn and learn all the basics about domain models, pages, logic, security, and integrations, including how you can apply these core concepts in Studio Pro.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Maia Make capabilities are enabled by default. You can disable them in Studio Pr

To access the conversational interface and Maia Make capabilities, in the upper-right corner of Studio Pro, click the **Maia** pane. It appears under the **Chat** tab:

{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-make-interface.png" max-width=40% alt="Maia Make interface" >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-interface.png" max-width=40% alt="Maia Make interface" >}}

Alternatively, you can also click **View** at the Studio Pro top bar and select **Maia** to open the interface.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ In Studio Pro 11.7 and below, there are two ways to access Maia Chat in Studio P

The chat interface appears at the right side of Studio Pro under the **Maia** pane:

{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-chat/maia-chat-interface.png" width="250px">}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-chat/maia-chat-interface.png" width="250px">}}

You can start using Maia Chat by clicking one of the demo questions. Alternatively, you can ask your own question, and press <kbd>Enter</kbd> or click **Ask** to send the question. For information on the supported shortcut keys in Maia Chat, see the [Maia Chat Shortcut Keys](/refguide/keyboard-shortcuts/#maia-chat-shortcuts) section in *Keyboard Shortcuts*.

Expand Down Expand Up @@ -79,7 +79,7 @@ There are several ways to give feedback on the generated answer:
* Click the thumbs up icon ({{% icon name="thumbs-up" %}}) or the thumbs down icon ({{% icon name="thumbs-down" %}})
* To provide more detailed feedback, click the add feedback icon ({{% icon name="notes-paper-edit" %}}). A detailed **Feedback** section shows below the answer:

{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-chat/feedback-section.png" width="250px" >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-chat/feedback-section.png" width="250px" >}}

* You can rate the **correctness**, **completeness**, and **readability** of the provided answer.
* You can also provide **Additional feedback** if you want to.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ There are two ways to use Maia Explain:

A message is sent to Maia and a chat interface with an initial answer appears on the right side of Studio Pro under the **Maia** tab:

{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-explain/maia-explain-interface.png" width="300px">}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-explain/maia-explain-interface.png" width="300px">}}

The initial answer consists of two parts:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ In Studio Pro 11.8 and above, Maia for Domain Model is incorporated into the uni

In Studio Pro 11.7 and below, 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-make/maia-for-domain-model/maia-for-domain-model.png" max-width=80% >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-for-domain-model/maia-for-domain-model.png" max-width=80% >}}

If you want to disable this feature, go to **Edit** > **Preferences** > the **Maia** tab and clear the **Enable Maia for Domain Model** checkbox.

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-make/maia-for-domain-model/chat-interface.png" max-width=42% >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/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. In Studio Pro 11.1 and above, you can also attach maximally one image and one PDF to help Maia better understand your request. For more information, see the [Attachment Requirements](#attachment-requirements) section below.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ In Studio Pro 11.8 and below, to enable Maia for OQL, navigate to **Edit** > **P

Once enabled, you can access it from the toolbar in the **OQL Editor**:

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

Clicking **Maia for OQL** opens a dedicated chat interface on the right side of Studio Pro, under the **Maia** tab:

{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-oql-generator/maia-pane-for-oql-generator.png" max-width=42% >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-oql-generator/maia-pane-for-oql-generator.png" max-width=42% >}}

To use Maia for OQL, simply describe the data you need. For example, if you type *Show all active orders with customer names*, Maia will generate the most relevant OQL query based on the data available in the same module.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ In Studio Pro 11.7 and below, to enable Maia for Pages, go to **Edit** > **Prefe

Once enabled, you can find it in the the toolbar of a page:

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

{{% alert color="info" %}}
Maia for Pages is available in both the **Structure mode** and **Design mode**.
{{% /alert %}}

After clicking **Maia for Pages**, a dedicated chat interface appears at the right side of Studio Pro under the **Maia** tab:

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

Describe your page or its main goals in the chat. Maia uses this information to add relevant widgets to the page and configure them for you. When generating a page, Maia knows about the domain model of the module you are currently working on. For example, it might include a [Data View](/refguide/data-view/) with some [Text Box](/refguide/text-box/) widgets for an attribute of an entity.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ Maia for Workflows is not available.

To enable Maia for Workflows, go to **Edit** > **Preferences** > the **Maia** tab and select **Enable Maia for Workflows**. Once enabled, you can find it in the toolbar of a workflow:

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

After clicking **Maia for Workflow**, a chat interface appears at the right side of Studio Pro under the **Maia** tab:

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

### Best Practices for Text Input {#text-input-best-practice}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Maia can fetch and read content from public websites and APIs. It can retrieve d

When Maia wants to fetch content from the web, it asks for your permission first. You can approve or deny each request. The permission dialog looks like this:

{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-web-fetch/maia-web-fetch-permission-dialog.png" alt="Maia Web Fetch permission dialog" max-width=80% >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-web-fetch/maia-web-fetch-permission-dialog.png" alt="Maia Web Fetch permission dialog" max-width=80% >}}

## What Maia Can Fetch

Expand Down
Loading