Azure OpenAI na API do Microsoft Foundry Models v1

Este artigo mostra como usar a API do OpenAI Azure v1. A API v1 simplifica a autenticação, remove a necessidade de parâmetros datados api-version e dá suporte a chamadas de modelo entre provedores.

Observação

Novos objetos de resposta de API podem ser adicionados à resposta da API a qualquer momento. Recomendamos que você analise apenas os objetos de resposta necessários.

Pré-requisitos

Uma assinatura Azure – Criar uma gratuitamente
Um recurso Foundry ou OpenAI do Azure recurso implantado em uma região compatível
Pelo menos uma implantação de modelo
Para autenticação do Microsoft Entra ID: a função Cognitive Services OpenAI User atribuída à sua identidade. Para obter mais informações, consulte Controle de acesso baseado em função para Azure OpenAI

Evolução da API

Anteriormente, Azure OpenAI recebia atualizações mensais de novas versões de API. Aproveitar os novos recursos exigia atualizar constantemente o código e as variáveis de ambiente a cada nova versão da API. Azure OpenAI também exigiu a etapa extra de usar Azure clientes específicos que criaram sobrecarga ao migrar código entre OpenAI e Azure OpenAI.

A partir de agosto de 2025, você pode optar pela próxima geração v1 Azure APIs OpenAI que adicionam suporte para:

Acesso contínuo aos recursos mais recentes, sem necessidade de especificar novos api-versiona cada mês.
Ciclo de lançamento de API mais rápido com novos recursos sendo iniciados com mais frequência.
Suporte para o cliente OpenAI com alterações mínimas de código para alternar entre OpenAI e Azure OpenAI ao usar a autenticação por chave.
Suporte ao cliente OpenAI para autenticação baseada em token e atualização automática de token sem a necessidade de assumir uma dependência em um cliente OpenAI Azure separado.
Faça chamadas de conclusão de chat com modelos de outros provedores, como DeepSeek e Grok, que dão suporte à sintaxe de conclusões de chat v1.

Acesso às novas chamadas de API que ainda estão em versão prévia será controlado passando cabeçalhos de pré-visualização específicos das funcionalidades, permitindo que você opte pelas funcionalidades desejadas, sem precisar alterar as versões da API. Opcionalmente, alguns recursos indicarão o status de versão prévia por meio de seu caminho de API e não exigirão um cabeçalho adicional.

Exemplos:

Quando /openai/v1/evals estava em versão preliminar, era necessário incluir um cabeçalho "aoai-evals":"preview". /evals não está mais em versão prévia.
/openai/v1/fine_tuning/alpha/graders/ está em versão prévia e não requer nenhum cabeçalho personalizado devido à presença de alpha no caminho da API.

Para o lançamento inicial da API GA (Disponibilidade Geral) v1, há suporte apenas para um subconjunto das capacidades de inferência e criação da API. Todos os recursos de GA têm suporte para uso em produção. O suporte para mais recursos está sendo adicionado rapidamente.

Alterações de código

API v1

Exemplos do Python v1

Chave de API:

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),
    base_url="https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/"
)

response = client.responses.create(   
  model="gpt-4.1-nano", # Replace with your model deployment name 
  input="This is a test.",
)

print(response.model_dump_json(indent=2))

Principais diferenças da API anterior:

OpenAI() o cliente é usado em vez de AzureOpenAI().
base_url passa pelo endpoint do Azure OpenAI e /openai/v1 é acrescentado ao endereço do endpoint.
api-version não é mais um parâmetro necessário com a API de GA v1.

Chave de API com variáveis de ambiente:

Defina as seguintes variáveis de ambiente antes de executar o código:

Variable	Valor
`OPENAI_BASE_URL`	`https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`
`OPENAI_API_KEY`	Sua chave de API openai do Azure

Em seguida, crie o cliente sem parâmetros:

client = OpenAI()

ID do Microsoft Entra:

Importante

O tratamento da atualização automática de token foi tratado anteriormente por meio do uso do cliente AzureOpenAI(). A API v1 remove essa dependência adicionando suporte automático de atualização de token ao cliente OpenAI().

from openai import OpenAI
from azure.identity import DefaultAzureCredential, get_bearer_token_provider

token_provider = get_bearer_token_provider(
    DefaultAzureCredential(), "https://ai.azure.com/.default"
)

client = OpenAI(  
  base_url = "https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/",  
  api_key = token_provider  
)

