AskOpenAI Step

Use this step to Ask question from OpenAI

Last published at: August 9th, 2024

Description:

You can use this step to Ask questions from OpenAI.

 

Inputs

  • actAs – Ask the model to take on a specific role, persona, or perspective while interacting with you
  • model – select the AI model to use
  • prompt - text prompt to ask AI
  • varGlobalStoreResult - variable/global to store the result
 

 

Returns

  • True – step executed successfully
  • False – step failed to execute 
 

 

Usage:

 

 

Example:

Let’s build and execute the askOpenAIDef example.          

  • Create a new definition called “askOpenAIDef
  • Select the definition and click the “design” button
  • Drag a “askOpenAI” step from the toolbox
  • Connect the dots between the start and “askOpenAI” step
  • Click the "askOpenAI" step to configure its "Settings" properties. Provide a name to the step. Select the chat model from the drop-down list. The FlowWright product team frequently updates these chat models. Type in the prompt text to ask OpenAI. Provide the variable/global reference to store the result. 

 

  • Click the "askOpenAI" step to configure its "Advanced" properties. Provide the text for the ActAs field. The "Act As" prompt in ChatGPT is a creative way to ask the model to take on a specific role, persona, or perspective while interacting with you. 

 

  • 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 execute. Render the process instance. Click on the process step to view its properties. The step should ask the OpenAI and store the result in the variable/global as configured. 
  • The AskOpenAI result is included here for your reference.