@ai-sdk/azure
Version:
The **[Azure provider](https://ai-sdk.dev/providers/ai-sdk-providers/azure)** for the [AI SDK](https://ai-sdk.dev/docs) contains language model support for the Azure OpenAI API.
316 lines (270 loc) • 8.44 kB
text/typescript
import {
OpenAIChatLanguageModel,
OpenAICompletionLanguageModel,
OpenAIEmbeddingModel,
OpenAIImageModel,
OpenAIResponsesLanguageModel,
OpenAISpeechModel,
OpenAITranscriptionModel,
} from '@ai-sdk/openai/internal';
import {
InvalidArgumentError,
type EmbeddingModelV3,
type LanguageModelV3,
type ProviderV3,
type ImageModelV3,
type SpeechModelV3,
type TranscriptionModelV3,
} from '@ai-sdk/provider';
import {
loadApiKey,
loadSetting,
normalizeHeaders,
withUserAgentSuffix,
type FetchFunction,
} from '@ai-sdk/provider-utils';
import { azureOpenaiTools } from './azure-openai-tools';
import { VERSION } from './version';
export interface AzureOpenAIProvider extends ProviderV3 {
(deploymentId: string): LanguageModelV3;
/**
* Creates an Azure OpenAI responses API model for text generation.
*/
languageModel(deploymentId: string): LanguageModelV3;
/**
* Creates an Azure OpenAI chat model for text generation.
*/
chat(deploymentId: string): LanguageModelV3;
/**
* Creates an Azure OpenAI responses API model for text generation.
*/
responses(deploymentId: string): LanguageModelV3;
/**
* Creates an Azure OpenAI completion model for text generation.
*/
completion(deploymentId: string): LanguageModelV3;
/**
* Creates an Azure OpenAI model for text embeddings.
*/
embedding(deploymentId: string): EmbeddingModelV3;
/**
* Creates an Azure OpenAI model for text embeddings.
*/
embeddingModel(deploymentId: string): EmbeddingModelV3;
/**
* @deprecated Use `embedding` instead.
*/
textEmbedding(deploymentId: string): EmbeddingModelV3;
/**
* @deprecated Use `embeddingModel` instead.
*/
textEmbeddingModel(deploymentId: string): EmbeddingModelV3;
/**
* Creates an Azure OpenAI DALL-E model for image generation.
*/
image(deploymentId: string): ImageModelV3;
/**
* Creates an Azure OpenAI DALL-E model for image generation.
*/
imageModel(deploymentId: string): ImageModelV3;
/**
* Creates an Azure OpenAI model for audio transcription.
*/
transcription(deploymentId: string): TranscriptionModelV3;
/**
* Creates an Azure OpenAI model for speech generation.
*/
speech(deploymentId: string): SpeechModelV3;
/**
* AzureOpenAI-specific tools.
*/
tools: typeof azureOpenaiTools;
}
export interface AzureOpenAIProviderSettings {
/**
* Name of the Azure OpenAI resource. Either this or `baseURL` can be used.
*
* The resource name is used in the assembled URL: `https://{resourceName}.openai.azure.com/openai/v1{path}`.
*/
resourceName?: string;
/**
* Use a different URL prefix for API calls, e.g. to use proxy servers. Either this or `resourceName` can be used.
* When a baseURL is provided, the resourceName is ignored.
*
* With a baseURL, the resolved URL is `{baseURL}/v1{path}`.
*/
baseURL?: string;
/**
* API key for authenticating requests.
*/
apiKey?: string;
/**
* A function that returns an access token for Microsoft Entra
* (formerly known as Azure Active Directory), which will be invoked
* on every request.
*/
tokenProvider?: (() => Promise<string>) | undefined;
/**
* Custom headers to include in the requests.
*/
headers?: Record<string, string>;
/**
* Custom fetch implementation. You can use it as a middleware to intercept requests,
* or to provide a custom fetch implementation for e.g. testing.
*/
fetch?: FetchFunction;
/**
* Custom api version to use. Defaults to `preview`.
*/
apiVersion?: string;
/**
* Use deployment-based URLs for specific model types. Set to true to use legacy deployment format:
* `{baseURL}/deployments/{deploymentId}{path}?api-version={apiVersion}` instead of
* `{baseURL}/v1{path}?api-version={apiVersion}`.
*/
useDeploymentBasedUrls?: boolean;
}
/**
* Create an Azure OpenAI provider instance.
*/
export function createAzure(
options: AzureOpenAIProviderSettings = {},
): AzureOpenAIProvider {
const tokenProvider = options.tokenProvider;
if (options.apiKey && tokenProvider) {
throw new InvalidArgumentError({
argument: 'apiKey/tokenProvider',
message:
'Both apiKey and tokenProvider were provided. Please use only one authentication method.',
});
}
const getHeaders = () => {
const authHeaders = tokenProvider
? {}
: {
'api-key': loadApiKey({
apiKey: options.apiKey,
environmentVariableName: 'AZURE_API_KEY',
description: 'Azure OpenAI',
}),
};
return withUserAgentSuffix(
{
...authHeaders,
...options.headers,
},
`ai-sdk/azure/${VERSION}`,
);
};
const fetch: FetchFunction | undefined = tokenProvider
? async (input, init) => {
const headers = normalizeHeaders(init?.headers);
if (headers.authorization == null) {
headers.authorization = `Bearer ${await tokenProvider()}`;
}
return (options.fetch ?? globalThis.fetch)(input, {
...init,
headers,
});
}
: options.fetch;
const getResourceName = () =>
loadSetting({
settingValue: options.resourceName,
settingName: 'resourceName',
environmentVariableName: 'AZURE_RESOURCE_NAME',
description: 'Azure OpenAI resource name',
});
const apiVersion = options.apiVersion ?? 'v1';
const url = ({ path, modelId }: { path: string; modelId: string }) => {
const baseUrlPrefix =
options.baseURL ?? `https://${getResourceName()}.openai.azure.com/openai`;
let fullUrl: URL;
if (options.useDeploymentBasedUrls) {
// Use deployment-based format for compatibility with certain Azure OpenAI models
fullUrl = new URL(`${baseUrlPrefix}/deployments/${modelId}${path}`);
} else {
// Use v1 API format - no deployment ID in URL
fullUrl = new URL(`${baseUrlPrefix}/v1${path}`);
}
fullUrl.searchParams.set('api-version', apiVersion);
return fullUrl.toString();
};
const createChatModel = (deploymentName: string) =>
new OpenAIChatLanguageModel(deploymentName, {
provider: 'azure.chat',
url,
headers: getHeaders,
fetch,
});
const createCompletionModel = (modelId: string) =>
new OpenAICompletionLanguageModel(modelId, {
provider: 'azure.completion',
url,
headers: getHeaders,
fetch,
});
const createEmbeddingModel = (modelId: string) =>
new OpenAIEmbeddingModel(modelId, {
provider: 'azure.embeddings',
headers: getHeaders,
url,
fetch,
});
const createResponsesModel = (modelId: string) =>
new OpenAIResponsesLanguageModel(modelId, {
provider: 'azure.responses',
url,
headers: getHeaders,
fetch,
fileIdPrefixes: ['assistant-'],
});
const createImageModel = (modelId: string) =>
new OpenAIImageModel(modelId, {
provider: 'azure.image',
url,
headers: getHeaders,
fetch,
});
const createTranscriptionModel = (modelId: string) =>
new OpenAITranscriptionModel(modelId, {
provider: 'azure.transcription',
url,
headers: getHeaders,
fetch,
});
const createSpeechModel = (modelId: string) =>
new OpenAISpeechModel(modelId, {
provider: 'azure.speech',
url,
headers: getHeaders,
fetch,
});
const provider = function (deploymentId: string) {
if (new.target) {
throw new Error(
'The Azure OpenAI model function cannot be called with the new keyword.',
);
}
return createResponsesModel(deploymentId);
};
provider.specificationVersion = 'v3' as const;
provider.languageModel = createResponsesModel;
provider.chat = createChatModel;
provider.completion = createCompletionModel;
provider.embedding = createEmbeddingModel;
provider.embeddingModel = createEmbeddingModel;
provider.textEmbedding = createEmbeddingModel;
provider.textEmbeddingModel = createEmbeddingModel;
provider.image = createImageModel;
provider.imageModel = createImageModel;
provider.responses = createResponsesModel;
provider.transcription = createTranscriptionModel;
provider.speech = createSpeechModel;
provider.tools = azureOpenaiTools;
return provider;
}
/**
* Default Azure OpenAI provider instance.
*/
export const azure = createAzure();