Skip to content

Commit 7416182

Browse files
committed
Technical reference
1 parent 0243f3c commit 7416182

1 file changed

Lines changed: 24 additions & 1 deletion

File tree

content/en/docs/appstore/use-content/platform-supported-content/modules/genai/Mx GenAI Connector.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ For more inspiration or guidance on how to use the above-mentioned microflows in
111111
#### Chat Completions (without History)
112112

113113
The microflow activity `Chat Completions (without history)` supports scenarios where there is no need to send a list of (historic) messages comprising the conversation so far as part of the request. The operation requires a specialized [Connection](/appstore/modules/genai/commons/#connection) of type SynthiaConnection and a `UserPrompt` as a string. Additional parameters, such as system prompt, can be passed via the optional [Request](/appstore/modules/genai/commons/#request) object.
114-
Functionally, the prompt strings can be written in a specific way and can be tailored to get the desired result and behavior. For more information on prompt engineering, see the [Read More]({#readmore}) section.
114+
Functionally, the prompt strings can be written in a specific way and can be tailored to get the desired result and behavior. For more information on prompt engineering, see the [Read More](#readmore) section.
115115

116116
Optionally, you can also use [Function Calling](#function-calling) by adding a [ToolCollection](/appstore/modules/genai/commons/#toolcollection) to the request or you can send [images](#vision) or [documents](#document-chat) along with the user prompt by passing a [FileCollection](/appstore/modules/genai/commons/#filecollection).
117117

@@ -243,3 +243,26 @@ The microflow activity `Embeddings (String)` supports scenarios where the vector
243243
The microflow activity `Embeddings (ChunkCollection)` supports the more complex scenario where a collection of [Chunk](/appstore/modules/genai/commons/#chunkcollection) objects is vectorized in a single API call, such as when converting a collection of text strings (chunks) from a private knowledge base into embeddings. Instead of calling the API for each string, executing a single call for a list of strings can significantly reduce HTTP overhead. The embedding vectors returned after a successful API call will be stored as an `EmbeddingVector` attribute in the same `Chunk` object. Use the exposed microflows of GenAI Commons [Chunks: Initialize ChunkCollection](/appstore/modules/genai/commons/#chunkcollection-create), [Chunks: Add Chunk to ChunkCollection](/appstore/modules/genai/commons/#chunkcollection-add-chunk), or [Chunks: Add KnowledgeBaseChunk to ChunkCollection](/appstore/modules/genai/commons/#chunkcollection-add-knowledgebasechunk) to construct the input.
244244

245245
To create embeddings, it does not matter whether the ChunkCollection contains Chunks or its specialization KnowledgeBaseChunks. Note that the knowledge base operations handle the embedding generation themselves internally.
246+
247+
## Technical Reference
248+
249+
The module includes technical reference documentation for the available entities, enumerations, activities, and other items you can use in your application. You can view the information about each object in context by using the **Documentation** pane in Studio Pro.
250+
251+
The **Documentation** pane displays the documentation for the currently selected element. To view it, perform the following steps:
252+
253+
1. In the [View menu](/refguide/view-menu/) of Studio Pro, select **Documentation**.
254+
2. Click the element for which you want to view the documentation.
255+
256+
{{< figure src="/attachments/appstore/platform-supported-content/modules/technical-reference/doc-pane.png" >}}
257+
258+
## Implementing GenAI with the Showcase App
259+
260+
For more inspiration or guidance on how to use microflows in your logic, Mendix recommends downloading the [GenAI Showcase App](https://marketplace.mendix.com/link/component/220475), which demonstrates a variety of example use cases and applies almost all of the Mendix Cloud GenAI operations. The starter apps in the [Mendix Components](/appstore/modules/genai/#mendix-components) list can also be used as inspiration or simply adapted for a specific use case.
261+
262+
## Read More{#readmore}
263+
264+
For Anthropic Claude-specific documentation, refer to:
265+
266+
* [Prompt Engineering Guide](https://docs.anthropic.com/en/docs/build-with-claude/prompt-engineering/overview)
267+
* [Tool Use / Function Calling](https://docs.anthropic.com/en/docs/build-with-claude/tool-use)
268+
* [Vision / Chat with Images](https://docs.anthropic.com/en/docs/build-with-claude/vision)

0 commit comments

Comments
 (0)