azureOpenaiClientAdapter

Points the OpenAI SDK at an Azure OpenAI resource.

Signature

azureOpenaiClientAdapter({ azureOpenai: AzureOpenAI, })

Install

npm install supercompat openai

Example — Responses API on Azure

import { AzureOpenAI } from 'openai' import { supercompat, azureOpenaiClientAdapter, azureResponsesRunAdapter, azureResponsesStorageAdapter, } from 'supercompat/openai' const azureOpenai = new AzureOpenAI({ endpoint: process.env.AZURE_OPENAI_ENDPOINT!, apiKey: process.env.AZURE_OPENAI_API_KEY, apiVersion: '2024-10-01-preview', }) const client = supercompat({ clientAdapter: azureOpenaiClientAdapter({ azureOpenai }), storageAdapter: azureResponsesStorageAdapter(), runAdapter: azureResponsesRunAdapter(), }) const response = await client.responses.create({ model: 'my-gpt-4-1-deployment', input: 'Hello from Azure.', })
Use your Azure deployment name as model — not the model id.

Compatible run adapters

azureResponsesRunAdapter — native Azure Responses
completionsRunAdapter — generic fallback