Skip to content

Commit fd9ddb8

Browse files
Merge pull request mendix#9216 from liamsommer-mx/document_file_change
Reflecting recent changes to the Mendix modules
2 parents af3f92d + 1a0c55e commit fd9ddb8

3 files changed

Lines changed: 4 additions & 3 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ Function calling enables LLMs to connect with external tools to gather informati
133133

134134
The model does not call the function but rather returns a tool called JSON structure that is used to build the input of the function (or functions) so that they can be executed as part of the chat completions operation. Functions in Mendix are essentially microflows that can be registered within the request to the LLM​. The connector takes care of handling the tool call response and executing the function microflows until the API returns the assistant's final response.
135135

136-
Function microflows take a single input parameter of type string or no input parameter and must return a string. Currently, adding a [ToolChoice](/appstore/modules/genai/genai-for-mx/commons/#set-toolchoice) for function calling is not supported by the Mendix Cloud GenAI Connector.
136+
Function microflows take a single input parameter of type string and optionally a Request and/or Tool object or no input parameter at all and return a string. Currently, adding a [ToolChoice](/appstore/modules/genai/genai-for-mx/commons/#set-toolchoice) for function calling is not supported by the Mendix Cloud GenAI Connector.
137137

138138
{{% alert color="warning" %}}
139139
Function calling is a highly effective capability and should be used with caution. Function microflows run in the context of the current user, without enforcing entity access. You can use `$currentUser` in XPath queries to ensure that you retrieve and return only information that the end-user is allowed to view; otherwise, confidential information may become visible to the current end-user in the assistant's response.

content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/external-platforms/openai.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ A [Deployed Model](/appstore/modules/genai/genai-for-mx/commons/#deployed-model)
155155
| Display name | This is the reference to the model for app users in case they have to select which one is to be used. |
156156
| Deployment name / Model name | This is the technical reference for the model. For OpenAI this is equal to the [model aliases](https://platform.openai.com/docs/models#current-model-aliases). For Azure OpenAI this is the deployment name from the [Azure Portal](https://oai.azure.com/resource/deployments).
157157
| Output modality| Describes what the output of the model is. This connector currently supports Text, Embedding, and Image.
158+
| Input modality| Describes what input modalities are accepted by the model. This connector currently supports Text and Image.
158159
| Azure API version | Azure OpenAI only. This is the API version to use for this operation. It follows the `yyyy-MM-dd` format. For supported versions, see [Azure OpenAI documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference). The supported versions can vary depending on the type of model, so make sure to look for the right section (such as Chat Completions, Image Generation, or Embeddings) on that page. |
159160

160161
3. Close the popup and test the configuration with the newly created deployed models.
@@ -190,7 +191,7 @@ OpenAI does not call the function. The model returns a tool called JSON structur
190191

191192
This is all part of the implementation that is executed by the GenAI Commons chat completions operations mentioned before. As a developer, you have to make the system aware of your functions and what these do by registering the function(s) to the request. This is done using the GenAI Commons operation [Tools: Add Function to Request](/appstore/modules/genai/genai-for-mx/commons/#add-function-to-request) once per function before passing the request to the chat completions operation.
192193

193-
Currently, the connector supports the calling of Function microflows that take a single input parameter of type string or no input parameter and return a string.
194+
Currently, the connector supports the calling of Function microflows that take a single input parameter of type string and optionally a Request and/or Tool object or no input parameter at all and return a string.
194195

195196
{{% alert color="warning" %}}
196197
Function calling is a very powerful capability and should be used with caution. Function microflows run in the context of the current user, without enforcing entity access. You can use `$currentUser` in XPath queries to ensure that you retrieve and return only information that the end-user is allowed to view; otherwise, confidential information may become visible to the current end-user in the assistant's response.

content/en/docs/appstore/use-content/platform-supported-content/modules/genai/reference-guide/genai-for-mendix/genai-commons.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -821,7 +821,7 @@ This microflow creates a new [MetadataCollection](#metadatacollection-entity) an
821821
| `Text` | **Text** | The model supports text. |
822822
| `Embeddings` | **Embeddings** | The model supports embeddings. |
823823
| `Image` | **Image** | The model supports image. |
824-
| `File` | **File** | The model supports file. |
824+
| `Document` | **Document** | The model supports document. |
825825
| `Audio` | **Audio** | The model supports audio. |
826826
| `Video` | **Video** | The model supports video. |
827827
| `Other` | **Other** | The model supports another modality. |

0 commit comments

Comments
 (0)