Skip to content

Commit 2ef0b65

Browse files
SAS-896 addition of the MxCloud GenAI in documentation
1 parent 1665749 commit 2ef0b65

1 file changed

Lines changed: 32 additions & 7 deletions

File tree

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

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ The [Blank GenAI App Template](https://marketplace.mendix.com/link/component/227
4848

4949
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:
5050

51+
* [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.
52+
5153
* [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.
5254

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

117119
### Infrastructure Configuration
118120

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

121137
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 +140,30 @@ Follow the steps below to configure OpenAI for your application. For more inform
124140

125141
2. Configure OpenAI Settings:
126142

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

137161
* Click **Save** to store your configuration.
138162

139163
3. Test the Configuration:
140164

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

144169
#### Bedrock Configuration
@@ -171,7 +196,7 @@ If you encounter any issues while using the Amazon Bedrock connector, see the [T
171196

172197
## Testing and Troubleshooting
173198

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

176201
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.
177202

0 commit comments

Comments
 (0)