Skip to main content

OpenAI Context

Description

This Activity involves establishing a secure connection with OpenAI services and enabling the execution of multiple actions within the context. The Activity also includes archiving chat histories, which document the results and exchanges conducted through OpenAI's platform.

Design Time Configuration

Enterprise Edition

  1. Get API Key from Control Room Connections - Select this option to obtain the API key from Control Room connections.

    • Connection – Select the OpenAI connection name from the Control Room Connections menu. The connection name contains the OpenAI API key for authentication. This option is visible only if the Get API Key from Control Room Connections checkbox is enabled.
  2. Provide API Key - Select this option to provide the API key directly.

    • API Key – Specify the API Key provided by OpenAI for authentication. This option is visible only if enabled by the Provide API Key checkbox.
  • Default Model – Select the default model for the chat activity. The list will be populated based on the models available for the specified API Key.

Professional and IntelliAppZ Edition

  • API Key – Specify the API Key provided by OpenAI for authentication.

  • Default Model – Select the default model for the chat activity. The list will be populated based on the models available for the specified API Key.

Optional

  • Continue On Error – Specifies if the automation should continue even when the Activity throws an error. This field only supports Boolean values (True, False). The default value is False.
    note

    Catches no error if this Activity is present inside the Try-Catch block and the value of this property is True.

Misc

  • DisplayName – Add a display name to your Activity.
  • Private – By default, Activity will log the values of your properties inside your workflow. If private is selected, then it stops logging.

Example

1. Download Enterprise Edition Example

OpenAI Context

OpenAI Context

2. Download Professional Edition Example

OpenAI Context