OpenAI connection

Introduction

An OpenAI connection, created using the OpenAI connector, establishes access to OpenAI. Once a connection is configured, you can create instances of OpenAI activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Create or edit an OpenAI connection

A new OpenAI connection is created using the OpenAI connector from one of these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The Global Connections page (see Create a global endpoint in Global Connections).

An existing OpenAI connection can be edited from these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).
• The Global Connections page (see Edit a global endpoint in Global Connections).

Configure an OpenAI connection

Each user interface element of the OpenAI connection configuration screen is described below.

• Connection Name: Enter a name to use to identify the connection. The name must be unique for each OpenAI connection and must not contain forward slashes / or colons :. This name is also used to identify the OpenAI endpoint, which refers to both a specific connection and its activities.

• API/Secret Key: Enter the API key. API keys are generated on the API keys page of the OpenAI instance.

• API Version: The version V1 is the only supported version and is selected by default.

• Use Proxy Settings (Private Agent Only): When using a private agent, this setting can be selected to use private agent proxy settings for HTTPS proxy. This connector does not support NTLM proxy.

• Optional Settings: Click to expand additional optional settings:

  • Organization ID: Enter the organization ID for the OpenAI instance. Your Organization ID can be found on the Organization Settings page.

• Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

• Save Changes: Click to save and close the connection configuration.

• Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

• Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After an OpenAI connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.

These activity types are available:

• Create Transcription: Transcribes audio into text based on the detected input language in OpenAI and is intended to be used as a target in an operation.

• Create Image: Creates an image based on a specified prompt in OpenAI and is intended to be used as a target in an operation.

• Prompt: Creates a text completion for the provided prompt in OpenAI and is intended to be used as a target in an operation.

• Create Translation: Translates audio files into English text in OpenAI and is intended to be used as a target in an operation.