Skip to main content

Azure OpenAI Service Connector

Azure OpenAI Service Generate completions and images using Azure OpenAI Service or OpenAI API.

Connections​

API Key​

Connect using an OpenAI or Azure OpenAI API key

This connection supports both Azure OpenAI Service and standard OpenAI API authentication using API keys.

Prerequisites​

For Azure OpenAI Service:

For OpenAI API:

Setup For Azure OpenAI Service​

To use Azure OpenAI Service, an Azure OpenAI resource and API key are required.

  1. Follow the Azure OpenAI quickstart guide to create an Azure OpenAI resource
  2. In the Azure portal, navigate to the Azure OpenAI resource
  3. Select Keys and Endpoint from the resource menu
  4. Copy one of the displayed API keys

For additional information on Azure OpenAI authentication, refer to Azure OpenAI Service REST API reference.

Setup For OpenAI API​

To use the standard OpenAI API, an API key from OpenAI is required.

  1. Navigate to API Keys in the OpenAI platform
  2. Click Create new secret key
  3. Enter a name for the key (optional) and click Create secret key
  4. Copy the generated API key (it begins with sk-)

Note: If the user account belongs to multiple OpenAI organizations, the organization ID will also be required. The organization ID can be found in Organization settings.

Configure the Connection​

When configuring the connection:

  • Enter the API Key from either Azure OpenAI Service or OpenAI API
  • Set Is OpenAI Key to:
    • false for Azure OpenAI Service (default)
    • true for standard OpenAI API
  • For Organization (OpenAI only):
    • Leave blank if the account belongs to a single organization
    • Enter the organization ID if the account belongs to multiple organizations

The API key format differs between providers:

  • Azure OpenAI: 32-character hexadecimal string
  • OpenAI API: Begins with sk- followed by a random string
InputCommentsDefault
API KeyOpenAI API key or Azure OpenAI API key.
OrganizationYour OpenAI organization ID. Only required if you belong to multiple organizations.
Is OpenAI KeyWhen true, uses the OpenAI API directly. When false, uses Azure OpenAI Service.false

Actions​

Create Chat Completion​

Create a completion for the chat message

InputCommentsDefault
ConnectionThe Azure OpenAI Service or OpenAI API connection to use.
Model / Deployment NameSpecifies either the model deployment name (when using Azure OpenAI) or model name (when using OpenAI). See available models at https://platform.openai.com/docs/models.gpt-4o-mini
MessagesAn array of message objects with 'role' (system, user, or assistant) and 'content' properties.
[
 {
 "role": "system",
 "content": "You are a helpful assistant."
 },
 {
 "role": "user",
 "content": "Who won the world series in 2020?"
 },
 {
 "role": "assistant",
 "content": "The Los Angeles Dodgers won the World Series in 2020."
 },
 {
 "role": "user",
 "content": "Where was it played?"
 }
]
TemperatureWhat sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.1
top_pAn alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.1
Number of choicesHow many chat completion choices to generate for each input message.1

Create Image​

Create image(s) given a prompt

InputCommentsDefault
ConnectionThe Azure OpenAI Service or OpenAI API connection to use.
PromptA text description of the desired image(s). The maximum length is 1000 characters.
Number of ImagesThe number of images to generate. Must be between 1 and 10.1
Image SizeThe size of the generated images. Must be one of 1792x1024, 1024x1792, or 1024x1024.1024x1024

Create Multiple Chat Completion​

Generate Multiple Completions

InputCommentsDefault
ConnectionThe Azure OpenAI Service or OpenAI API connection to use.
Model / Deployment NameSpecifies either the model deployment name (when using Azure OpenAI) or model name (when using OpenAI). See available models at https://platform.openai.com/docs/models.gpt-3.5-turbo-instruct
MessagesAn array of message objects with 'role' (system, user, or assistant) and 'content' properties.
[
 "How are you today?",
 "What is Azure OpenAI?",
 "Why do children love dinosaurs?",
 "Generate a proof of Euler's identity",
 "Describe in single words only the good things that come into your mind about your mother."
]

Raw Request​

Send raw HTTP request to Azure OpenAI

InputCommentsDefault
ConnectionThe Azure OpenAI Service or OpenAI API connection to use.
URLInput the path only (/v1/images/generations), The base URL is already included (https://api.openai.com). For example, to connect to https://api.openai.com/v1/images/generations, only /v1/images/generations is entered in this field./v1/models
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.
Query ParameterA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
HeaderA list of headers to send with the request.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.false
Max Retry CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.false

Summarize Text​

Summarize a given text

InputCommentsDefault
ConnectionThe Azure OpenAI Service or OpenAI API connection to use.
Model / Deployment NameSpecifies either the model deployment name (when using Azure OpenAI) or model name (when using OpenAI). See available models at https://platform.openai.com/docs/models.gpt-3.5-turbo-instruct
Text to Summarize