response = client.responses.create(
    model="gpt-4.1-nano",
    input= "This is a test" 
)

print(response.model_dump_json(indent=2))

base_url passa pelo endpoint do Azure OpenAI e /openai/v1 é acrescentado ao endereço do endpoint.
api_key o parâmetro é definido como token_provider, habilitando a recuperação automática e a atualização de um token de autenticação em vez de usar uma chave de API estática.

API v1

Exemplos do C# v1

Chave de API:

OpenAIClient client = new(
    new ApiKeyCredential("{your-api-key}"),
    new OpenAIClientOptions()
    {
        Endpoint = new("https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/"),
    })

ID do Microsoft Entra:

#pragma warning disable OPENAI001

BearerTokenPolicy tokenPolicy = new(
    new DefaultAzureCredential(),
    "https://ai.azure.com/.default");
OpenAIClient client = new(
    authenticationPolicy: tokenPolicy,
    options: new OpenAIClientOptions()
    {
        Endpoint = new("https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/"),
    })

API v1

Exemplos do JavaScript v1

Chave de API:

const client = new OpenAI({
    baseURL: "https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/",
    apiKey: "{your-api-key}" 
});

Chave de API com variáveis de ambiente definidas para OPENAI_BASE_URL e OPENAI_API_KEY:

const client = new OpenAI();

ID do Microsoft Entra:

const tokenProvider = getBearerTokenProvider(
    new DefaultAzureCredential(),
    'https://ai.azure.com/.default');
const client = new OpenAI({
    baseURL: "https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/",
    apiKey: tokenProvider
});

API v1

Exemplos do Go v1

Chave de API:

client := openai.NewClient(
    option.WithBaseURL("https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/"),
    option.WithAPIKey("{your-api-key}")
)

Chave de API com variáveis de ambiente definidas para OPENAI_BASE_URL e OPENAI_API_KEY:

client := openai.NewClient()

ID do Microsoft Entra:

tokenCredential, err := azidentity.NewDefaultAzureCredential(nil)

client := openai.NewClient(
    option.WithBaseURL("https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/"),
    azure.WithTokenCredential(tokenCredential)
)

Exemplos do Java v1

API v1

Chave de API:


OpenAIClient client = OpenAIOkHttpClient.builder()
                .baseUrl("https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/")
                .apiKey(apiKey)
                .build();

Chave de API com variáveis de ambiente definidas para OPENAI_BASE_URL e OPENAI_API_KEY:

OpenAIClient client = OpenAIOkHttpClient.builder()
                .fromEnv()
                .build();

ID do Microsoft Entra:

Credential tokenCredential = BearerTokenCredential.create(
        AuthenticationUtil.getBearerTokenSupplier(
                new DefaultAzureCredentialBuilder().build(),
                "https://ai.azure.com/.default"));
OpenAIClient client = OpenAIOkHttpClient.builder()
        .baseUrl("https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/")
        .credential(tokenCredential)
        .build();

API v1

Chave de API:

curl -X POST https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/responses \
  -H "Content-Type: application/json" \
  -H "api-key: $AZURE_OPENAI_API_KEY" \
  -d '{
     "model": "gpt-4.1-nano",
     "input": "This is a test"
    }'

ID do Microsoft Entra:

curl -X POST https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $AZURE_OPENAI_AUTH_TOKEN" \
  -d '{
     "model": "gpt-4o",
     "input": "This is a test"
    }'

Suporte ao modelo

Para Azure modelos OpenAI, recomendamos usar a API Responses, no entanto, a API v1 também permite que você faça chamadas de conclusão de chat com modelos de outros provedores, como DeepSeek e Grok, que dão suporte à sintaxe de conclusões de chat do OpenAI v1.

base_url aceitará formatos https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/ e https://YOUR-RESOURCE-NAME.services.ai.azure.com/openai/v1/.

Observação

A API de Respostas também funciona com Modelos Foundry vendidos diretamente pela Azure, como os modelos de IA da Microsoft, DeepSeek e Grok. Para saber como usar a API de Respostas com esses modelos, confira Como gerar respostas de texto com modelos do Microsoft Foundry.

from openai import OpenAI
from azure.identity import DefaultAzureCredential, get_bearer_token_provider

token_provider = get_bearer_token_provider(
    DefaultAzureCredential(), "https://ai.azure.com/.default"
)

