Skip to content

Commit 285a8cd

Browse files
Merge pull request #2 from EmilyvonBergen/patch-3
SAS-896 Addition of MxCloud GenAI in how-to
2 parents 36e8449 + 191401d commit 285a8cd

1 file changed

Lines changed: 35 additions & 11 deletions

File tree

content/en/docs/appstore/use-content/platform-supported-content/modules/genai/using_genai/start_from_a_starter_app.md

Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ To simplify your first use case, start building a chatbot using the [AI Bot Star
4040

4141
Selecting the infrastructure for integrating GenAI into your Mendix application is the first step. Depending on your use case and preferences, you can choose from the following options:
4242

43+
* [Mendix Cloud GenAI Resources Packs](/appstore/modules/genai/MxGenAI/): Part of the [Mendix Cloud GenAI Resources Packs](https://marketplace.mendix.com/link/component/229305), integrates LLMs by dragging and dropping common operations from its toolbox in Studio Pro.
44+
4345
* [OpenAI](/appstore/modules/genai/openai/): The [OpenAI Connector](https://marketplace.mendix.com/link/component/220472?_gl=1*1gbywo4*_gcl_au*NjUwMzI0NzA0LjE3MzI2MjkxMTI.) supports OpenAI’s platform and Azure’s OpenAI service.
4446

4547
{{% alert color="info" %}}
@@ -54,6 +56,20 @@ To start, you can sign up for a free trial with OpenAI and receive credits valid
5456

5557
Download the [AI Bot Starter App](https://marketplace.mendix.com/link/component/227926) from the Marketplace and configure the **encryption key** in the **App Settings**. Follow the steps below based on the infrastructure you chose.
5658

59+
#### Mendix Cloud GenAI Configuration
60+
61+
Follow these steps to configure the Mendix Cloud GenAI Resources Packs for your application and for more background information, look at the [Mendix Cloud GenAI Configuration]() documentation:
62+
63+
1. Run the application locally.
64+
65+
2. Configure the Mendix Cloud GenAI Settings:
66+
* In the chatbot-like application interface, go to **Administration** icon, and find the **Mendix Cloud GenAI Configuration**.
67+
* Select **Import key** and paste the key from the Mendix Portal given to you.
68+
69+
3. Test the Configuration:
70+
* Find the configuration you created, and select **Test Key** on the right side of the row.
71+
* If an error occurs, check the **Mendix Console** for more details on resolving the issue.
72+
5773
#### OpenAI Configuration
5874

5975
Follow the steps below to configure OpenAI for your application. For more information, see the [Configuration](/appstore/modules/genai/openai/#configuration) section of the *OpenAI*.
@@ -62,21 +78,30 @@ Follow the steps below to configure OpenAI for your application. For more inform
6278

6379
2. Configure OpenAI Settings:
6480

65-
* In the chatbot-like application interface, go to the **Settings** ({{% icon name="cog" %}}) icon, and find the **OpenAI Configuration**.
81+
* In the chatbot-like application interface, go to the **Administration** ({{% icon name="cog" %}}) icon, and find the **OpenAI Configuration**.
6682
* Click **New** and provide the following details:
6783
* **Display Name**: A reference name to identify this configuration (for example, "My OpenAI Configuration").
6884
* **API Type**: Choose between **OpenAI** or **Azure OpenAI**.
6985
* **Endpoint**: Enter the endpoint URL for your selected API type.
70-
* **Token**: Provide the API key for authentication.
71-
* If using Azure OpenAI, add:
72-
* **Deployment Name**: Specify the deployed model (for example, *gpt-4o*, *gpt-3.5-turbo*, etc.)
73-
* **API Version**: Provide the version of the API you are using (for example, *2024-06-01*, *2024-10-21*, etc.)
86+
* **API key**: Provide the API key for authentication.
87+
* If using Azure OpenAI, add the **Azure key type** by choosing between **OpenAI** or **Azure OpenAI**.
88+
89+
* After saving the changes, a new pop-up will appear to add the deployment models. Select **Add deployed model** and provide the following details (optional for the OpenAI API Type):
90+
* **Display name**: A reference name for the deployed model (e.g., "GPT-4 Conversational").
91+
* **Deployment Name**: Specify the deployed model (for example, *gpt-4o*, *gpt-3.5-turbo*, etc.)
92+
* **Output modality**: Indicate the type of output (e.g., Text, Embeddings, Image).
93+
* **Support system prompt**: Indicate whether the model supports system prompts.
94+
* **Support conversations with history**: Indicate whether the model can remember and utilize previous interactions in a conversation by referring back to earlier messages in the chat.
95+
* **Support function calling**: Indicate whether the model can invoke different functions during the conversation based on the user input.
96+
* **Azure API Version**: Provide the version of the API you are using (for example, *2024-06-01*, *2024-10-21*, etc.)
97+
* **Is active**: Indicate whether the deployment model should be active to be used in the app.
7498

7599
* Click **Save** to store your configuration.
76100

77101
3. Test the Configuration:
78102

79-
* Select the configuration you created, and click **Test Configuration**.
103+
* Find the configuration you created, click the three dots on the right side, and select **Test**.
104+
* In the **Test configuration**, select the deployed model and press **Test**.
80105
* If an error occurs, check the **Mendix Console** for more details on resolving the issue.
81106

82107
#### Bedrock Configuration
@@ -105,16 +130,15 @@ Follow the steps below to configure Amazon Bedrock for your application:
105130

106131
### Bot Configuration
107132

108-
Before starting the bot configuration, ensure that the OpenAI or Bedrock configuration is complete.
133+
Before starting the bot configuration, ensure that the Mendix Cloud GenAI, OpenAI or Bedrock configuration is complete.
109134

110135
1. In the **Administration** menu, go to the **Bot Configuration**, and click **New**.
111136
2. Enter the following details:
112137

113-
* **Display Name**: A reference name for the bot configuration (for example, "Configuration Bot").
114-
* **Architecture**: Select **OpenAI** or **Bedrock** based on your choice.
138+
* **Display Name**: A reference name for the bot configuration (for example, "MxCloud GenAI Configuration Bot").
115139
* **Is Selectable in UI**: Enable this option to allow the end user to select this configuration.
116-
* **Configuration**: Select the OpenAI or Bedrock configuration you just created.
117-
* **Action Microflow**: Choose the provided microflow, `ChatContext_ChatWithHistory_ActionMicroflow`.
140+
* **Model**: Select the Mendix Cloud GenAI, OpenAI or Bedrock model you just created.
141+
* **Action Microflow**: Choose the provided microflow (e.g., `ChatContext_ChatWithHistory_ActionMicroflow`).
118142

119143
3. Save your changes, and optionally set it as the default bot configuration by selecting **Make Default** on the Bot Configuration page.
120144

0 commit comments

Comments
 (0)