diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/_index.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/_index.md index baa43a928cc..06230031569 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/_index.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/_index.md @@ -7,17 +7,17 @@ description_list: true #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 +## Introduction {{% alert color="info" %}} Maia Make capabilities are available in Studio Pro 11.8 and above. -To use Maia Make capabilities, an internet connection and signing in to Studio Pro are required. +To use Maia Make capabilities, you need an internet connection and must be signed in to Studio Pro. {{% /alert %}} -Maia Make is a set of AI-assisted development capabilities in Studio Pro that are available through a unified conversational interface. Describe your requirements in natural language, and Maia generates development artifacts such as data structures, pages, and microflows. +Maia Make is a set of AI-assisted development capabilities in Studio Pro that are available through a unified conversational interface. Describe your requirements in natural language, and Maia generates development artifacts such as data structures, pages, and microflows. -You can also ask Maia to provide explanations of your existing documents, such as microflows, workflows, and pages. Moreover, this interface allows you to integrate with external tools, such as Playwright and Figma, via MCP Servers, and it supports story-based development by generating app artifacts based on existing user stories. +You can also ask Maia to provide explanations of your existing documents, such as microflows, workflows, and pages. Moreover, this interface allows you to integrate with external tools, such as Playwright and Figma, via MCP servers. It also supports story-based development by generating app artifacts based on existing user stories. ## Maia Make Capabilities Overview @@ -51,12 +51,12 @@ The following table lists Maia Make Standalone Capabilities and the Studio Pro v | Capability | Description | Available in Maia Make from | Remarks | | --- | --- | --- | --- | | [Maia Chat](/refguide/maia-chat/) | Answers questions about all aspects of Mendix development. | Studio Pro 11.8 | | -| [Maia Explain](/refguide/maia-explain/) | Explains the purpose and logic of existing documents. | Studio Pro 11.8 | | +| [Maia Explain](/refguide/maia-explain/) | Explains the purpose and logic of existing documents. | Studio Pro 11.8 | Can be used directly in the chat interface, or in the App Explorer by right-clicking a document and clicking **Maia Explain**. | | [Maia MCP Client](/refguide/maia-mcp/) | Connects Maia to external MCP servers, giving it access to third-party tools. | Studio Pro 11.8 | | | [Studio Pro MCP Server](/refguide/studio-pro-mcp-server/) | Exposes Studio Pro as an MCP server for use by external AI tools. | Studio Pro 11.10 | | | [Maia Web Fetch](/refguide/maia-web-fetch/) | Fetches and reads content from public websites and APIs. | Studio Pro 11.10 | | | [Maia Agent Skills](/refguide/maia-agent-skills/) | Extends Maia with reusable knowledge. | Studio Pro 11.11 | | -| [Maia Agent Instructions](/refguide/maia-instructions/) | Extends Maia with instructions to be followed with every prompt | Studio Pro 11.12 | | +| [Maia Agent Instructions](/refguide/maia-instructions/) | Extends Maia with instructions to be followed with every prompt. | Studio Pro 11.12 | | ### Maia Make General Capabilities @@ -66,7 +66,7 @@ The following table lists the general capabilities of Maia Make and the Studio P | --- | --- | --- | --- | | Story-based development | Generates app artifacts based on existing user stories to support story-driven development workflows. | Studio Pro 11.8 | | | PDF/image support | Allows you to provide PDFs and images as input to help Maia better understand your requirements. | Studio Pro 11.8 | | -| Adding documents as context | Lets you add relevant documents, to provide Maia with additional context. | Studio Pro 11.8 | | +| Adding documents as context | Lets you add relevant documents to provide Maia with additional context. | Studio Pro 11.8 | | | Editing existing documents | Enables Maia to modify existing documents, including renaming elements. | Studio Pro 11.8 | | | Removing elements | Allows Maia to remove elements from documents to support more advanced refactoring tasks. | Studio Pro 11.9 | | | Undo support | Allows you to undo Maia-generated changes on a per-document basis. | Studio Pro 11.9 | | @@ -83,7 +83,7 @@ To access the conversational interface and Maia Make capabilities, in the upper- {{< 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. +Alternatively, you can click **View** on the Studio Pro top bar and select **Maia** to open the interface. {{% alert color="info" %}} In Studio Pro 11.7 and below, the **Chat** tab is only used for [Maia Chat](/refguide/maia-chat/) where you can ask questions about all aspects of Mendix. @@ -92,42 +92,46 @@ There is also the **Learn** tab under the **Maia** pane. It is a separate Maia c {{% /alert %}} {{% alert color="warning" %}} -The Maia ({{% icon name="sparkles" %}} ) icon on the right side of the top bar does not work in Studio Pro 11.8. +The Maia ({{% icon name="sparkles" %}}) icon on the right side of the top bar does not work in Studio Pro 11.8. {{% /alert %}} ### Maia Make Capabilities Interface Overview The conversational interface includes the following features. +{{% alert color="info" %}} +Maia Make loses the conversation history if you exit Studio Pro. +{{% /alert %}} + #### New Chat Clicking **New Chat** allows you to clear the messages and start a new conversation that does not reference your current chat. -{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/new-chat.jpg" width="250px" >}} +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/new-chat.jpg" width="250px" alt="" >}} -#### Configure MCP Connections +#### Configure MCP Connections This option ({{% icon name="plug" %}}) allows you to connect external [MCP](https://modelcontextprotocol.io/introduction) servers to Maia, giving it access to third-party tools during chat. For more information on how to configure MCP connections, see [Maia MCP Client](/refguide/maia-mcp/). -{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/configure.jpg" width="250px" >}} +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/configure.jpg" width="250px" alt="" >}} #### Add **{{% icon name="paperclip" %}} Add** allows you to attach images, PDFs, or user stories to help Maia understand your requirements better. -{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/add.jpg" width="250px" >}} +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/add.jpg" width="250px" alt="" >}} -#### Add file to Maia Chat +#### Add file to Maia Chat -This option (@ icon) allows you to add certain logic or pages to Maia as context. You can also access this option by right-clicking the documents (microflows or pages) in the **App Explorer** and it appears in the context menu. +This option (@ icon) allows you to add certain logic or pages to Maia as context. You can also access this option by right-clicking the documents (microflows or pages) in the **App Explorer**, where it appears in the context menu. -{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/add-files.jpg" width="250px" >}} +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/add-files.jpg" width="250px" alt="" >}} #### Changed List A list of items added or changed by Maia appears above the chat box. Click an entry to open the relevant document. To undo all changes, click **Undo all**. To undo a single change, click the undo button on the right side of that item. -{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/changed-list.png" width="250px" >}} +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/changed-list.png" width="250px" alt="" >}} #### Clarifying Questions @@ -135,7 +139,7 @@ A list of items added or changed by Maia appears above the chat box. Click an en This feature is available for Studio Pro 11.12 and above. {{% /alert %}} -When Maia needs more information, it will ask clarifying questions through a dedicated UI to improve the quality of its response. +When Maia needs more information, it asks clarifying questions through a dedicated UI to improve the quality of its response. ## Save a Maia Session {#save-maia-session} @@ -192,10 +196,58 @@ To configure an OpenAI-compatible provider, follow these steps: [Private Mendix Platform](/private-mendix-platform/) provides an environment where you can develop and deploy your applications within your own enterprise security boundary to ensure the highest levels of data security and compliance. Because Private Mendix Platform instances are hosted within the enterprise firewall, selecting an LLM provider other than the default [Mendix Platform](#mendix-platform) requires you to also configure the LLM Gateway URL. -{{< figure src="/attachments/private-platform/pmp-llm-gateway.png" class="no-border" >}} +{{< figure src="/attachments/private-platform/pmp-llm-gateway.png" class="no-border" alt="" >}} The LLM Gateway URL is configured during the installation or upgrade of Private Mendix Platform. For more information, see [Installing Maia for Private Mendix Platform](/private-mendix-platform/interactive-installation/#maia). +## Best Practices + +### Text Input + +To achieve optimal results, provide context about your app or the document you are working on by describing its main use cases, customer needs, or other relevant details. The more Maia knows about what you are building, the more tailored and accurate the generated results will be. + +#### Providing Context + +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... +* The page will be used to... +* Generate a workflow for a process that... +* This feature allows users to... + +#### Editing and Improving + +Below are examples of prompts you can use to ask Maia to make further edits or request explanations and suggestions for improving a document: + +* Can you explain the function and purpose of this document? +* I want to add an attribute `ATTRIBUTE_NAME` to the entity `ENTITY_NAME`. +* Can you add a button called `BUTTON_NAME` to the page? +* I want an area on the page where users can... +* Remove the ... widget. +* How can I make this page more user-friendly or visually appealing? +* Could you identify any potential issues with this document and recommend solutions? +* Can you give me suggestions to improve this workflow? + +#### Workflows + +You can provide a BPMN image representing employee onboarding alongside your text input. Maia can analyze the image, rework it using Mendix Workflows terminology, and generate the corresponding activities. Use text input alongside the image to specify any differences. For example, "Generate a workflow based on this BPMN image, but make sure it waits before sending an email to the new employee." + +#### Microflows + +When generating microflows, consider the following additional guidelines: + +* **Be specific:** Clearly describe the desired outcome and the steps involved. For example, instead of using *Create a user*, use *Create a new user object, set its name attribute to 'John Doe', and commit it*. +* **Use keywords:** Incorporate terms relevant to microflow activities, such as *create object*, *retrieve*, *change object*, *show message*, *loop*, or *decision*. This can help with correct microflow generation. +* **Provide context:** If your microflow interacts with existing entities or attributes, mention them in your text input. + +### Image Input + +The image size is limited to 512 KB. Make sure to select a clear image to help Maia better understand your request. For example, you can provide a screenshot, a photo, a design mock-up, or a close-up picture of a drawing. Avoid heavily compressed or low-quality images, as these may result in the loss of important details. + +Keep in mind that Maia analyzes only the structure of the image. Maia does not change the theming of your app, such as the color scheme. This can cause some differences between the provided image and the generated page. + ## Read More * [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-chat.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-chat.md index 8bdc88770be..1371e97adc5 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-chat.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-chat.md @@ -3,7 +3,7 @@ title: "Maia Chat" linktitle: "Chat" url: /refguide/maia-chat/ weight: 5 -description: "Describes the features in Maia Chat." +description: "Describes how to use Maia Chat, the built-in AI chat interface in Studio Pro." aliases: - /refguide/mendix-chat/ #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. @@ -16,16 +16,16 @@ Maia Chat is also available in the Mendix Portal. For more information, refer to {{% /alert %}} {{% alert color="info" %}} -To use Maia Chat, an internet connection and signing in to Studio Pro are required. +To use Maia Chat, you need an internet connection and must be signed in to Studio Pro. {{% /alert %}} {{% alert color="info" %}} -Maia Chat does not use any project, customer, or company information. It only uses the data that you have entered in the Chat to fulfill the user request. Please do not enter any personal or sensitive data! +Maia Chat does not use any project, customer, or company information. It only uses the data you enter in the chat to fulfill the request. Do not enter any personal or sensitive data. {{% /alert %}} -Maia Chat is a built-in chat interface in the Mendix Platform powered by generative AI. Developers can ask questions about all aspects of Mendix, including how to apply concepts, best practices, governance tools, and development patterns. It is based on large language models (LLMs) using data from various resources. +Maia Chat is a built-in chat interface in the Mendix Platform powered by generative AI. You can ask questions about all aspects of Mendix, including how to apply concepts, best practices, governance tools, and development patterns. It is based on large language models (LLMs) using data from various resources. -See below a list of Maia Chat's data sources: +Maia Chat uses the following data sources: * [Mendix Docs](/) * [Mendix Community](https://community.mendix.com/) @@ -39,7 +39,7 @@ See below a list of Maia Chat's data sources: ### In Studio Pro 11.8 and Above -In Studio Pro 11.8 and above, Maia Chat is incorporated into the unified Maia Make capabilities, which are enabled by default. There is no dedicated interface only for Maia Chat. For more information, see [Maia Make Capabilities](/refguide/maia-make/). +In Studio Pro 11.8 and above, Maia Chat is incorporated into the unified Maia Make capabilities, which are enabled by default. Maia Chat does not have a dedicated interface. For more information, see [Maia Make Capabilities](/refguide/maia-make/). ### In Studio Pro 11.7 and Below @@ -48,55 +48,29 @@ In Studio Pro 11.7 and below, there are two ways to access Maia Chat in Studio P * Click the **Maia** ({{% icon name="sparkles" %}}) icon to the right of the top bar. * Go to the **View** menu and click **Maia**. -The chat interface appears at the right side of Studio Pro under the **Maia** pane: +The chat interface appears on the right side of Studio Pro under the **Maia** pane: -{{< figure src="/attachments/refguide/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" alt="" width="250px">}} You can start using Maia Chat by clicking one of the demo questions. Alternatively, you can ask your own question, and press Enter 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*. -For more information on Maia Chat features in Studio Pro, see the sub-sections below. +For tips on getting better responses, see the [Best Practices](/portal/maia/#best-practices) section in *Maia in Mendix Portal*. -If Maia is not giving you a good answer, check the [best practices](/portal/maia/#best-practices) in *Maia in Mendix Portal*. If you still can not get a good answer, please see the [Giving Feedback](#feedback) section below for information on how to let Mendix know. +#### Giving Feedback {#feedback} -#### Maia Chat Features in Studio Pro - -After a question is sent to Maia Chat, you will see the following in the chat interface: - -* An answer generated by Maia Chat -* Links to top relevant resources like Mendix documentation, Mendix Community, and Academy learning paths - - {{% alert color="info" %}}You can also see the Mendix version of the references, the level of the learning path if the reference comes from Mendix Academy, and the date and answer status if the reference comes from the Mendix Community.{{% /alert %}} - -* A copy icon ({{% icon name="copy" %}}) which allows you to copy the given answer to a clipboard -* Feedback icons - -##### Giving Feedback {#feedback} - -Mendix encourages giving feedback on the answers generated by Maia Chat. Feedback will be used to further improve Maia Chat. +Mendix encourages you to provide feedback on Maia Chat answers to help improve the feature. 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/mendix-ai-assistance/maia-make/maia-chat/feedback-section.png" width="250px" >}} +* To provide more detailed feedback, click the add feedback icon ({{% icon name="notes-paper-edit" %}}). A detailed **Feedback** section appears below the answer: - * You can rate the **correctness**, **completeness**, and **readability** of the provided answer. - * You can also provide **Additional feedback** if you want to. - * Remember to click **Submit feedback** to submit your feedback. Afterwards, you will be brought back to the main chat interface where you can continue asking questions. + {{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-chat/feedback-section.png" alt="" width="250px" >}} -##### Asking Follow-Up Questions + * You can rate the **correctness**, **completeness**, and **readability** of the answer. + * You can add comments in the **Additional feedback** field. + * Click **Submit feedback** to send your feedback. Maia Chat then returns you to the main chat interface, where you can continue asking questions. -Maia Chat supports asking follow-up questions based on your previous question and the answer you have received. For example, you can ask it to summarize the latest answer you received by typing the following in the chat: *Can you summarize that?*. - -{{% alert color="info" %}} -Maia Chat will lose track of the conversation history if you exit Studio Pro. -{{% /alert %}} - -##### New Chat - -There is a **New chat** option at the top left of the chat interface. It allows you to clear the messages and start a new conversation which does not reference your current chat. - ## Read More -Under the **Maia** pane, there is also a tab called **Learn**. For more information, see [Maia Learn](/refguide/maia-learn/). +The **Maia** pane also includes a **Learn** tab. For more information, see [Maia Learn](/refguide/maia-learn/). diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-explain.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-explain.md index 76690e11d56..03500b3142f 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-explain.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-explain.md @@ -6,24 +6,26 @@ weight: 10 description: "Describes the features in Maia Explain." --- -## Introduction +## Introduction {{% alert color="info" %}} -To use Maia Explain, an internet connection and signing in to Studio Pro are required. +To use Maia Explain, you need an internet connection and must be signed in to Studio Pro. {{% /alert %}} ## Using Maia Explain ### In Studio Pro 11.8 and Above -In Studio Pro 11.8 and above, Maia Explain is incorporated into the unified Maia Make capabilities, which are enabled by default. There is no dedicated interface only for Maia Explain. For more information, see [Maia Make Capabilities](/refguide/maia-make/). +In Studio Pro 11.8 and above, Maia Explain is part of the unified Maia Make capabilities, which are enabled by default. Maia Explain does not have a dedicated interface. For more information, see [Maia Make Capabilities](/refguide/maia-make/). There are two ways to use Maia Explain: -* Use the chat interface directly to get explanations of your document (for instance, a microflow or a page). +* Use the chat interface directly to get explanations of your document (for example, a microflow or a page). * In the App Explorer, right-click a document to open its context menu, and click **Maia Explain**. -Nanoflows are currently not supported by Maia Make. +{{% alert color="info" %}} +Maia Make does not currently support nanoflows. +{{% /alert %}} ### In Studio Pro 11.7 and Below @@ -34,23 +36,23 @@ There are two ways to use Maia Explain: * In the toolbar of the microflow or nanoflow editor, click **Explain**. * In the App Explorer, right-click a microflow or a nanoflow to open its context menu, and click **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: +Studio Pro sends a message to Maia, and a chat interface with an initial answer appears on the right side under the **Maia** tab: -{{< figure src="/attachments/refguide/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" alt="" width="300px">}} -The initial answer consists of two parts: +The initial answer consists of two parts: -* **Explanation** - provides a high-level overview of the logic, including its overall purpose -* **Technical Highlights** - highlights the technical and functional details of the logic, including any input parameters and return value, if available +* **Explanation** – provides a high-level overview of the logic, including its overall purpose +* **Technical Highlights** – highlights the technical and functional details of the logic, including any input parameters and return value, if available -Maia Explain supports follow-up questions. You can modify the tone of the answer, request further clarification, or ask for suggestions to improve the logic. Below are examples of what you could type as follow-up questions or requests: +Maia Explain supports follow-up questions. You can modify the tone of the answer, request further clarification, or ask for suggestions to improve the logic. Below are examples of what you can type as follow-up questions or requests: * *Explain again, but in 10 words.* * *Explain again, but in much greater detail. Be very thorough.* -* *What are your suggestions to improve this microflow?"* +* *What are your suggestions to improve this microflow?* {{% alert color="info" %}} -In this dedicated chat, only requests related to Maia Explain will be properly handled. If you have other questions, close this chat and go back to the general [Maia Chat](/refguide/maia-chat/) interface. +In this dedicated chat, only requests related to Maia Explain are properly handled. If you have other questions, close this chat and go back to the general [Maia Chat](/refguide/maia-chat/) interface. {{% /alert %}} ## Read More diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-domain-model.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-domain-model.md index 080bdd25f86..1cc36fb7a5c 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-domain-model.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-domain-model.md @@ -45,26 +45,6 @@ Maia for Domain Model does not support deleting items in the domain model. You c {{% 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? #### Attachment Requirements {#attachment-requirements} diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-microflows.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-microflows.md index 2688da0bb3a..a7207c79a61 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-microflows.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-microflows.md @@ -18,15 +18,11 @@ With the microflow generation capability, you can leverage Maia to generate micr ## Using Maia for Microflows -Open the Maia Make conversational interface in Studio Pro to access its microflow generation capability. Use natural language to describe your goal, Maia will generate the microflows for you, including XPath constraints and expressions. See the section below for text input best practices. +Open the Maia Make conversational interface in Studio Pro to access its microflow generation capability. Use natural language to describe your goal, Maia will generate the microflows for you, including XPath constraints and expressions. -### Best Practices for Text Input - -To achieve the best results when using Maia to generate microflows, consider the following guidelines for your text input: - -* Be specific: Clearly describe the desired outcome and the steps involved. For example, instead of using *Create a user*, use *Create a new user object, set its name attribute to 'John Doe', and commit it*. -* Use keywords: Incorporate terms relevant to microflow activities, such as *create object*, *retrieve*, *change object*, *show message*, *loop*, or *decision*. This can help with correct microflow generation. -* Provide context: If your microflow interacts with existing entities or attributes, mention them in your text input. +{{% alert color="warning" %}} +Due to the nature of AI generation, the exact microflow logic produced can vary between separate runs, even with identical input. Review the generated output carefully. The visual layout and positioning of elements may not always be optimally organized; you may need to adjust the arrangement of activities for better readability and structure. +{{% /alert %}} ## Limitations @@ -38,14 +34,6 @@ In Studio Pro 11.9 and above, Maia can delete flows and microflow objects. Howev In Studio Pro 11.8, Maia cannot delete objects or flows. For existing objects, Maia can change variable names, move objects, or reconnect flows, but it cannot delete objects or flows, or change the activity types. -### Variability in Results - -Due to the nature of AI generation, the exact microflow logic produced can vary between separate runs, even with identical input. It is recommended to review the generated output carefully. - -### Layout and Positioning - -While Maia aims to create functional logic, the visual layout and positioning of elements within the generated microflow may not always be optimally organized. You may need to adjust the arrangement of activities for better readability and structure. - ## Read More * [Microflows](/refguide/microflows/) diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-pages.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-pages.md index bfb859a60bf..6f27b933f37 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-pages.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-pages.md @@ -52,34 +52,6 @@ On pages that have already been created, either by Maia for Pages or manually, y In this dedicated chat, only requests related to Pages 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 page by describing its main use cases, customer needs, or other relevant details. The more Maia knows about your page, the more tailored and accurate the generated page will be. - -Below are examples of prompts you can use as a starting point: - -* The page will be used to ... -* I need a page to be able to edit my entity ... -* Create a page based on the image. -* Base the page on the image, but change ... to ... - -Below are examples of prompts you can use to ask Maia to make further edits or request suggestions for improving a page: - -* Can you add a button called `BUTTON_NAME` to the page? -* I want an area on the page where users can ... -* Make the save button a primary button. -* Change the page header to use Heading 1. -* Remove the ... widget. -* Delete all widgets on the page. -* How can I make this page more user-friendly or visually appealing? -* Could you suggest ways to optimize the performance of this page? - -#### Best Practices for Image Input - -The image size is limited to 512 KB. Make sure to select a clear image to help Maia better understand your request. For example, you can provide a screenshot, a photo, a design mock-up, or a close-up picture of a drawing. Avoid heavily compressed or low quality images, as these may result in the loss of important details. - -Keep in mind that Maia analyzes only the structure of the image. The theming of your app, such as the color scheme, will not be changed. This can cause some differences between the provided image and the generated page. - ### Limitation {#limitation} Maia for Pages does not support all widgets. diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-workflows.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-workflows.md index 33f429c09fa..76c7ab306d2 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-workflows.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-workflows.md @@ -38,35 +38,8 @@ After clicking **Maia for Workflow**, a chat interface appears at the right side {{< 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} - -To achieve optimal results, provide context about your workflow by describing its main use cases, customer needs, or other relevant details. The more Maia knows about your workflow, the more tailored and accurate the generated workflow will be. - -Below are some examples of prompts you can use as a starting point: - -* Please generate a workflow for a process that... -* Create a workflow based on the image. -* Base the workflow on the image, but change ... to ... - -Maia for Workflows can analyze a BPMN image representing employee onboarding, rework it using Mendix Workflows terminology, and generate the corresponding activities for you. Alongside the image, you can also use text input to specify how the generated workflow should differ from the provided image. For example, you might write: *Generate a workflow based on this BPMN image, but make sure it waits before sending an email to the new employee.* - -Make sure to select a clear image to help Maia better understand your request. For example, you can provide a screenshot, a photo, BPMN schema, or a close-up picture of a drawing. Avoid heavily compressed or low quality images, as these may result in the loss of important details. - -Below are some examples of prompts you can use to ask Maia for further explanations or suggestions to improve the generated workflow: - -* Can you explain this workflow to me? -* Can you give me suggestions to improve this workflow? -* Can you make the timer wait for 5 days? -* I want the process to run in parallel. - -{{% alert type="info" %}} -Workflow generation may take longer than other Maia features. Performance improvements are planned for a future release. -{{% /alert %}} - ## Limitations {#limitation} -Maia for Workflows currently has some limitations. - ### Not All Properties Can Be Configured Due to the complex cross-document nature of a workflow, not all properties of the workflow elements can be generated yet. The following properties cannot be configured yet: