Skip to content

Commit 20646de

Browse files
SAS-1051: exposed microflows
1 parent b45f2cb commit 20646de

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

  • content/en/docs/appstore/use-content/platform-supported-content/modules/genai/openai

content/en/docs/appstore/use-content/platform-supported-content/modules/genai/openai/_index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -257,25 +257,25 @@ Purely for the purpose of generating embeddings, it does not matter whether the
257257

258258
Note that currently the OpenAI connector does not support knowledge base interaction (e.g. inserting or retrieving chunks). For more information on possible ways to work with knowledge bases when using the OpenAI Connector for embeddings generation, read more about [PgVector Knowledge Base](/appstore/modules/pgvector-knowledge-base/) and [setting up a Vector Database](/appstore/modules/genai/pgvector-setup/).
259259

260-
### Exposed Microflows for (Azure) OpenAI {#exposed-microflows}
260+
### Exposed Microflow Actions for (Azure) OpenAI {#exposed-microflows}
261261

262-
You can use the following OpenAI-specific exposed microflows to construct requests via drag-and-drop. These microflows can be found in the **Toolbox** in the **OpenAI (Build Request)** section. Note that using these flows is only required if you need to add options to the request that are specific to OpenAI. For the generic part can use the GenAI Commons toolbox actions to [create the required Request](/appstore/modules/genai/commons/#text-files-request) and [handle the Response](/appstore/modules/genai/commons/#text-files-response).
262+
Here we list the OpenAI-specific exposed microflow actions to construct requests via drag-and-drop. These microflows can be found in the **Toolbox** in Studio Pro. Note that using these flows is only required if you need to add options to the request that are specific to OpenAI. For the generic part can use the GenAI Commons toolbox actions to [create the required Request](/appstore/modules/genai/commons/#text-files-request) and [handle the Response](/appstore/modules/genai/commons/#text-files-response), which can be found under the **GenAI (Request Building)** and **GenAI (Response Handling)** categories in the Toolbox.
263263

264-
#### `Chat: Set Response Format` {#set-responseformat-chat}
264+
#### Set Response Format {#set-responseformat-chat}
265265

266-
This microflow can be used to optionally change the `ResponseFormat` of the `OpenAIRequest_Extension` object, which will be created for a `Request` if not present. This describes the format that the chat completions model must output.
266+
This microflow changes the `ResponseFormat` of the `OpenAIRequest_Extension` object, which will be created for a `Request` if not present. This describes the format that the chat completions model must output. The default behaviour for OpenAI's models currently is `Text`. This operation must currently be used to enable JSON mode by providing value `JSONObject` as input.
267267

268-
#### `Files: Initialize Collection with OpenAI File` {#initialize-filecollection}
268+
#### Files: Initialize Collection with OpenAI File {#initialize-filecollection}
269269

270-
This microflow can be used to initialize a new `FileCollection` and add a new `FileDocument` or URL. Optionally, the `Image Detail` or a description using `TextContent` can be passed.
270+
This microflow initializes a new `FileCollection` and add a new `FileDocument` or URL. Optionally, the `Image Detail` or a description using `TextContent` can be passed.
271271

272-
#### `Files: Add OpenAI File to Collection` {#add-file}
272+
#### Files: Add OpenAI File to Collection {#add-file}
273273

274-
This microflow can be used to add a new `FileDocument` or URL to an existing `FileCollection`. Optionally, the `Image Detail` or a description using `TextContent` can be passed.
274+
This microflow adds a new `FileDocument` or URL to an existing `FileCollection`. Optionally, the `Image Detail` or a description using `TextContent` can be passed.
275275

276-
#### `Image Generations: Set ImageOptions Extension` {#set-imageoptions-extension}
276+
#### Image Generation: Set ImageOptions Extension {#set-imageoptions-extension}
277277

278-
This microflow can be used to add a new `OpenAIImageOptions_Extension` to an [ImageOptions](/appstore/modules/genai/commons/) object to specify additional configurations for the image generations operation. The object will be used inside of the image generations operation if the same `ImageOptions` are passed. The parameters are optional.
278+
This microflow adds a new `OpenAIImageOptions_Extension` to an [ImageOptions](/appstore/modules/genai/commons/) object in order to specify additional configurations for the image generations operation. The object will be used inside of the image generations operation if the same `ImageOptions` are passed. The parameters are optional.
279279

280280
## Technical Reference {#technical-reference}
281281

0 commit comments

Comments
 (0)