Skip to main content

OpenAI Integration with Orkes Conductor

To use system AI tasks in Orkes Conductor, you must integrate your Conductor cluster with the necessary AI/LLM providers. This guide explains how to integrate OpenAI with Orkes Conductor. Here’s an overview:

  1. Get the required credentials from OpenAI.
  2. Configure a new OpenAI integration in Orkes Conductor.
  3. Add models to the integration.
  4. Set access limits to the AI model to govern which applications or groups can use them.

Step 1: Get the OpenAI credentials​

To integrate OpenAI with Orkes Conductor, retrieve the API key from the OpenAI platform.

To get the API key:

  1. Sign in to the OpenAI platform.
  2. Go to Dashboard > API keys from the left menu and select + Create new secret key.

Create new API Keys in OpenAI API platform

  1. Enter a name for your secret and select Create secret key.
  2. Copy and store the generated key securely, as it is shown only once.

Generated OpenAI key

Step 2: Add an integration for OpenAI​

After obtaining the credentials, add an OpenAI integration to your Conductor cluster.

To create an OpenAI integration:

  1. Go to Integrations from the left navigation menu on your Conductor cluster.
  2. Select + New integration.
  3. In the AI/LLM section, choose OpenAI.
  4. Select + Add and enter the following parameters:
ParametersDescription
Integration nameA name for the integration.
API KeyThe API key copied previously from the OpenAI platform.
DescriptionA description of the integration.

OpenAI Integration with Orkes Conductor

  1. (Optional) Toggle the Active button off if you don’t want to activate the integration instantly.
  2. Select Save.

Step 3: Add OpenAI models​

Once you’ve integrated OpenAI, the next step is to configure specific models.

OpenAI has different models, such as text-davinci-003, text-embedding-ada-002, gpt-35-turbo, and more, each designed for various use cases, such as text completion and embedding generation. Choose the model that best fits your use case.

To add a model to the OpenAI integration:

  1. Go to the Integrations page and select the + button next to the integration created.

Create new model for OpenAI Integration

  1. Select + New model.
  2. Enter the Model name and a Description. Get the complete list of OpenAI models.

Creating new model for OpenAI Integration

  1. (Optional) Toggle the Active button off if you don’t want to activate the model instantly.
  2. Select Save.

This saves the model for future use in AI tasks within Orkes Conductor.

Step 4: Set access limits to integration​

Once the integration is configured, set access controls to manage which applications or groups can use the models.

To provide access to an application or group:

  1. Go to Access Control > Applications or Groups from the left navigation menu on your Conductor cluster.
  2. Create a new group/application or select an existing one.
  3. In the Permissions section, select + Add Permission.
  4. In the Integration tab, select the required AI models and toggle the necessary permissions.
  5. Select Add Permissions.

Add Permissions for Azure OpenAI Integration

The group or application can now access the AI model according to the configured permissions.

With the integration in place, you can now create workflows using AI/LLM tasks.

More resources​