Skip to content

Commit d4d6bdc

Browse files
committed
Proofreading
1 parent 951c263 commit d4d6bdc

4 files changed

Lines changed: 13 additions & 13 deletions

File tree

content/en/docs/marketplace/genai/concepts/agents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Read more about [Agent Commons](/appstore/modules/genai/genai-for-mx/agent-commo
6767

6868
### GenAI Showcase App
6969

70-
Check out example implementations of the previously mentioned patterns and multi-agent systems in the [GenAI Showcase Application](https://marketplace.mendix.com/link/component/220475).
70+
Check out example implementations of the previously mentioned patterns and multi-agent systems in the [GenAI Showcase App](https://marketplace.mendix.com/link/component/220475).
7171

7272
### Additional Information
7373

content/en/docs/marketplace/genai/how-to/create-single-agent.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Before you can start creating your first agent, you need to setup your applicati
6868

6969
## Create the Agent's Functional Prerequisites
7070

71-
Now that the basics of the app are set up, you can start implementing the agent. The agent should interact with data from both a knowledge base and the Mendix app. In order to make this work form a user interface, we need to set up a number of functional prerequisites:
71+
Now that the basics of the app are set up, you can start implementing the agent. The agent should interact with data from both a knowledge base and the Mendix app. In order to make this work from a user interface, we need to set up a number of functional prerequisites:
7272

7373
* Populate a knowledge base.
7474
* Create a simple user interface which allows the user to trigger the agent from a button.
@@ -106,7 +106,7 @@ Mendix ticket data needs to be ingested into the knowledge base. You can find a
106106
* Edit the first retrieve action to retrieve objects from your new entity `Ticket`.
107107
* In the loop, delete the second action that adds metadata to the `MetadataCollection`.
108108
* In the last action of the loop `Chunks: Add KnowledgeBaseChunk to ChunkCollection` keep the **Human readable ID** field empty.
109-
* Near the end of the microflow, edit the `DeployedKnowledgeBase` retrieve action to change the XPath constraint for name from *example* to `HistoricalTickets`
109+
* Near the end of the microflow, edit the `DeployedKnowledgeBase` retrieve action to change the XPath constraint for name from *example* to `HistoricalTickets`.
110110

111111
7. Finally, create a microflow `ACT_CreateDemoData_IngestIntoKnowledgeBase` that first calls the `Tickets_CreateDataset` microflow, followed by the `ACT_TicketList_LoadAllIntoKnowledgeBase` microflow. Add this `ACT_CreateDemoData_IngestIntoKnowledgeBase` new microflow to your navigation or homepage and ensure that it is accessible to admins (add the admin role under **Allowed Roles** in the microflow properties).
112112

@@ -142,7 +142,7 @@ First, create a user interface to test and use the agent properly.
142142

143143
You have now successfully added a page that allows users to ask questions to an agent. You can verify this in the running app by opening the page and entering text into the **User input** field. However, the button does not do anything yet. You will add logic to the microflow behind the button following the steps in the [Generate a Response](#generate-response) section.
144144

145-
### Create the function microflows
145+
### Create the Function Microflows
146146

147147
We will add two microflows that the agent can leverage to use live app data:
148148

@@ -196,7 +196,7 @@ You have now successfully created your first function microflow that you will li
196196
197197
* Mapping: `EM_Ticket`
198198
* Parameter: `TicketList` (retrieved in previous action)
199-
* Store in: ``String Variable` called `JSON_Ticket`
199+
* Store in: `String Variable` called `JSON_Ticket`
200200
201201
4. Right-click the action and click `Set $JSON_Ticket as return value`.
202202
@@ -208,7 +208,7 @@ The main approach to set up the agent and build logic to generate responses is b
208208
209209
### Set up the Agent with a Prompt
210210
211-
Create a an agent that can be called to interact with the LLM. The [Agent Commons](/appstore/modules/genai/genai-for-mx/agent-commons/) module allows agentic AI engineers to define agents and perform prompt engineering at runtime.
211+
Create an agent that can be called to interact with the LLM. The [Agent Commons](/appstore/modules/genai/genai-for-mx/agent-commons/) module allows agentic AI engineers to define agents and perform prompt engineering at runtime.
212212
213213
1. Run the app.
214214
@@ -243,7 +243,7 @@ Create a an agent that can be called to interact with the LLM. The [Agent Common
243243
244244
8. Add a value in the **UserInput** variable field on the right of the page, under **Test Case**. That way, you can test the current prompt behavior by calling the agent. For example, type `How can I implement an agent in my Mendix app?` and click **Run**. You may need to scroll down to see the **Output** on the page after a few seconds. Ideally, the model does not attempt to answer requests that fall outside its scope, as it is restricted to handling IT-related issues and providing information about ticket data. However, if you ask a question that would require tools that are not yet implemented, the model might hallucinate and generate a response as if it had used those tools.
245245
246-
9. Make sure the app is running with the latest [domain model changes from the previous section](#domain-model-setup). In the Agent Commons UI, you will see a field for the [Context Entity](/appstore/modules/genai/genai-for-mx/agent-commons/#define-context-entity). Search for **TicketHelper**, and select the entity that was created in one of the previous steps. When starting from the Blank GenAI App, this should be **MyFirstModule.TicketHelper**.
246+
9. Make sure the app is running with the latest [domain model changes](#domain-model-setup) from the previous section. In the Agent Commons UI, you will see a field for the [Context Entity](/appstore/modules/genai/genai-for-mx/agent-commons/#define-context-entity). Search for **TicketHelper**, and select the entity that was created in one of the previous steps. When starting from the Blank GenAI App, this should be **MyFirstModule.TicketHelper**.
247247
248248
10. Save the agent version using the **Save As** button, and enter *Initial agent with prompt* as the title.
249249
@@ -270,7 +270,7 @@ You will now use the function microflows that were created in earlier steps. In
270270
2. In the second half of the page, under **Tools**, add a new tool:
271271
272272
* Name: `RetrieveNumberOfTicketsInStatus` (expression)
273-
* Description: `Get number of tickets in a certain status. Only the following values for status are available: [''Open'', ''In Progress'', ''Closed'']` (expression)
273+
* Description: `Get number of tickets in a certain status. Only the following values for status are available: ['Open', 'In Progress', 'Closed']` (expression)
274274
* Enabled: *yes* (default)
275275
* Tool action microflow: select the module in which the function microflows reside, then select the microflow called `Ticket_GetNumberOfTicketsInStatus`. When starting from the Blank GenAI App, this module should be **MyFirstModule**
276276
@@ -383,7 +383,7 @@ Create an agent that can be sent to the LLM. The [Agent Commons](/appstore/modul
383383
384384
7. Add a value in the **UserInput** variable field to test the current agent. For example, type `How can I implement an agent in my Mendix app?`. Ideally, the model will not attempt to answer requests that fall outside its scope, as it is restricted to handling IT-related issues and providing information about ticket data. However, if you ask a question that would require tools that are not yet implemented, the model might hallucinate and generate a response as if it had used those tools.
385385
386-
8. Make sure the app is running with the latest [domain model changes from the previous section](#domain-model-setup). In the Agent Commons UI, you will see a field for the [Context Entity](/appstore/modules/genai/genai-for-mx/agent-commons/#define-context-entity). Search for **TicketHelper** and select the entity that was created in one of the previous steps. When starting from the Blank GenAI App, this should be **MyFirstModule.TicketHelper**.
386+
8. Make sure the app is running with the latest [domain model changes](#domain-model-setup) from the previous section. In the Agent Commons UI, you will see a field for the [Context Entity](/appstore/modules/genai/genai-for-mx/agent-commons/#define-context-entity). Search for **TicketHelper** and select the entity that was created in one of the previous steps. When starting from the Blank GenAI App, this should be **MyFirstModule.TicketHelper**.
387387
388388
9. Save the agent version using the **Save As** button and enter *Initial agent* as the title.
389389

content/en/docs/marketplace/genai/how-to/prompt_engineering-runtime.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Agent Commons enables users to create powerful agents at runtime, enriching requ
4848
2. Go to **Navigation**, and add a new **Agents** item.
4949

5050
1. Select a suitable icon, such as `notes-paper-text`, from the Atlas icon set.
51-
2. Set the **On Click** action to *Show Page*.
51+
2. Set the `On Click` action to `Show Page`.
5252
3. Search and select the `Agent_Overview` page, located under **AgentCommons** > **USE_ME** > **Agent Builder** folder. Alternatively, you can add a button to a page and connect to the same page.
5353

5454
3. If you have not started from a GenAI Starter App, you also need to add a navigation item that opens the `Configuration_Overview` page of the **MxGenAIConnector**. For more details, see [Configuration](/appstore/modules/genai/mx-cloud-genai/MxGenAI-connector/#configuration).
@@ -117,7 +117,7 @@ Enter `Chair 30 words` as the title for the test case.
117117
5. Now that you have saved at least two test cases, open a dropdown next to the **Run** button, and click **Run All**.
118118
This will execute both test cases, allowing you to compare the different input values. Note that the **Language** variable was not set in the first test case, as it did not exist at the time. As a result, the model's response may be in English or another random language.
119119

120-
5. Once you are satisfied with your agent, you can now save the version one more time with the title `Added system prompt and language`.
120+
6. Once you are satisfied with your agent, you can now save the version one more time with the title `Added system prompt and language`.
121121

122122
You have now successfully created your first agent. A few additional configurations are still required, which will be covered later in this document.
123123

@@ -243,7 +243,7 @@ When you want to run your agent from the Agent Commons page, you need to select
243243

244244
### Context Entity Issues {#context-entity-issues}
245245

246-
When you select the `Context entity` in the UI, but cannot find the one you are are looking for, you might need to restart your application after the entity was added to your domain model.
246+
When you select the `Context entity` in the UI, but cannot find the one you are looking for, you might need to restart your application after the entity was added to your domain model.
247247

248248
If the attributes do not match the variables, a warning is displayed in the UI or the Console of your running app. This might happen if you have used inconsistent names for the `{{variables}}` inside of your prompts compared to the attribute names. Double check if they are exactly the same, with no whitespace or other characters.
249249

content/en/docs/marketplace/genai/reference-guide/conversational-ui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ With the [Conversational UI](https://marketplace.mendix.com/link/component/23945
1616
Mendix has produced a [Conversational AI Design Checklist](/howto/front-end/conversation-checklist/) with some best practices for introducing conversational AI into your app.
1717

1818
{{% alert color="info" %}}
19-
Prompt Management used to be a capability of the Conversational UI module. Since version 4.0.0, it is no longer part of the module, and has been moved to the [Agent Commons](/appstore/modules/genai/genai-for-mx/agent-commons/) module. Existing prompts can be exported from the prompt management overview page and imported into the Agent Builder interface.
19+
Prompt Management used to be a capability of the Conversational UI module. Since version 4.0.0, it is no longer part of the module, and has been moved to the [Agent Commons](/appstore/modules/genai/genai-for-mx/agent-commons/) module. Existing prompts can be exported from the Prompt Management overview page and imported into the Agent Builder interface.
2020
{{% /alert %}}
2121

2222
### Typical Use Cases {#use-cases}

0 commit comments

Comments
 (0)