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 Endpoints page (see Create a global endpoint in Global Endpoints).

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 Endpoints page (see Edit a global endpoint in Global Endpoints).

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. You can find the endpoint 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. You can get the API key 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.

• Optional settings: Click to expand these optional settings:

  • Add a data source: Select this option to interact with Azure OpenAI models using data from your data source. When you select this option, additional fields appear based on your selected data source. See Data sources for descriptions of the following options:

    • Azure AI Search
    • Azure Cosmos DB for MongoDB (vCore)

  • 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.

Data sources

When you enable Add a data source in the connection, you can interact with Azure OpenAI models using data from an Azure AI Search or Azure Cosmos DB for MongoDB (vCore) instance.

Azure AI Search

When you select Azure AI Search as the data source, these fields are displayed:

• Select a data source: Use the menu to select the Azure AI Search.

  Note

  For information on Azure AI Search service prerequisites and creating an Azure AI Search service, see Microsoft's documentation.

• Azure AI Search service name: Enter the configured Service name for your Azure AI search service.

  Note

  You must have at least the Cognitive Services Contributor role for the Azure OpenAI resource.

• Select Azure resource authentication type: Key-based authentication (API Key) is supported and selected by default.

• Azure AI Search service data source key: Enter either the Primary admin key or the Secondary admin key. You can find these keys on your search service's Key page under Settings.

Azure Cosmos DB for MongoDB (vCore)

When you select Azure Cosmos DB for MongoDB (vCore) as the data source, these fields are displayed:

• Select a data source: Use the menu to select the Azure Cosmos DB for MongoDB (vCore).

• Connection string: Enter the connection string for the Azure Cosmos DB for MongoDB (vCore) cluster.

• Database name: Enter the database name. You configure the database name through MongoDB tools or your application code.

• Database collection: Enter the collection name. You configure the collection name through MongoDB tools or your application code.

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:

• Register Tools: Adds tools to chatbot assistants in Azure OpenAI and is intended to be used as a target in an operation.

• 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 (deprecated): Retrieves the URL of a previously generated image from Azure OpenAI and is intended to be used as a source in an operation.