You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/marketplace/genai/mendix-cloud-genai/_index.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,22 +9,22 @@ no_list: false
9
9
10
10
## Introduction
11
11
12
-
In order to help developers integrate GenAI capabilities into custom applications, Mendix Cloud provides GenAI Resource Packs. These packs offer access to Large Language Models (for text generation and text embeddings) and knowledge bases, enabling seamless implementation of common GenAI patterns in a low-code environment. They simplify the process of leveraging GenAI technologies for Mendix customers and partners by abstracting complex provisioning processes and reducing configuration to just a few clicks within the platform experience. Feel free to contact [genai-resource-packs@mendix.com](mailto:genai-resource-packs@mendix.com) to learn more.
12
+
Mendix Cloud provides GenAI Resource Packs to help developers integrate GenAI capabilities into custom applications. These packs offer access to large language models (for text generation and text embeddings) and knowledge bases, enabling seamless implementation of common GenAI patterns in a low-code environment. They simplify the process of leveraging GenAI technologies for Mendix customers and partners by abstracting complex provisioning processes and reducing configuration to just a few clicks. To learn more, contact [genai-resource-packs@mendix.com](mailto:genai-resource-packs@mendix.com).
13
13
14
14
## Resources Overview
15
15
16
-
There are three different types of resources:
16
+
There are three types of resources:
17
17
18
-
* Compute – Text Generation: generates human-like text based on given inputs, essential for applications requiring natural language generation.
18
+
* Compute – Text Generation: Generates human-like text based on given inputs, essential for applications requiring natural language generation.
19
19
20
-
* Knowledge Base: A knowledge base can be used to upload your data which then can be used by a text generation resource.
20
+
* Knowledge Base: Stores your data for use by a text generation resource.
21
21
22
-
* Compute – Embeddings Generation: converts text into vector representations. An embeddings resource is required to uploading data to your Knowledge Base.
22
+
* Compute – Embeddings Generation: Converts text into vector representations. An embeddings resource is required to upload data to your knowledge base.
23
23
24
-
## Getting started
24
+
## Getting Started
25
25
26
26
1. Learn about GenAI Resource Packs and how to acquire them in the [Mendix Cloud GenAI Resource Packs](/appstore/modules/genai/mx-cloud-genai/resource-packs/) document.
27
-
2. Once you have access to GenAI resources, log in to the [Mendix Cloud GenAI portal](https://genai.home.mendix.com/) to generate access keys for your resources. This portal provides an overview of all the resources you have access to and you can also request new GenAI Resources there. For more information, see [Navigate through the Mendix Cloud GenAI Portal](/appstore/modules/genai/mx-cloud-genai/Navigate-MxGenAI/).
28
-
3. Use a starter app containing the [Mendix Cloud GenAI Connector](https://marketplace.mendix.com/link/component/239449) (for example, the [BlankGenAI starter app](https://marketplace.mendix.com/link/component/227934)) or implement the connector in the Mendix application according to its documentation. Once you have imported access key in its configuration overview, you are connected to Mendix Cloud GenAI and can access available resources within your application.
27
+
2. Once you have access to GenAI resources, log in to the [Mendix Cloud GenAI portal](https://genai.home.mendix.com/) to generate access keys for your resources. This portal provides an overview of all resources you have access to and enables you to request new GenAI resources. For more information, see [Navigate through the Mendix Cloud GenAI Portal](/appstore/modules/genai/mx-cloud-genai/Navigate-MxGenAI/).
28
+
3. Use a starter app containing the [Mendix Cloud GenAI Connector](https://marketplace.mendix.com/link/component/239449) (for example, the [BlankGenAI starter app](https://marketplace.mendix.com/link/component/227934)) or implement the connector in your Mendix app. For more information on configuration and usage, see [Mendix Cloud GenAI Connector](/appstore/modules/genai/mx-cloud-genai/MxGenAI-connector/). Once you have imported an access key in the configuration overview, you are connected to Mendix Cloud GenAI and can access available resources within your application.
Copy file name to clipboardExpand all lines: content/en/docs/marketplace/genai/reference-guide/external-platforms/Mx GenAI Connector.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ aliases:
10
10
11
11
## Introduction
12
12
13
-
The [Mendix Cloud GenAI connector](https://marketplace.mendix.com/link/component/239449) lets you utilize[Mendix Cloud GenAI Resource Packs](/appstore/modules/genai/mx-cloud-genai/resource-packs/) directly within your Mendix application. It allows you to integrate generative AI by dragging and dropping common operations from its toolbox.
13
+
The [Mendix Cloud GenAI connector](https://marketplace.mendix.com/link/component/239449) lets you use[Mendix Cloud GenAI Resource Packs](/appstore/modules/genai/mx-cloud-genai/resource-packs/) directly within your Mendix application. It allows you to integrate generative AI by dragging and dropping common operations from its toolbox.
14
14
15
15
### Features
16
16
@@ -20,7 +20,7 @@ Typical use cases for generative AI are described in more detail in the [Typical
20
20
21
21
### Prerequisites
22
22
23
-
To use this connector, you need configuration keys to authenticate to the Mendix Cloud GenAI services. You can generate keys in the [Mendix Cloud GenAI Portal](https://genai.home.mendix.com) or ask someone with access to either generate them for you or add you to their team so you can generate keys yourself.
23
+
To use this connector, you need configuration keys to authenticate to the Mendix Cloud GenAI services. You can generate keys in the [Mendix Cloud GenAI Portal](https://genai.home.mendix.com) or ask someone with access to either generate them for you or add you to their team so that you can generate keys yourself.
24
24
25
25
{{% alert color="info" %}}
26
26
@@ -36,7 +36,7 @@ The Mendix Cloud GenAI Connector module generates embeddings internally when int
36
36
37
37
## Installation
38
38
39
-
Add the [dependencies](#dependencies) listed above from the Marketplace. To import this module into your app, follow the instructions in the [Use Marketplace Content](/appstore/use-content/).
39
+
Add the [dependencies](#dependencies) listed above from the Marketplace. To import this module into your app, follow the instructions in [Use Marketplace Content](/appstore/use-content/).
40
40
41
41
## Configuration {#configuration}
42
42
@@ -180,13 +180,13 @@ Using metadata, even more fine-grained filtering becomes feasible. Each ticket m
180
180
181
181
Instead of relying solely on similarity-based searches of ticket descriptions, users can then filter for specific tickets, such as 'Bug' tickets with the status set to 'Solved'. You can add [MetaData](/appstore/modules/genai/genai-for-mx/commons/#chunkcollection-add-knowledgebasechunk) with the respective key to each chunk during insertion.
182
182
183
-
#### How to get data into a knowledge base
183
+
#### How to Get Data Into a Knowledge Base
184
184
185
-
If you are looking for a step-by-step guide on how to get your application data into a collection inside of a Mendix Cloud Knowledge Base Resource, refer to [Grounding Your Large Language Model in Data – Mendix Cloud GenAI](/appstore/modules/genai/how-to/howto-groundllm/). Note that the Mendix Portal also provides options for importing data into your knowledge base, such as file uploads. For more information, see [Navigate through the Mendix Cloud GenAI Portal](/appstore/modules/genai/mx-cloud-genai/Navigate-MxGenAI/). This documentation focuses solely on adding data from inside a Mendix application and using the connector.
185
+
If you are looking for a step-by-step guide on how to get your application data into a collection inside a Mendix Cloud Knowledge Base Resource, refer to [Grounding Your Large Language Model in Data – Mendix Cloud GenAI](/appstore/modules/genai/how-to/howto-groundllm/). Note that the Mendix Portal also provides options for importing data into your knowledge base, such as file uploads. For more information, see [Navigate through the Mendix Cloud GenAI Portal](/appstore/modules/genai/mx-cloud-genai/Navigate-MxGenAI/). This documentation focuses solely on adding data from inside a Mendix application and using the connector.
186
186
187
187
### Knowledge Base Operations
188
188
189
-
To implement knowledge base logic into your Mendix application, you can use the actions in the **USE_ME** > **Knowledge Base** folder or under the **GenAI Knowledge Base (Content)** or **Mendix Cloud Knowledge Base** categories in the **Toolbox**. These actions require a specialized [DeployedKnowledgeBase](/appstore/modules/genai/genai-for-mx/commons/#deployed-knowledge-base) of type `Collection` that determines the model and endpoint to use. Additionally, the collection name must be passed when creating the object and it must be associated with a `Configuration` object. Please note that for Mendix Cloud GenAI a knowledge base resource may contain several collections (tables).
189
+
To implement knowledge base logic into your Mendix application, you can use the actions in the **USE_ME** > **Knowledge Base** folder or under the **GenAI Knowledge Base (Content)** or **Mendix Cloud Knowledge Base** categories in the **Toolbox**. These actions require a specialized [DeployedKnowledgeBase](/appstore/modules/genai/genai-for-mx/commons/#deployed-knowledge-base) of type `Collection` that determines the model and endpoint to use. Additionally, the collection name must be passed when creating the object, and it must be associated with a `Configuration` object. Note that for Mendix Cloud GenAI, a knowledge base resource may contain several collections (tables).
190
190
191
191
Dealing with knowledge bases involves two main stages:
192
192
@@ -209,7 +209,7 @@ To add data to the knowledge base, you need discrete pieces of information and c
209
209
210
210
Dividing data into chunks is crucial for model accuracy, as it helps optimize the relevance of the content. The best chunking strategy is to keep a balance between reducing noise by keeping chunks small and retaining enough content within a chunk to get relevant results. Creating overlapping chunks can help preserve more context while maintaining a fixed chunk size. It is recommended to experiment with different chunking strategies to decide the best strategy for your data. In general, if chunks are logical and meaningful to humans, they will also make sense to the model. A chunk size of approximately 1500 characters with overlapping chunks has been proven to be effective for longer texts in the past.
211
211
212
-
Since embeddings operations have a maximum character limit of 2048 characters per chunk, you must ensure that your chunks do not exceed this limit before submitting them for embedding. Chunks exceeding this limit will cause the embedding operation to fail, so validate your input data accordingly.
212
+
Because embeddings operations have a maximum character limit of 2048 characters per chunk, you must ensure that your chunks do not exceed this limit before submitting them for embedding. Chunks exceeding this limit will cause the embedding operation to fail, so validate your input data accordingly.
213
213
214
214
The chunk collection can then be stored in the knowledge base using one of the following operations:
215
215
@@ -218,28 +218,28 @@ The chunk collection can then be stored in the knowledge base using one of the f
218
218
Use the following toolbox actions inside the **Mendix Cloud Knowledge Base** toolbox category to populate knowledge data into a collection:
219
219
220
220
1.`Embed & Insert` embeds a list of chunks (passed via a [ChunkCollection](/appstore/modules/genai/genai-for-mx/commons/#chunkcollection)) and inserts them into the knowledge base.
221
-
2.`Embed & repopulate KB` is similar to the`Embed & Insert`, but deletes all existing chunks from the knowledge base before inserting the new chunks.
222
-
3.`Embed & Replace` replaces existing chunks in the knowledge base that match the associated Mendix object which was passed via [Add KnowledgeBaseChunk to ChunkCollection](/appstore/modules/genai/genai-for-mx/commons/#chunkcollection-add-knowledgebasechunk) action at the insertion stage.
221
+
2.`Embed & Repopulate KB` is similar to `Embed & Insert`, but deletes all existing chunks from the knowledge base before inserting the new chunks.
222
+
3.`Embed & Replace` replaces existing chunks in the knowledge base that match the associated Mendix object that was passed via the[Add KnowledgeBaseChunk to ChunkCollection](/appstore/modules/genai/genai-for-mx/commons/#chunkcollection-add-knowledgebasechunk) action at the insertion stage.
223
223
224
224
Additionally, use the following toolbox actions to delete chunks:
225
225
226
226
*`Delete for Object` deletes all chunks (and related metadata) from the collection that was associated with a passed Mendix object at the insertion stage.
227
-
*`Delete for List` is similar to the `Delete for Object`, but a list of Mendix objects is passed instead.
227
+
*`Delete for List` is similar to `Delete for Object`, but a list of Mendix objects is passed instead.
228
228
229
-
When data in your Mendix app that is relevant to the knowledge base changes, it is usually necessary to keep the knowledge base chunks in sync. Whenever a Mendix Object changes, the affected chunks must be updated. Depending on your use case, the `Embed & Replace` and `Delete for Objects` can be conveniently used in event handler microflows.
229
+
When data in your Mendix app that is relevant to the knowledge base changes, it is usually necessary to keep the knowledge base chunks in sync. Whenever a Mendix object changes, the affected chunks must be updated. Depending on your use case, `Embed & Replace` and `Delete for Objects` can be used in event handler microflows.
230
230
231
231
##### Knowledge Base Retrieval{#knowledge-base-retrieval}
232
232
233
233
The following toolbox actions can be used to retrieve knowledge data from a collection (and associate it with your Mendix data):
234
234
235
235
1.`Retrieve` retrieves knowledge base chunks from the knowledge base. You can use pagination via the `Offset` and `MaxNumberOfResults` parameters or apply filtering via a `MetadataCollection` or `MxObject`.
236
-
2.`Retrieve & Associate` is similar to the `Retrieve` but associates the returned chunks with a Mendix object if they were linked at the insertion stage.
236
+
2.`Retrieve & Associate` is similar to `Retrieve` but associates the returned chunks with a Mendix object if they were linked at the insertion stage.
237
237
238
238
{{% alert color="info" %}}You must define your entity specialized from `KnowledgeBaseChunk`, which is associated with the entity that was used to pass a MendixObject during the [insertion stage](#knowledge-base-insertion).
239
239
{{% /alert %}}
240
240
241
241
3.`Embed & Retrieve Nearest Neighbors` retrieves a list of type [KnowledgeBaseChunk](/appstore/modules/genai/genai-for-mx/commons/#knowledgebasechunk-entity) from the knowledge base that are most similar to a given `Content` by calculating the cosine similarity of its vectors.
242
-
4.`Embed & Retrieve Nearest Neighbors & Associate` combines the above actions `Retrieve & Associate` and `Embed & Retrieve Nearest Neighbors`.
242
+
4.`Embed & Retrieve Nearest Neighbors & Associate` combines the above actions,`Retrieve & Associate` and `Embed & Retrieve Nearest Neighbors`.
243
243
244
244
### Embedding Operations
245
245
@@ -333,7 +333,7 @@ To do this, follow the steps below:
333
333
334
334
### Attribute or Reference Required Error Message After Upgrade
335
335
336
-
If you encounter an error stating that an attribute or a reference is required after an upgrade, first upgrade all modules by right-clicking the error, then upgrade Data Widgets.
336
+
If you encounter an error stating that an attribute or reference is required after an upgrade, first upgrade all modules by right-clicking the error, then upgrade Data Widgets.
The Mendix platform provides seamless integration with various external platforms through specialized connectors. These connectors enable you to extend the functionality of your applications by leveraging external services and data sources. This section introduces the connectors available for [Snowflake Cortex](/appstore/modules/genai/snowflake-cortex/), [OpenAI](/appstore/modules/genai/openai/), [Amazon Bedrock](/appstore/modules/genai/bedrock/), and [PGVector Knowledge Base](/appstore/modules/genai/pgvector/), providing a high-level overview of their capabilities.
13
+
The Mendix platform provides seamless integration with various platforms through specialized connectors. These connectors enable you to extend the functionality of your applications by leveraging external services and data sources.
14
+
15
+
This section contains documentation for GenAI connectors, including the [Mendix Cloud GenAI Connector](/appstore/modules/genai/mx-cloud-genai/MxGenAI-connector/) and connectors to external platforms such as Amazon Bedrock and OpenAI.
0 commit comments