Skip to Content

Azure OpenAI Connector

Summary

The Azure OpenAI connector establishes access to Azure OpenAI.

The Azure OpenAI connector provides an interface for creating an Azure OpenAI connection, the foundation used for generating instances of Azure OpenAI activities. These activities, once configured, interact with Azure OpenAI through the connection.

The Azure OpenAI connector is accessed from the design component palette's Project endpoints and connectors tab (see Design Component Palette).

Connector Overview

This connector is used to first configure an Azure OpenAI connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific Azure OpenAI connection and its activities are referred to as an Azure OpenAI endpoint:

Azure OpenAI activity types

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

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and Supported API Versions

The Azure OpenAI connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

The Azure OpenAI connector uses the Azure OpenAI Service REST API. Refer to the API documentation for information on the schema nodes and fields.

This connector supports Azure OpenAI version 2023-06-01-preview.

Troubleshooting

If you experience issues with the Azure OpenAI connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.

  4. If using Private Agents, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.microsoft.azure.openai" level="DEBUG"/>
    
  5. If using Private Agents, you can check the agent logs for more information.