client = OpenAI(  
  base_url = "https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/",  
  api_key=token_provider,
)
completion = client.chat.completions.create(
  model="MAI-DS-R1", # Replace with your model deployment name.
  messages=[
    {"role": "system", "content": "You are a helpful assistant."},
    {"role": "user", "content": "Tell me about the attention is all you need paper"}
  ]
)

#print(completion.choices[0].message)
print(completion.model_dump_json(indent=2))

using Azure.Identity;
using OpenAI;
using OpenAI.Chat;
using System.ClientModel.Primitives;

#pragma warning disable OPENAI001

BearerTokenPolicy tokenPolicy = new(
    new DefaultAzureCredential(),
    "https://ai.azure.com/.default");

ChatClient client = new(
    model: "MAI-DS-R1", // Replace with your model deployment name.
    authenticationPolicy: tokenPolicy,
    options: new OpenAIClientOptions() { 
    
        Endpoint = new Uri("https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1")
   }
);

ChatCompletion completion = client.CompleteChat("Tell me about the attention is all you need paper");

Console.WriteLine($"[ASSISTANT]: {completion.Content[0].Text}");

import { DefaultAzureCredential, getBearerTokenProvider } from "@azure/identity";
import { OpenAI } from "openai";

const tokenProvider = getBearerTokenProvider(
    new DefaultAzureCredential(),
    'https://ai.azure.com/.default');
const client = new OpenAI({
    baseURL: "https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/",
    apiKey: tokenProvider
});

const messages = [
    { role: 'system', content: 'You are a helpful assistant.' },
    { role: 'user', content: 'Tell me about the attention is all you need paper' }
];

// Make the API request with top-level await
const result = await client.chat.completions.create({ 
    messages, 
    model: 'MAI-DS-R1', // model deployment name
    max_tokens: 100 
});

// Print the full response
console.log('Full response:', result);

// Print just the message content from the response
console.log('Response content:', result.choices[0].message.content);


package main

import (
	"context"
	"fmt"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/openai/openai-go/v3"
	"github.com/openai/openai-go/v3/azure"
	"github.com/openai/openai-go/v3/option"
)

func main() {
	// Create an Azure credential
	tokenCredential, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("Failed to create credential: %s", err)
	}

	// Create a client with Azure OpenAI endpoint and token credential
	client := openai.NewClient(
		option.WithBaseURL("https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/"),
		azure.WithTokenCredential(tokenCredential),
	)

	// Make a completion request
	chatCompletion, err := client.Chat.Completions.New(context.TODO(), openai.ChatCompletionNewParams{
		Messages: []openai.ChatCompletionMessageParamUnion{
			openai.UserMessage("Explain what the bitter lesson is?"),
		},
		Model: "MAI-DS-R1", // Use your deployed model name on Azure
	})
	if err != nil {
		log.Fatalf("Failed to get chat completions: %s", err)
	}

	fmt.Println(chatCompletion.Choices[0].Message.Content)
}

package com.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.ChatModel;
import com.openai.models.chat.completions.ChatCompletion;
import com.openai.models.chat.completions.ChatCompletionCreateParams;

public class OpenAITest {
    public static void main(String[] args) {
        // Get API key from environment variable for security
        String apiKey = System.getenv("OPENAI_API_KEY");
        String resourceName = "https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1";
        String modelDeploymentName = "MAI-DS-R1"; //replace with your model deployment name

        try {
            OpenAIClient client = OpenAIOkHttpClient.builder()
                    .baseUrl(resourceName)
                    .apiKey(apiKey)
                    .build();

           ChatCompletionCreateParams params = ChatCompletionCreateParams.builder()
              .addUserMessage("Explain what the bitter lesson is?")
              .model(modelDeploymentName)
              .build();
           ChatCompletion chatCompletion = client.chat().completions().create(params);
        }
    }
}

curl -X POST https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $AZURE_OPENAI_AUTH_TOKEN" \
  -d '{
      "model": "MAI-DS-R1",
      "messages": [
      {
        "role": "developer",
        "content": "You are a helpful assistant."
      },
      {
        "role": "user",
        "content": "Explain what the bitter lesson is?"
      }
    ]
  }'

Suporte de API v1

especificação v1 OpenAPI 3.0

Registro de alterações da versão da API

As seções a seguir resumem as alterações entre as versões da API.

Alterações entre a versão prévia da v1 e a versão 2025-04-01-preview

