Skip to content

Commit 36e8449

Browse files
Merge pull request mendix#3 from EmilyvonBergen/patch-4
SAS-896 addition of the MxCloud GenAI in documentation
2 parents 1cbad00 + 279adc5 commit 36e8449

1 file changed

Lines changed: 37 additions & 10 deletions

File tree

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

Lines changed: 37 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,20 @@ To start building your smart app with a blank GenAI App template, download the [
3838

3939
### Important Modules
4040

41-
The [Blank GenAI App Template](https://marketplace.mendix.com/link/component/227934) includes two essential pre-installed modules, which are beneficial to familiarize yourself with:
41+
The [Blank GenAI App Template](https://marketplace.mendix.com/link/component/227934) includes an essential pre-installed bundle called the [Mendix Cloud GenAI Resources Packs](https://marketplace.mendix.com/link/component/229305), which are beneficial to familiarize yourself with, as it includes:
4242

43-
* The [**GenAI Commons**](https://marketplace.mendix.com/link/component/227933) module: provides pre-built operations and data structures for seamless integration with platform-supported GenAI connectors, such as OpenAI or Amazon Bedrock.
43+
* The [GenAI Commons](/appstore/modules/genai/commons/) module: provides pre-built operations and data structures for seamless integration with platform-supported GenAI connectors, such as the Mendix Cloud GenAI, OpenAI or Amazon Bedrock.
4444

45-
* The [**Conversational UI**](https://marketplace.mendix.com/link/component/227931) module: offers UI elements for chat interfaces and usage data monitoring.
45+
* The [Conversational UI](/appstore/modules/genai/conversational-ui/) module: offers UI elements for chat interfaces and usage data monitoring.
46+
47+
* The [Mendix Cloud GenAI Resources Packs](/appstore/modules/genai/MxGenAI/) connector: supporting the usage of LLMs in your applications.
4648

4749
### Choosing the Infrastructure
4850

4951
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:
5052

53+
* [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.
54+
5155
* [OpenAI](/appstore/modules/genai/openai/): The [OpenAI Connector](https://marketplace.mendix.com/link/component/220472?_gl=1*1gbywo4*_gcl_au*NjUwMzI0NzA0LjE3MzI2MjkxMTI.) supports both OpenAI’s platform and Azure’s OpenAI service.
5256

5357
{{% alert color="info" %}}
@@ -116,6 +120,20 @@ You may encounter an error about allowed roles. To resolve this, go to the page
116120

117121
### Infrastructure Configuration
118122

123+
#### Mendix Cloud GenAI Configuration
124+
125+
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:
126+
127+
1. Run the application locally.
128+
129+
2. Configure the Mendix Cloud GenAI Settings:
130+
* In the chatbot-like application interface, go to **Administration** icon, and find the **Mendix Cloud GenAI Configuration**.
131+
* Select **Import key** and paste the key from the Mendix Portal given to you.
132+
133+
3. Test the Configuration:
134+
* Find the configuration you created, and select **Test Key** on the right side of the row.
135+
* If an error occurs, check the **Mendix Console** for more details on resolving the issue.
136+
119137
#### OpenAI Configuration
120138

121139
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*.
@@ -124,21 +142,30 @@ Follow the steps below to configure OpenAI for your application. For more inform
124142

125143
2. Configure OpenAI Settings:
126144

127-
* In the chatbot-like application interface, go to the **Settings** ({{% icon name="cog" %}}) icon, and find the **OpenAI Configuration**.
145+
* In the chatbot-like application interface, go to the **Administration** ({{% icon name="cog" %}}) icon, and find the **OpenAI Configuration**.
128146
* Click **New** and provide the following details:
129147
* **Display Name**: A reference name to identify this configuration (for example, "My OpenAI Configuration").
130148
* **API Type**: Choose between **OpenAI** or **Azure OpenAI**.
131149
* **Endpoint**: Enter the endpoint URL for your selected API type.
132-
* **Token**: Provide the API key for authentication.
133-
* If using Azure OpenAI, add:
134-
* **Deployment Name**: Specify the deployed model (for example, *gpt-4o*, *gpt-3.5-turbo*, etc.)
135-
* **API Version**: Provide the version of the API you are using (for example, *2024-06-01*, *2024-10-21*, etc.)
150+
* **API key**: Provide the API key for authentication.
151+
* If using Azure OpenAI, add the **Azure key type** by choosing between **OpenAI** or **Azure OpenAI**.
152+
153+
* 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):
154+
* **Display name**: A reference name for the deployed model (e.g., "GPT-4 Conversational").
155+
* **Deployment Name**: Specify the deployed model (for example, *gpt-4o*, *gpt-3.5-turbo*, etc.)
156+
* **Output modality**: Indicate the type of output (e.g., Text, Embeddings, Image).
157+
* **Support system prompt**: Indicate whether the model supports system prompts.
158+
* **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.
159+
* **Support function calling**: Indicate whether the model can invoke different functions during the conversation based on the user input.
160+
* **Azure API Version**: Provide the version of the API you are using (for example, *2024-06-01*, *2024-10-21*, etc.)
161+
* **Is active**: Indicate whether the deployment model should be active to be used in the app.
136162

137163
* Click **Save** to store your configuration.
138164

139165
3. Test the Configuration:
140166

141-
* Select the configuration you created, and click **Test Configuration**.
167+
* Find the configuration you created, click the three dots on the right side, and select **Test**.
168+
* In the **Test configuration**, select the deployed model and press **Test**.
142169
* If an error occurs, check the **Mendix Console** for more details on resolving the issue.
143170

144171
#### Bedrock Configuration
@@ -171,7 +198,7 @@ If you encounter any issues while using the Amazon Bedrock connector, see the [T
171198

172199
## Testing and Troubleshooting
173200

174-
Before testing your app, complete the OpenAI or Bedrock configuration.
201+
Before testing your app, complete the Mendix Cloud GenAI, OpenAI or Bedrock configuration.
175202

176203
To test the Chatbot, navigate to the **Home** icon to open the chatbot interface. Start interacting with your chatbot by typing in the chat box.
177204

0 commit comments

Comments
 (0)