@ai-sdk/azure 4.0.0-canary.65 → 4.0.0-canary.67

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @ai-sdk/azure
 
+## 4.0.0-canary.67
+
+### Patch Changes
+
+- 9f4dca0: Add Microsoft Entra ID token provider authentication for Azure OpenAI.
+
+## 4.0.0-canary.66
+
+### Patch Changes
+
+- e776fc7: feat(provider/azure):web search tool in the Azure OpenAI Responses API.
+- Updated dependencies [e776fc7]
+  - @ai-sdk/openai@4.0.0-canary.66
+
 ## 4.0.0-canary.65
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,12 +1,13 @@
 export { OpenAILanguageModelChatOptions as OpenAIChatLanguageModelOptions, OpenAILanguageModelChatOptions, OpenAILanguageModelResponsesOptions, OpenAILanguageModelResponsesOptions as OpenAIResponsesProviderOptions } from '@ai-sdk/openai';
 import { ProviderV4, LanguageModelV4, EmbeddingModelV4, ImageModelV4, TranscriptionModelV4, SpeechModelV4 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
-import { codeInterpreter, fileSearch, imageGeneration, webSearchPreview, ResponsesProviderMetadata, ResponsesReasoningProviderMetadata, ResponsesSourceDocumentProviderMetadata, ResponsesTextProviderMetadata } from '@ai-sdk/openai/internal';
+import { codeInterpreter, fileSearch, imageGeneration, webSearch, webSearchPreview, ResponsesProviderMetadata, ResponsesReasoningProviderMetadata, ResponsesSourceDocumentProviderMetadata, ResponsesTextProviderMetadata } from '@ai-sdk/openai/internal';
 
 declare const azureOpenaiTools: {
     codeInterpreter: typeof codeInterpreter;
     fileSearch: typeof fileSearch;
     imageGeneration: typeof imageGeneration;
+    webSearch: typeof webSearch;
     webSearchPreview: typeof webSearchPreview;
 };
 
@@ -83,6 +84,12 @@ interface AzureOpenAIProviderSettings {
      * 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.
      */

package/dist/index.js

@@ -8,9 +8,13 @@ import {
   OpenAISpeechModel,
   OpenAITranscriptionModel
 } from "@ai-sdk/openai/internal";
+import {
+  InvalidArgumentError
+} from "@ai-sdk/provider";
 import {
   loadApiKey,
   loadSetting,
+  normalizeHeaders,
   withUserAgentSuffix
 } from "@ai-sdk/provider-utils";
 
@@ -19,32 +23,57 @@ import {
   codeInterpreter,
   fileSearch,
   imageGeneration,
+  webSearch,
   webSearchPreview
 } from "@ai-sdk/openai/internal";
 var azureOpenaiTools = {
   codeInterpreter,
   fileSearch,
   imageGeneration,
+  webSearch,
   webSearchPreview
 };
 
 // src/version.ts
-var VERSION = true ? "4.0.0-canary.65" : "0.0.0-test";
+var VERSION = true ? "4.0.0-canary.67" : "0.0.0-test";
 
 // src/azure-openai-provider.ts
 function createAzure(options = {}) {
   var _a;
+  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 baseHeaders = {
+    const authHeaders = tokenProvider ? {} : {
       "api-key": loadApiKey({
         apiKey: options.apiKey,
         environmentVariableName: "AZURE_API_KEY",
         description: "Azure OpenAI"
-      }),
-      ...options.headers
+      })
     };
-    return withUserAgentSuffix(baseHeaders, `ai-sdk/azure/${VERSION}`);
+    return withUserAgentSuffix(
+      {
+        ...authHeaders,
+        ...options.headers
+      },
+      `ai-sdk/azure/${VERSION}`
+    );
   };
+  const fetch = tokenProvider ? async (input, init) => {
+    var _a2;
+    const headers = normalizeHeaders(init == null ? void 0 : init.headers);
+    if (headers.authorization == null) {
+      headers.authorization = `Bearer ${await tokenProvider()}`;
+    }
+    return ((_a2 = options.fetch) != null ? _a2 : globalThis.fetch)(input, {
+      ...init,
+      headers
+    });
+  } : options.fetch;
   const getResourceName = () => loadSetting({
     settingValue: options.resourceName,
     settingName: "resourceName",
@@ -68,25 +97,25 @@ function createAzure(options = {}) {
     provider: "azure.chat",
     url,
     headers: getHeaders,
-    fetch: options.fetch
+    fetch
   });
   const createCompletionModel = (modelId) => new OpenAICompletionLanguageModel(modelId, {
     provider: "azure.completion",
     url,
     headers: getHeaders,
-    fetch: options.fetch
+    fetch
   });
   const createEmbeddingModel = (modelId) => new OpenAIEmbeddingModel(modelId, {
     provider: "azure.embeddings",
     headers: getHeaders,
     url,
-    fetch: options.fetch
+    fetch
   });
   const createResponsesModel = (modelId) => new OpenAIResponsesLanguageModel(modelId, {
     provider: "azure.responses",
     url,
     headers: getHeaders,
-    fetch: options.fetch,
+    fetch,
     // Soft-deprecated. TODO: remove in v8
     fileIdPrefixes: ["assistant-"]
   });
@@ -94,19 +123,19 @@ function createAzure(options = {}) {
     provider: "azure.image",
     url,
     headers: getHeaders,
-    fetch: options.fetch
+    fetch
   });
   const createTranscriptionModel = (modelId) => new OpenAITranscriptionModel(modelId, {
     provider: "azure.transcription",
     url,
     headers: getHeaders,
-    fetch: options.fetch
+    fetch
   });
   const createSpeechModel = (modelId) => new OpenAISpeechModel(modelId, {
     provider: "azure.speech",
     url,
     headers: getHeaders,
-    fetch: options.fetch
+    fetch
   });
   const provider = function(deploymentId) {
     if (new.target) {

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/azure-openai-provider.ts","../src/azure-openai-tools.ts","../src/version.ts"],"sourcesContent":["import {\n  OpenAIChatLanguageModel,\n  OpenAICompletionLanguageModel,\n  OpenAIEmbeddingModel,\n  OpenAIImageModel,\n  OpenAIResponsesLanguageModel,\n  OpenAISpeechModel,\n  OpenAITranscriptionModel,\n} from '@ai-sdk/openai/internal';\nimport type {\n  EmbeddingModelV4,\n  LanguageModelV4,\n  ProviderV4,\n  ImageModelV4,\n  SpeechModelV4,\n  TranscriptionModelV4,\n} from '@ai-sdk/provider';\nimport {\n  loadApiKey,\n  loadSetting,\n  withUserAgentSuffix,\n  type FetchFunction,\n} from '@ai-sdk/provider-utils';\nimport { azureOpenaiTools } from './azure-openai-tools';\nimport { VERSION } from './version';\n\nexport interface AzureOpenAIProvider extends ProviderV4 {\n  (deploymentId: string): LanguageModelV4;\n\n  /**\n   * Creates an Azure OpenAI responses API model for text generation.\n   */\n  languageModel(deploymentId: string): LanguageModelV4;\n\n  /**\n   * Creates an Azure OpenAI chat model for text generation.\n   */\n  chat(deploymentId: string): LanguageModelV4;\n\n  /**\n   * Creates an Azure OpenAI responses API model for text generation.\n   */\n  responses(deploymentId: string): LanguageModelV4;\n\n  /**\n   * Creates an Azure OpenAI completion model for text generation.\n   */\n  completion(deploymentId: string): LanguageModelV4;\n\n  /**\n   * Creates an Azure OpenAI model for text embeddings.\n   */\n  embedding(deploymentId: string): EmbeddingModelV4;\n\n  /**\n   * Creates an Azure OpenAI model for text embeddings.\n   */\n  embeddingModel(deploymentId: string): EmbeddingModelV4;\n\n  /**\n   * @deprecated Use `embedding` instead.\n   */\n  textEmbedding(deploymentId: string): EmbeddingModelV4;\n\n  /**\n   * @deprecated Use `embeddingModel` instead.\n   */\n  textEmbeddingModel(deploymentId: string): EmbeddingModelV4;\n\n  /**\n   * Creates an Azure OpenAI DALL-E model for image generation.\n   */\n  image(deploymentId: string): ImageModelV4;\n\n  /**\n   * Creates an Azure OpenAI DALL-E model for image generation.\n   */\n  imageModel(deploymentId: string): ImageModelV4;\n\n  /**\n   * Creates an Azure OpenAI model for audio transcription.\n   */\n  transcription(deploymentId: string): TranscriptionModelV4;\n\n  /**\n   * Creates an Azure OpenAI model for speech generation.\n   */\n  speech(deploymentId: string): SpeechModelV4;\n\n  /**\n   * AzureOpenAI-specific tools.\n   */\n  tools: typeof azureOpenaiTools;\n}\n\nexport interface AzureOpenAIProviderSettings {\n  /**\n   * Name of the Azure OpenAI resource. Either this or `baseURL` can be used.\n   *\n   * The resource name is used in the assembled URL: `https://{resourceName}.openai.azure.com/openai/v1{path}`.\n   */\n  resourceName?: string;\n\n  /**\n   * Use a different URL prefix for API calls, e.g. to use proxy servers. Either this or `resourceName` can be used.\n   * When a baseURL is provided, the resourceName is ignored.\n   *\n   * With a baseURL, the resolved URL is `{baseURL}/v1{path}`.\n   */\n  baseURL?: string;\n\n  /**\n   * API key for authenticating requests.\n   */\n  apiKey?: string;\n\n  /**\n   * Custom headers to include in the requests.\n   */\n  headers?: Record<string, string>;\n\n  /**\n   * Custom fetch implementation. You can use it as a middleware to intercept requests,\n   * or to provide a custom fetch implementation for e.g. testing.\n   */\n  fetch?: FetchFunction;\n\n  /**\n   * Custom api version to use. Defaults to `preview`.\n   */\n  apiVersion?: string;\n\n  /**\n   * Use deployment-based URLs for specific model types. Set to true to use legacy deployment format:\n   * `{baseURL}/deployments/{deploymentId}{path}?api-version={apiVersion}` instead of\n   * `{baseURL}/v1{path}?api-version={apiVersion}`.\n   */\n  useDeploymentBasedUrls?: boolean;\n}\n\n/**\n * Create an Azure OpenAI provider instance.\n */\nexport function createAzure(\n  options: AzureOpenAIProviderSettings = {},\n): AzureOpenAIProvider {\n  const getHeaders = () => {\n    const baseHeaders = {\n      'api-key': loadApiKey({\n        apiKey: options.apiKey,\n        environmentVariableName: 'AZURE_API_KEY',\n        description: 'Azure OpenAI',\n      }),\n      ...options.headers,\n    };\n    return withUserAgentSuffix(baseHeaders, `ai-sdk/azure/${VERSION}`);\n  };\n\n  const getResourceName = () =>\n    loadSetting({\n      settingValue: options.resourceName,\n      settingName: 'resourceName',\n      environmentVariableName: 'AZURE_RESOURCE_NAME',\n      description: 'Azure OpenAI resource name',\n    });\n\n  const apiVersion = options.apiVersion ?? 'v1';\n\n  const url = ({ path, modelId }: { path: string; modelId: string }) => {\n    const baseUrlPrefix =\n      options.baseURL ?? `https://${getResourceName()}.openai.azure.com/openai`;\n\n    let fullUrl: URL;\n    if (options.useDeploymentBasedUrls) {\n      // Use deployment-based format for compatibility with certain Azure OpenAI models\n      fullUrl = new URL(`${baseUrlPrefix}/deployments/${modelId}${path}`);\n    } else {\n      // Use v1 API format - no deployment ID in URL\n      fullUrl = new URL(`${baseUrlPrefix}/v1${path}`);\n    }\n\n    fullUrl.searchParams.set('api-version', apiVersion);\n    return fullUrl.toString();\n  };\n\n  const createChatModel = (deploymentName: string) =>\n    new OpenAIChatLanguageModel(deploymentName, {\n      provider: 'azure.chat',\n      url,\n      headers: getHeaders,\n      fetch: options.fetch,\n    });\n\n  const createCompletionModel = (modelId: string) =>\n    new OpenAICompletionLanguageModel(modelId, {\n      provider: 'azure.completion',\n      url,\n      headers: getHeaders,\n      fetch: options.fetch,\n    });\n\n  const createEmbeddingModel = (modelId: string) =>\n    new OpenAIEmbeddingModel(modelId, {\n      provider: 'azure.embeddings',\n      headers: getHeaders,\n      url,\n      fetch: options.fetch,\n    });\n\n  const createResponsesModel = (modelId: string) =>\n    new OpenAIResponsesLanguageModel(modelId, {\n      provider: 'azure.responses',\n      url,\n      headers: getHeaders,\n      fetch: options.fetch,\n      // Soft-deprecated. TODO: remove in v8\n      fileIdPrefixes: ['assistant-'],\n    });\n\n  const createImageModel = (modelId: string) =>\n    new OpenAIImageModel(modelId, {\n      provider: 'azure.image',\n      url,\n      headers: getHeaders,\n      fetch: options.fetch,\n    });\n\n  const createTranscriptionModel = (modelId: string) =>\n    new OpenAITranscriptionModel(modelId, {\n      provider: 'azure.transcription',\n      url,\n      headers: getHeaders,\n      fetch: options.fetch,\n    });\n\n  const createSpeechModel = (modelId: string) =>\n    new OpenAISpeechModel(modelId, {\n      provider: 'azure.speech',\n      url,\n      headers: getHeaders,\n      fetch: options.fetch,\n    });\n\n  const provider = function (deploymentId: string) {\n    if (new.target) {\n      throw new Error(\n        'The Azure OpenAI model function cannot be called with the new keyword.',\n      );\n    }\n\n    return createResponsesModel(deploymentId);\n  };\n\n  provider.specificationVersion = 'v4' as const;\n  provider.languageModel = createResponsesModel;\n  provider.chat = createChatModel;\n  provider.completion = createCompletionModel;\n  provider.embedding = createEmbeddingModel;\n  provider.embeddingModel = createEmbeddingModel;\n  provider.textEmbedding = createEmbeddingModel;\n  provider.textEmbeddingModel = createEmbeddingModel;\n  provider.image = createImageModel;\n  provider.imageModel = createImageModel;\n  provider.responses = createResponsesModel;\n  provider.transcription = createTranscriptionModel;\n  provider.speech = createSpeechModel;\n  provider.tools = azureOpenaiTools;\n  return provider;\n}\n\n/**\n * Default Azure OpenAI provider instance.\n */\nexport const azure = createAzure();\n","import {\n  codeInterpreter,\n  fileSearch,\n  imageGeneration,\n  webSearchPreview,\n} from '@ai-sdk/openai/internal';\n\nexport const azureOpenaiTools: {\n  codeInterpreter: typeof codeInterpreter;\n  fileSearch: typeof fileSearch;\n  imageGeneration: typeof imageGeneration;\n  webSearchPreview: typeof webSearchPreview;\n} = {\n  codeInterpreter,\n  fileSearch,\n  imageGeneration,\n  webSearchPreview,\n};\n","// Version string of this package injected at build time.\ndeclare const __PACKAGE_VERSION__: string | undefined;\nexport const VERSION: string =\n  typeof __PACKAGE_VERSION__ !== 'undefined'\n    ? __PACKAGE_VERSION__\n    : '0.0.0-test';\n"],"mappings":";AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AASP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OAEK;;;ACtBP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEA,IAAM,mBAKT;AAAA,EACF;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;;;ACfO,IAAM,UACX,OACI,oBACA;;;AF0IC,SAAS,YACd,UAAuC,CAAC,GACnB;AAjJvB;AAkJE,QAAM,aAAa,MAAM;AACvB,UAAM,cAAc;AAAA,MAClB,WAAW,WAAW;AAAA,QACpB,QAAQ,QAAQ;AAAA,QAChB,yBAAyB;AAAA,QACzB,aAAa;AAAA,MACf,CAAC;AAAA,MACD,GAAG,QAAQ;AAAA,IACb;AACA,WAAO,oBAAoB,aAAa,gBAAgB,OAAO,EAAE;AAAA,EACnE;AAEA,QAAM,kBAAkB,MACtB,YAAY;AAAA,IACV,cAAc,QAAQ;AAAA,IACtB,aAAa;AAAA,IACb,yBAAyB;AAAA,IACzB,aAAa;AAAA,EACf,CAAC;AAEH,QAAM,cAAa,aAAQ,eAAR,YAAsB;AAEzC,QAAM,MAAM,CAAC,EAAE,MAAM,QAAQ,MAAyC;AAxKxE,QAAAA;AAyKI,UAAM,iBACJA,MAAA,QAAQ,YAAR,OAAAA,MAAmB,WAAW,gBAAgB,CAAC;AAEjD,QAAI;AACJ,QAAI,QAAQ,wBAAwB;AAElC,gBAAU,IAAI,IAAI,GAAG,aAAa,gBAAgB,OAAO,GAAG,IAAI,EAAE;AAAA,IACpE,OAAO;AAEL,gBAAU,IAAI,IAAI,GAAG,aAAa,MAAM,IAAI,EAAE;AAAA,IAChD;AAEA,YAAQ,aAAa,IAAI,eAAe,UAAU;AAClD,WAAO,QAAQ,SAAS;AAAA,EAC1B;AAEA,QAAM,kBAAkB,CAAC,mBACvB,IAAI,wBAAwB,gBAAgB;AAAA,IAC1C,UAAU;AAAA,IACV;AAAA,IACA,SAAS;AAAA,IACT,OAAO,QAAQ;AAAA,EACjB,CAAC;AAEH,QAAM,wBAAwB,CAAC,YAC7B,IAAI,8BAA8B,SAAS;AAAA,IACzC,UAAU;AAAA,IACV;AAAA,IACA,SAAS;AAAA,IACT,OAAO,QAAQ;AAAA,EACjB,CAAC;AAEH,QAAM,uBAAuB,CAAC,YAC5B,IAAI,qBAAqB,SAAS;AAAA,IAChC,UAAU;AAAA,IACV,SAAS;AAAA,IACT;AAAA,IACA,OAAO,QAAQ;AAAA,EACjB,CAAC;AAEH,QAAM,uBAAuB,CAAC,YAC5B,IAAI,6BAA6B,SAAS;AAAA,IACxC,UAAU;AAAA,IACV;AAAA,IACA,SAAS;AAAA,IACT,OAAO,QAAQ;AAAA;AAAA,IAEf,gBAAgB,CAAC,YAAY;AAAA,EAC/B,CAAC;AAEH,QAAM,mBAAmB,CAAC,YACxB,IAAI,iBAAiB,SAAS;AAAA,IAC5B,UAAU;AAAA,IACV;AAAA,IACA,SAAS;AAAA,IACT,OAAO,QAAQ;AAAA,EACjB,CAAC;AAEH,QAAM,2BAA2B,CAAC,YAChC,IAAI,yBAAyB,SAAS;AAAA,IACpC,UAAU;AAAA,IACV;AAAA,IACA,SAAS;AAAA,IACT,OAAO,QAAQ;AAAA,EACjB,CAAC;AAEH,QAAM,oBAAoB,CAAC,YACzB,IAAI,kBAAkB,SAAS;AAAA,IAC7B,UAAU;AAAA,IACV;AAAA,IACA,SAAS;AAAA,IACT,OAAO,QAAQ;AAAA,EACjB,CAAC;AAEH,QAAM,WAAW,SAAU,cAAsB;AAC/C,QAAI,YAAY;AACd,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,WAAO,qBAAqB,YAAY;AAAA,EAC1C;AAEA,WAAS,uBAAuB;AAChC,WAAS,gBAAgB;AACzB,WAAS,OAAO;AAChB,WAAS,aAAa;AACtB,WAAS,YAAY;AACrB,WAAS,iBAAiB;AAC1B,WAAS,gBAAgB;AACzB,WAAS,qBAAqB;AAC9B,WAAS,QAAQ;AACjB,WAAS,aAAa;AACtB,WAAS,YAAY;AACrB,WAAS,gBAAgB;AACzB,WAAS,SAAS;AAClB,WAAS,QAAQ;AACjB,SAAO;AACT;AAKO,IAAM,QAAQ,YAAY;","names":["_a"]}
+{"version":3,"sources":["../src/azure-openai-provider.ts","../src/azure-openai-tools.ts","../src/version.ts"],"sourcesContent":["import {\n  OpenAIChatLanguageModel,\n  OpenAICompletionLanguageModel,\n  OpenAIEmbeddingModel,\n  OpenAIImageModel,\n  OpenAIResponsesLanguageModel,\n  OpenAISpeechModel,\n  OpenAITranscriptionModel,\n} from '@ai-sdk/openai/internal';\nimport {\n  InvalidArgumentError,\n  type EmbeddingModelV4,\n  type LanguageModelV4,\n  type ProviderV4,\n  type ImageModelV4,\n  type SpeechModelV4,\n  type TranscriptionModelV4,\n} from '@ai-sdk/provider';\nimport {\n  loadApiKey,\n  loadSetting,\n  normalizeHeaders,\n  withUserAgentSuffix,\n  type FetchFunction,\n} from '@ai-sdk/provider-utils';\nimport { azureOpenaiTools } from './azure-openai-tools';\nimport { VERSION } from './version';\n\nexport interface AzureOpenAIProvider extends ProviderV4 {\n  (deploymentId: string): LanguageModelV4;\n\n  /**\n   * Creates an Azure OpenAI responses API model for text generation.\n   */\n  languageModel(deploymentId: string): LanguageModelV4;\n\n  /**\n   * Creates an Azure OpenAI chat model for text generation.\n   */\n  chat(deploymentId: string): LanguageModelV4;\n\n  /**\n   * Creates an Azure OpenAI responses API model for text generation.\n   */\n  responses(deploymentId: string): LanguageModelV4;\n\n  /**\n   * Creates an Azure OpenAI completion model for text generation.\n   */\n  completion(deploymentId: string): LanguageModelV4;\n\n  /**\n   * Creates an Azure OpenAI model for text embeddings.\n   */\n  embedding(deploymentId: string): EmbeddingModelV4;\n\n  /**\n   * Creates an Azure OpenAI model for text embeddings.\n   */\n  embeddingModel(deploymentId: string): EmbeddingModelV4;\n\n  /**\n   * @deprecated Use `embedding` instead.\n   */\n  textEmbedding(deploymentId: string): EmbeddingModelV4;\n\n  /**\n   * @deprecated Use `embeddingModel` instead.\n   */\n  textEmbeddingModel(deploymentId: string): EmbeddingModelV4;\n\n  /**\n   * Creates an Azure OpenAI DALL-E model for image generation.\n   */\n  image(deploymentId: string): ImageModelV4;\n\n  /**\n   * Creates an Azure OpenAI DALL-E model for image generation.\n   */\n  imageModel(deploymentId: string): ImageModelV4;\n\n  /**\n   * Creates an Azure OpenAI model for audio transcription.\n   */\n  transcription(deploymentId: string): TranscriptionModelV4;\n\n  /**\n   * Creates an Azure OpenAI model for speech generation.\n   */\n  speech(deploymentId: string): SpeechModelV4;\n\n  /**\n   * AzureOpenAI-specific tools.\n   */\n  tools: typeof azureOpenaiTools;\n}\n\nexport interface AzureOpenAIProviderSettings {\n  /**\n   * Name of the Azure OpenAI resource. Either this or `baseURL` can be used.\n   *\n   * The resource name is used in the assembled URL: `https://{resourceName}.openai.azure.com/openai/v1{path}`.\n   */\n  resourceName?: string;\n\n  /**\n   * Use a different URL prefix for API calls, e.g. to use proxy servers. Either this or `resourceName` can be used.\n   * When a baseURL is provided, the resourceName is ignored.\n   *\n   * With a baseURL, the resolved URL is `{baseURL}/v1{path}`.\n   */\n  baseURL?: string;\n\n  /**\n   * API key for authenticating requests.\n   */\n  apiKey?: string;\n\n  /**\n   * A function that returns an access token for Microsoft Entra\n   * (formerly known as Azure Active Directory), which will be invoked\n   * on every request.\n   */\n  tokenProvider?: (() => Promise<string>) | undefined;\n\n  /**\n   * Custom headers to include in the requests.\n   */\n  headers?: Record<string, string>;\n\n  /**\n   * Custom fetch implementation. You can use it as a middleware to intercept requests,\n   * or to provide a custom fetch implementation for e.g. testing.\n   */\n  fetch?: FetchFunction;\n\n  /**\n   * Custom api version to use. Defaults to `preview`.\n   */\n  apiVersion?: string;\n\n  /**\n   * Use deployment-based URLs for specific model types. Set to true to use legacy deployment format:\n   * `{baseURL}/deployments/{deploymentId}{path}?api-version={apiVersion}` instead of\n   * `{baseURL}/v1{path}?api-version={apiVersion}`.\n   */\n  useDeploymentBasedUrls?: boolean;\n}\n\n/**\n * Create an Azure OpenAI provider instance.\n */\nexport function createAzure(\n  options: AzureOpenAIProviderSettings = {},\n): AzureOpenAIProvider {\n  const tokenProvider = options.tokenProvider;\n\n  if (options.apiKey && tokenProvider) {\n    throw new InvalidArgumentError({\n      argument: 'apiKey/tokenProvider',\n      message:\n        'Both apiKey and tokenProvider were provided. Please use only one authentication method.',\n    });\n  }\n\n  const getHeaders = () => {\n    const authHeaders = tokenProvider\n      ? {}\n      : {\n          'api-key': loadApiKey({\n            apiKey: options.apiKey,\n            environmentVariableName: 'AZURE_API_KEY',\n            description: 'Azure OpenAI',\n          }),\n        };\n\n    return withUserAgentSuffix(\n      {\n        ...authHeaders,\n        ...options.headers,\n      },\n      `ai-sdk/azure/${VERSION}`,\n    );\n  };\n\n  const fetch: FetchFunction | undefined = tokenProvider\n    ? async (input, init) => {\n        const headers = normalizeHeaders(init?.headers);\n\n        if (headers.authorization == null) {\n          headers.authorization = `Bearer ${await tokenProvider()}`;\n        }\n\n        return (options.fetch ?? globalThis.fetch)(input, {\n          ...init,\n          headers,\n        });\n      }\n    : options.fetch;\n\n  const getResourceName = () =>\n    loadSetting({\n      settingValue: options.resourceName,\n      settingName: 'resourceName',\n      environmentVariableName: 'AZURE_RESOURCE_NAME',\n      description: 'Azure OpenAI resource name',\n    });\n\n  const apiVersion = options.apiVersion ?? 'v1';\n\n  const url = ({ path, modelId }: { path: string; modelId: string }) => {\n    const baseUrlPrefix =\n      options.baseURL ?? `https://${getResourceName()}.openai.azure.com/openai`;\n\n    let fullUrl: URL;\n    if (options.useDeploymentBasedUrls) {\n      // Use deployment-based format for compatibility with certain Azure OpenAI models\n      fullUrl = new URL(`${baseUrlPrefix}/deployments/${modelId}${path}`);\n    } else {\n      // Use v1 API format - no deployment ID in URL\n      fullUrl = new URL(`${baseUrlPrefix}/v1${path}`);\n    }\n\n    fullUrl.searchParams.set('api-version', apiVersion);\n    return fullUrl.toString();\n  };\n\n  const createChatModel = (deploymentName: string) =>\n    new OpenAIChatLanguageModel(deploymentName, {\n      provider: 'azure.chat',\n      url,\n      headers: getHeaders,\n      fetch,\n    });\n\n  const createCompletionModel = (modelId: string) =>\n    new OpenAICompletionLanguageModel(modelId, {\n      provider: 'azure.completion',\n      url,\n      headers: getHeaders,\n      fetch,\n    });\n\n  const createEmbeddingModel = (modelId: string) =>\n    new OpenAIEmbeddingModel(modelId, {\n      provider: 'azure.embeddings',\n      headers: getHeaders,\n      url,\n      fetch,\n    });\n\n  const createResponsesModel = (modelId: string) =>\n    new OpenAIResponsesLanguageModel(modelId, {\n      provider: 'azure.responses',\n      url,\n      headers: getHeaders,\n      fetch,\n      // Soft-deprecated. TODO: remove in v8\n      fileIdPrefixes: ['assistant-'],\n    });\n\n  const createImageModel = (modelId: string) =>\n    new OpenAIImageModel(modelId, {\n      provider: 'azure.image',\n      url,\n      headers: getHeaders,\n      fetch,\n    });\n\n  const createTranscriptionModel = (modelId: string) =>\n    new OpenAITranscriptionModel(modelId, {\n      provider: 'azure.transcription',\n      url,\n      headers: getHeaders,\n      fetch,\n    });\n\n  const createSpeechModel = (modelId: string) =>\n    new OpenAISpeechModel(modelId, {\n      provider: 'azure.speech',\n      url,\n      headers: getHeaders,\n      fetch,\n    });\n\n  const provider = function (deploymentId: string) {\n    if (new.target) {\n      throw new Error(\n        'The Azure OpenAI model function cannot be called with the new keyword.',\n      );\n    }\n\n    return createResponsesModel(deploymentId);\n  };\n\n  provider.specificationVersion = 'v4' as const;\n  provider.languageModel = createResponsesModel;\n  provider.chat = createChatModel;\n  provider.completion = createCompletionModel;\n  provider.embedding = createEmbeddingModel;\n  provider.embeddingModel = createEmbeddingModel;\n  provider.textEmbedding = createEmbeddingModel;\n  provider.textEmbeddingModel = createEmbeddingModel;\n  provider.image = createImageModel;\n  provider.imageModel = createImageModel;\n  provider.responses = createResponsesModel;\n  provider.transcription = createTranscriptionModel;\n  provider.speech = createSpeechModel;\n  provider.tools = azureOpenaiTools;\n  return provider;\n}\n\n/**\n * Default Azure OpenAI provider instance.\n */\nexport const azure = createAzure();\n","import {\n  codeInterpreter,\n  fileSearch,\n  imageGeneration,\n  webSearch,\n  webSearchPreview,\n} from '@ai-sdk/openai/internal';\n\nexport const azureOpenaiTools: {\n  codeInterpreter: typeof codeInterpreter;\n  fileSearch: typeof fileSearch;\n  imageGeneration: typeof imageGeneration;\n  webSearch: typeof webSearch;\n  webSearchPreview: typeof webSearchPreview;\n} = {\n  codeInterpreter,\n  fileSearch,\n  imageGeneration,\n  webSearch,\n  webSearchPreview,\n};\n","// Version string of this package injected at build time.\ndeclare const __PACKAGE_VERSION__: string | undefined;\nexport const VERSION: string =\n  typeof __PACKAGE_VERSION__ !== 'undefined'\n    ? __PACKAGE_VERSION__\n    : '0.0.0-test';\n"],"mappings":";AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP;AAAA,EACE;AAAA,OAOK;AACP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAEK;;;ACxBP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEA,IAAM,mBAMT;AAAA,EACF;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;;;AClBO,IAAM,UACX,OACI,oBACA;;;AFmJC,SAAS,YACd,UAAuC,CAAC,GACnB;AA1JvB;AA2JE,QAAM,gBAAgB,QAAQ;AAE9B,MAAI,QAAQ,UAAU,eAAe;AACnC,UAAM,IAAI,qBAAqB;AAAA,MAC7B,UAAU;AAAA,MACV,SACE;AAAA,IACJ,CAAC;AAAA,EACH;AAEA,QAAM,aAAa,MAAM;AACvB,UAAM,cAAc,gBAChB,CAAC,IACD;AAAA,MACE,WAAW,WAAW;AAAA,QACpB,QAAQ,QAAQ;AAAA,QAChB,yBAAyB;AAAA,QACzB,aAAa;AAAA,MACf,CAAC;AAAA,IACH;AAEJ,WAAO;AAAA,MACL;AAAA,QACE,GAAG;AAAA,QACH,GAAG,QAAQ;AAAA,MACb;AAAA,MACA,gBAAgB,OAAO;AAAA,IACzB;AAAA,EACF;AAEA,QAAM,QAAmC,gBACrC,OAAO,OAAO,SAAS;AA1L7B,QAAAA;AA2LQ,UAAM,UAAU,iBAAiB,6BAAM,OAAO;AAE9C,QAAI,QAAQ,iBAAiB,MAAM;AACjC,cAAQ,gBAAgB,UAAU,MAAM,cAAc,CAAC;AAAA,IACzD;AAEA,aAAQA,MAAA,QAAQ,UAAR,OAAAA,MAAiB,WAAW,OAAO,OAAO;AAAA,MAChD,GAAG;AAAA,MACH;AAAA,IACF,CAAC;AAAA,EACH,IACA,QAAQ;AAEZ,QAAM,kBAAkB,MACtB,YAAY;AAAA,IACV,cAAc,QAAQ;AAAA,IACtB,aAAa;AAAA,IACb,yBAAyB;AAAA,IACzB,aAAa;AAAA,EACf,CAAC;AAEH,QAAM,cAAa,aAAQ,eAAR,YAAsB;AAEzC,QAAM,MAAM,CAAC,EAAE,MAAM,QAAQ,MAAyC;AAlNxE,QAAAA;AAmNI,UAAM,iBACJA,MAAA,QAAQ,YAAR,OAAAA,MAAmB,WAAW,gBAAgB,CAAC;AAEjD,QAAI;AACJ,QAAI,QAAQ,wBAAwB;AAElC,gBAAU,IAAI,IAAI,GAAG,aAAa,gBAAgB,OAAO,GAAG,IAAI,EAAE;AAAA,IACpE,OAAO;AAEL,gBAAU,IAAI,IAAI,GAAG,aAAa,MAAM,IAAI,EAAE;AAAA,IAChD;AAEA,YAAQ,aAAa,IAAI,eAAe,UAAU;AAClD,WAAO,QAAQ,SAAS;AAAA,EAC1B;AAEA,QAAM,kBAAkB,CAAC,mBACvB,IAAI,wBAAwB,gBAAgB;AAAA,IAC1C,UAAU;AAAA,IACV;AAAA,IACA,SAAS;AAAA,IACT;AAAA,EACF,CAAC;AAEH,QAAM,wBAAwB,CAAC,YAC7B,IAAI,8BAA8B,SAAS;AAAA,IACzC,UAAU;AAAA,IACV;AAAA,IACA,SAAS;AAAA,IACT;AAAA,EACF,CAAC;AAEH,QAAM,uBAAuB,CAAC,YAC5B,IAAI,qBAAqB,SAAS;AAAA,IAChC,UAAU;AAAA,IACV,SAAS;AAAA,IACT;AAAA,IACA;AAAA,EACF,CAAC;AAEH,QAAM,uBAAuB,CAAC,YAC5B,IAAI,6BAA6B,SAAS;AAAA,IACxC,UAAU;AAAA,IACV;AAAA,IACA,SAAS;AAAA,IACT;AAAA;AAAA,IAEA,gBAAgB,CAAC,YAAY;AAAA,EAC/B,CAAC;AAEH,QAAM,mBAAmB,CAAC,YACxB,IAAI,iBAAiB,SAAS;AAAA,IAC5B,UAAU;AAAA,IACV;AAAA,IACA,SAAS;AAAA,IACT;AAAA,EACF,CAAC;AAEH,QAAM,2BAA2B,CAAC,YAChC,IAAI,yBAAyB,SAAS;AAAA,IACpC,UAAU;AAAA,IACV;AAAA,IACA,SAAS;AAAA,IACT;AAAA,EACF,CAAC;AAEH,QAAM,oBAAoB,CAAC,YACzB,IAAI,kBAAkB,SAAS;AAAA,IAC7B,UAAU;AAAA,IACV;AAAA,IACA,SAAS;AAAA,IACT;AAAA,EACF,CAAC;AAEH,QAAM,WAAW,SAAU,cAAsB;AAC/C,QAAI,YAAY;AACd,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,WAAO,qBAAqB,YAAY;AAAA,EAC1C;AAEA,WAAS,uBAAuB;AAChC,WAAS,gBAAgB;AACzB,WAAS,OAAO;AAChB,WAAS,aAAa;AACtB,WAAS,YAAY;AACrB,WAAS,iBAAiB;AAC1B,WAAS,gBAAgB;AACzB,WAAS,qBAAqB;AAC9B,WAAS,QAAQ;AACjB,WAAS,aAAa;AACtB,WAAS,YAAY;AACrB,WAAS,gBAAgB;AACzB,WAAS,SAAS;AAClB,WAAS,QAAQ;AACjB,SAAO;AACT;AAKO,IAAM,QAAQ,YAAY;","names":["_a"]}

package/docs/04-azure.mdx

@@ -46,6 +46,26 @@ const azure = createAzure({
 });
 ```
 
+For Microsoft Entra ID authentication, you can provide a token provider.
+Install `@azure/identity` separately if you want to use its credential helpers:
+
+```ts
+import { createAzure } from '@ai-sdk/azure';
+import {
+  DefaultAzureCredential,
+  getBearerTokenProvider,
+} from '@azure/identity';
+
+const credential = new DefaultAzureCredential();
+const scope = 'https://cognitiveservices.azure.com/.default';
+const tokenProvider = getBearerTokenProvider(credential, scope);
+
+const azure = createAzure({
+  resourceName: 'your-resource-name',
+  tokenProvider,
+});
+```
+
 You can use the following optional settings to customize the OpenAI provider instance:
 
 - **resourceName** _string_
@@ -61,6 +81,11 @@ You can use the following optional settings to customize the OpenAI provider ins
   API key that is being sent using the `api-key` header.
   It defaults to the `AZURE_API_KEY` environment variable.
 
+- **tokenProvider** _() => Promise<string>_
+
+  Microsoft Entra ID token provider that returns an access token to be sent using the `Authorization` header.
+  When provided, this is used instead of `apiKey`.
+
 - **apiVersion** _string_
 
   Sets a custom [api version](https://learn.microsoft.com/en-us/azure/ai-services/openai/api-version-deprecation).
@@ -362,45 +387,56 @@ The following Azure-specific metadata may be returned:
 
 #### Web Search Tool
 
-The Azure OpenAI responses API supports web search(preview) through the `azure.tools.webSearchPreview` tool.
+The Azure OpenAI responses API supports web search through the `azure.tools.webSearch` tool.
 
 ```ts
 const result = await generateText({
-  model: azure('gpt-4.1-mini'),
+  model: azure('gpt-5'),
   prompt: 'What happened in San Francisco last week?',
   tools: {
-    web_search_preview: azure.tools.webSearchPreview({
+    web_search: azure.tools.webSearch({
       // optional configuration:
-      searchContextSize: 'low',
+      searchContextSize: 'high',
       userLocation: {
         type: 'approximate',
         city: 'San Francisco',
         region: 'California',
       },
+      filters: {
+        allowedDomains: ['sfchronicle.com', 'sfgate.com'],
+      },
     }),
   },
   // Force web search tool (optional):
-  toolChoice: { type: 'tool', toolName: 'web_search_preview' },
+  toolChoice: { type: 'tool', toolName: 'web_search' },
 });
 
-console.log(result.text);
-
 // URL sources directly from `results`
 const sources = result.sources;
-for (const source of sources) {
-  console.log('source:', source);
+
+// Or access sources from tool results
+for (const toolResult of result.toolResults) {
+  if (toolResult.toolName === 'web_search') {
+    console.log('Query:', toolResult.output.action.query);
+    console.log('Sources:', toolResult.output.sources);
+    // `sources` is an array of object: { type: 'url', url: string }
+  }
 }
 ```
 
-<Note>
-  The tool must be named `web_search_preview` when using Azure OpenAI's web
-  search(preview) functionality. This name is required by Azure OpenAI's API
-  specification and cannot be customized.
-</Note>
+The web search tool supports the following configuration options:
+
+- **externalWebAccess** _boolean_ - Whether to use external web access for fetching live content. Defaults to `true`.
+- **searchContextSize** _'low' | 'medium' | 'high'_ - Controls the amount of context used for the search. Higher values provide more comprehensive results but may have higher latency and cost.
+- **userLocation** - Optional location information to provide geographically relevant results. Includes `type` (always `'approximate'`), `country`, `city`, `region`, and `timezone`.
+- **filters** - Optional filter configuration to restrict search results.
+  - **allowedDomains** _string[]_ - Array of allowed domains for the search. Subdomains of the provided domains are automatically included.
+
+For detailed information on configuration options see the [Azure OpenAI Web Search Tool documentation](https://learn.microsoft.com/en-us/azure/foundry/openai/how-to/web-search).
 
 <Note>
-  The 'web_search_preview' tool is only supported with the default responses
-  API, and is not supported when using 'azure.chat' or 'azure.completion'
+  On Microsoft Foundry environment , Live internet access is not supported. The
+  parameter `externalWebAccess` if passed will be ignored.
 </Note>
 
 #### File Search Tool

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/azure",
-  "version": "4.0.0-canary.65",
+  "version": "4.0.0-canary.67",
   "type": "module",
   "license": "Apache-2.0",
   "sideEffects": false,
@@ -29,7 +29,7 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/openai": "4.0.0-canary.65",
+    "@ai-sdk/openai": "4.0.0-canary.66",
     "@ai-sdk/provider": "4.0.0-canary.17",
     "@ai-sdk/provider-utils": "5.0.0-canary.44"
   },

package/src/azure-openai-provider.ts

@@ -7,17 +7,19 @@ import {
   OpenAISpeechModel,
   OpenAITranscriptionModel,
 } from '@ai-sdk/openai/internal';
-import type {
-  EmbeddingModelV4,
-  LanguageModelV4,
-  ProviderV4,
-  ImageModelV4,
-  SpeechModelV4,
-  TranscriptionModelV4,
+import {
+  InvalidArgumentError,
+  type EmbeddingModelV4,
+  type LanguageModelV4,
+  type ProviderV4,
+  type ImageModelV4,
+  type SpeechModelV4,
+  type TranscriptionModelV4,
 } from '@ai-sdk/provider';
 import {
   loadApiKey,
   loadSetting,
+  normalizeHeaders,
   withUserAgentSuffix,
   type FetchFunction,
 } from '@ai-sdk/provider-utils';
@@ -114,6 +116,13 @@ export interface AzureOpenAIProviderSettings {
    */
   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.
    */
@@ -144,18 +153,51 @@ export interface AzureOpenAIProviderSettings {
 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 baseHeaders = {
-      'api-key': loadApiKey({
-        apiKey: options.apiKey,
-        environmentVariableName: 'AZURE_API_KEY',
-        description: 'Azure OpenAI',
-      }),
-      ...options.headers,
-    };
-    return withUserAgentSuffix(baseHeaders, `ai-sdk/azure/${VERSION}`);
+    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,
@@ -188,7 +230,7 @@ export function createAzure(
       provider: 'azure.chat',
       url,
       headers: getHeaders,
-      fetch: options.fetch,
+      fetch,
     });
 
   const createCompletionModel = (modelId: string) =>
@@ -196,7 +238,7 @@ export function createAzure(
       provider: 'azure.completion',
       url,
       headers: getHeaders,
-      fetch: options.fetch,
+      fetch,
     });
 
   const createEmbeddingModel = (modelId: string) =>
@@ -204,7 +246,7 @@ export function createAzure(
       provider: 'azure.embeddings',
       headers: getHeaders,
       url,
-      fetch: options.fetch,
+      fetch,
     });
 
   const createResponsesModel = (modelId: string) =>
@@ -212,7 +254,7 @@ export function createAzure(
       provider: 'azure.responses',
       url,
       headers: getHeaders,
-      fetch: options.fetch,
+      fetch,
       // Soft-deprecated. TODO: remove in v8
       fileIdPrefixes: ['assistant-'],
     });
@@ -222,7 +264,7 @@ export function createAzure(
       provider: 'azure.image',
       url,
       headers: getHeaders,
-      fetch: options.fetch,
+      fetch,
     });
 
   const createTranscriptionModel = (modelId: string) =>
@@ -230,7 +272,7 @@ export function createAzure(
       provider: 'azure.transcription',
       url,
       headers: getHeaders,
-      fetch: options.fetch,
+      fetch,
     });
 
   const createSpeechModel = (modelId: string) =>
@@ -238,7 +280,7 @@ export function createAzure(
       provider: 'azure.speech',
       url,
       headers: getHeaders,
-      fetch: options.fetch,
+      fetch,
     });
 
   const provider = function (deploymentId: string) {

package/src/azure-openai-tools.ts

@@ -2,6 +2,7 @@ import {
   codeInterpreter,
   fileSearch,
   imageGeneration,
+  webSearch,
   webSearchPreview,
 } from '@ai-sdk/openai/internal';
 
@@ -9,10 +10,12 @@ export const azureOpenaiTools: {
   codeInterpreter: typeof codeInterpreter;
   fileSearch: typeof fileSearch;
   imageGeneration: typeof imageGeneration;
+  webSearch: typeof webSearch;
   webSearchPreview: typeof webSearchPreview;
 } = {
   codeInterpreter,
   fileSearch,
   imageGeneration,
+  webSearch,
   webSearchPreview,
 };