API de visualização v1
Suporte à geração de vídeo
NOVOS Recursos da API de Respostas:
- Integração de ferramentas de servidores MCP (protocolo de contexto remoto)
- Suporte para tarefas em segundo plano assíncronas
- Itens de raciocínio criptografados
- Geração de imagem

Alterações entre 2025-04-01-preview e 2025-03-01-preview

GPT-image-1 suporte
Resumo do raciocínio para o3 e o4-mini
API de Avaliação

Alterações entre 2025-03-01-preview e 2025-02-01-preview

API de respostas
Uso do computador

Alterações entre 2025-02-01-preview e 2025-01-01-preview

Completamentos armazenados (suporte à API de destilação).

Alterações entre 2025-01-01-preview e 2024-12-01-preview

Parâmetro prediction adicionado para suporte a saídas previstas.
gpt-4o-audio-preview suporte a modelo.

Alterações entre 2024-12-01-preview e 2024-10-01-preview

store, e parâmetros metadata adicionados para suporte a conclusões armazenadas.
reasoning_effort adicionado aos modelos de raciocínio mais recentes.
user_security_context adicionado à Integração do Microsoft Defender para Nuvem.

Alterações entre 2024-09-01-preview e 2024-08-01-preview

max_completion_tokens adicionado para dar suporte aos modelos o1-preview e o1-mini. max_tokens não funciona com os modelos da série o1.
parallel_tool_calls adicionado
Adicionados completion_tokens_details e reasoning_tokens.
Adicionados stream_options e include_usage.

Alterações entre as especificações das APIs 2024-07-01-preview e 2024-08-01-preview

Suporte a saídas estruturadas.
Adicionada a API para upload de arquivos grandes.
Em suas alterações de dados:
- Integração do Mongo DB.
- Parâmetro role_information removido.
- rerank_score adicionado ao objeto de citação.
- Fonte de dados do AML removida.
- Melhorias na integração de vetorização da Pesquisa de IA.

Alterações entre a especificação da API 2024-05-01-preview e 2024-07-01-preview

Suporte à API em lote adicionado
parâmetros de estratégia de segmentação do armazenamento Vector
max_num_results que a ferramenta de pesquisa de arquivos deve gerar.

Alterações entre as especificações das APIs 2024-04-01-preview e 2024-05-01-preview

Suporte a assistentes v2 – Ferramenta de busca de arquivos e armazenamento de vetor
Pontos de verificação de ajuste fino, sementes, eventos
Nas suas atualizações de dados
O DALL-E 2 já dá suporte à implantação do modelo e pode ser usado com a API de versão prévia mais recente.
Atualizações de filtragem de conteúdo

Alterações entre as especificações das APIs 2024-03-01-preview e 2024-04-01-preview

Alteração Interruptiva: Parâmetros de aprimoramentos removidos. Isso afeta o modelo gpt-4Versão:vision-preview.
timestamp_granularities parâmetro adicionado.
audioWord objeto adicionado.
TTS response_formats: wav & pcm adicionais.

Problemas conhecidos

A especificação 2025-04-01-preview Azure OpenAI usa OpenAPI 3.1. É um problema conhecido que essa versão não é totalmente compatível com Azure API Management.

Próximas etapas

Comentários

Esta página foi útil?

Last updated on 2026-03-20

Compartilhar via

Azure OpenAI na API do Microsoft Foundry Models v1

Pré-requisitos

Evolução da API

Alterações de código

API v1

Suporte ao modelo

Suporte de API v1

Registro de alterações da versão da API

Alterações entre a versão prévia da v1 e a versão 2025-04-01-preview

Alterações entre 2025-04-01-preview e 2025-03-01-preview

Alterações entre 2025-03-01-preview e 2025-02-01-preview

Alterações entre 2025-02-01-preview e 2025-01-01-preview

Alterações entre 2025-01-01-preview e 2024-12-01-preview

Alterações entre 2024-12-01-preview e 2024-10-01-preview

Alterações entre 2024-09-01-preview e 2024-08-01-preview

Alterações entre as especificações das APIs 2024-07-01-preview e 2024-08-01-preview

Alterações entre a especificação da API 2024-05-01-preview e 2024-07-01-preview

Alterações entre as especificações das APIs 2024-04-01-preview e 2024-05-01-preview

Alterações entre as especificações das APIs 2024-03-01-preview e 2024-04-01-preview

Problemas conhecidos

Próximas etapas

Comentários

Recursos adicionais