feat (provider/azure): add OpenAI responses API support

[AVtheking]

Fixes #5346 & #5454

[lgrammel]

@AVtheking have you tested this end-to-end with an Azure setup?

[AVtheking]

no actually I don't have subscription at azure 😞 , Let me see If I can make some arrangements

[AVtheking]

Hi @lgrammel I have tested now with azure setup and it is working fine , also added an example for the responses api. PTAL

[AVtheking]

@lgrammel could you please take a look and let me know any changes required whenever you are free.

[AlexHird]

How would this integrate with the tools provided within the responsesAPI (web search, computer-vision etc)?

[AVtheking]

Yeah I want to discuss that thing (but don't know how and where I could discuss this with maintainers) , one way could be directly importing the tools from the open ai module to this

[AlexHird]

@lgrammel Is this already in the works, or planned, by maintainers?

Personally, I would rather be able to use the openai provider directly by configuring it for AzureOpenAI. Similarly as I'd do it when using the the OpenAI package directly. IE:

import { AzureOpenAI } from "openai";

const deployment = "deployment name";
const apiVersion = "2024-10-21";
const client = new AzureOpenAI({ azureADTokenProvider, deployment, apiVersion });

When using Azure OpenAI Services, it would be fantastic to simply create the OpenAI provider with some additional configurations:

import { createAzureOpenAI } from '@ai-sdk/openai';

const deployment = "deployment name";
const apiVersion = "2024-10-21";

const openai = createAzureOpenAI({
  azureADTokenProvider,
  deployment,
  apiVersion
});

Perhaps that would be easier to work with in the long run?

[lgrammel]

@AVtheking looks pretty good, docs would need updating. Can you add the responses api section from the openai provider docs page to the azure provider docs page (and tweak if necessary)?

• https://github.com/vercel/ai/blob/main/content/providers/01-ai-sdk-providers/0a2-openai.mdx
• https://github.com/vercel/ai/blob/main/content/providers/01-ai-sdk-providers/03-azure.mdx

[AVtheking]

@lgrammel I have updated the doc , PTAL, thanks.

[lgrammel]

Seeing test & type check errors.

[AVtheking]

Fixed those

[miguelvictor]

Can you also add tests to streamText? For some reason, it doesn't work with streamText.

[matthiasmoke]

The provided docs example will result in a null pointer, as the azure provider object does not export a tool property.

    const azure = createAzure({
      resourceName: AZURE_OAI_RESOURCE,
      apiKey: AZURE_OAI_KEY
    })
    const model = azure.responses('insert-deployment-here')
    const result = await generateText({
      model,
      prompt: input,
      tools: {
        web_search_preview: azure.tools.webSearchPreview({
        searchContextSize: 'high',
        userLocation: {
          type: 'approximate',
          city: 'San Francisco',
          region: 'California',
        },
        })
      }
    })

Results in: TypeError: Cannot read properties of undefined (reading 'webSearchPreview')

@AVtheking can you judge whether my usage example is correct? If yes, I suppose this is an issue with the provider.

[AVtheking]

yes you are correct, it doesn't exports tool now.

[matthiasmoke]

Thanks for your response! Do you know any workaround to still enable such tools while using the azure provider?

[AVtheking]

I would raise a PR for this to fix this, if I still has azure creds, or you can do it buddy, I can also help you

[matthiasmoke]

havent tested it yet, but I think its resolved 😄 #8238