Azure OpenAI connection

Introduction

An Azure OpenAI connection, created using the Azure OpenAI connector, establishes access to Azure OpenAI. Once a connection is configured, you can create instances of Azure 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 Azure OpenAI connection

A new Azure OpenAI connection is created using the Azure 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 Azure 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 Azure OpenAI connection

Each user interface element of the Azure 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 Azure OpenAI connection and must not contain forward slashes / or colons :. This name is also used to identify the Azure OpenAI endpoint, which refers to both a specific connection and its activities.

• Endpoint: Enter the endpoint for the Azure OpenAI resource. The endpoint is listed in the Azure Portal under Resource Management > Keys and Endpoint in the left sidebar.

• API/Secret Key: Enter the API key for the Azure OpenAI resource. The API key is obtained in the Azure Portal under Resource Management > Keys and Endpoint in the left sidebar. You can use the values from either the KEY 1 or KEY 2 fields.

• Use Proxy Settings (Private Agent Only): When using a private agent, this setting can be selected to use private agent proxy settings.

• 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 Azure 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:

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

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

• Download Image: Retrieves the URL of a previously generated image from Azure OpenAI and is intended to be used as a source in an operation.