Description:
This step is used to complete the Azure OpenAI text chat.
Inputs
- question - question to ask
- actAs - act as a persona
- model - OpenAI deployment model. For example gpt-4o
- temp - controls the "creativity" of the generated text, between 0 and 2
- varGlobalResult - variable/global to store the chat completion result
- files - list of image files to facilitate the chat completion
Returns
- True – step executed successfully
- False – step failed to execute
Usage:
Example:
Let’s build and execute the “azureOpenAIDef” example.
- Create a new process definition called “azureOpenAIDef” and open it in Designer mode.
- Drag an “azureOpenAI” step to the canvas.
- Connect the dots between the “Start” and “azureOpenAI” steps, as shown above.
- Click the "azureOpenAI" step to configure its "Required" properties. Provide a name for the step. Provide the text question to ask. Provide the OpenAI chat models. Provide a variable or global reference to store chat completion results. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description.
- Click the "azureOpenAI" step to configure its "Optional" properties. Provide a persona description. Set a temperature value between 0 and 2 to control the "creativity" of the generated text. Provide the list of image file paths on the application server. Click the Save button.
- The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the percent complete. This is achieved by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.
- Save the process definition, create a new instance, and then execute it. Click the process step to view its properties. The “azureOpenAI” step should complete the chat conversation using the persona's reference.
Definition Sample:
You may download the sample definition(s) from the link here and later import them (drag-and-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.
Note: Please verify and complete the process steps for any missing configurations, such as file path references and database connections, after import. Then, save the definition to confirm the changes.