Azure OpenAI in Microsoft Foundry Models v1 API

In dit artikel leest u hoe u de Azure OpenAI-API van v1 gebruikt. De v1-API vereenvoudigt de verificatie, verwijdert de noodzaak van gedate api-version parameters en ondersteunt modeloproepen tussen providers.

Opmerking

Nieuwe API-antwoordobjecten kunnen op elk gewenst moment worden toegevoegd aan het API-antwoord. U wordt aangeraden alleen de gewenste antwoordobjecten te parseren.

Vereiste voorwaarden

• Een Azure-abonnement - Een gratis abonnement maken
• Een Foundry-resource of Azure OpenAI-resource die is geïmplementeerd in een ondersteunde regio
• Ten minste één modelimplementatie
• Voor Microsoft Entra ID-verificatie: de Cognitive Services OpenAI User rol die aan uw identiteit is toegewezen. Zie Op rollen gebaseerd toegangsbeheer voor Azure OpenAI voor meer informatie

API-evolutie

Voorheen ontving Azure OpenAI maandelijkse updates van nieuwe API-versies. Om nieuwe functies te benutten, was het noodzakelijk om voortdurend code- en omgevingsvariabelen bij te werken met elke nieuwe API-release. Azure OpenAI vereist ook de extra stap van het gebruik van Azure-specifieke clients, wat zorgde voor overhead bij het migreren van code tussen OpenAI en Azure OpenAI.

Vanaf augustus 2025 kunt u zich aanmelden voor de volgende generatie v1 Azure OpenAI-API's die ondersteuning bieden voor:

• Doorlopende toegang tot de nieuwste functies zonder dat u elke maand nieuwe api-versionfuncties hoeft op te geven.
• Snellere API-releasecyclus met nieuwe functies die vaker worden gestart.
• OpenAI-clientondersteuning met minimale codewijzigingen om te wisselen tussen OpenAI en Azure OpenAI bij het gebruik van verificatie op basis van sleutels.
• OpenAI-clientondersteuning voor verificatie op basis van tokens en automatische tokenvernieuwing zonder dat u afhankelijk hoeft te zijn van een afzonderlijke Azure OpenAI-client.
• Voer chat-voltooiingsgesprekken uit met modellen van andere providers, zoals DeepSeek en Grok, die de syntaxis van de v1-chat-voltooiingen ondersteunen.

Toegang tot nieuwe API-aanroepen die nog in preview zijn, wordt beheerd door functiespecifieke preview-headers door te geven, zodat u zich kunt aanmelden bij de gewenste functies, zonder DAT u API-versies hoeft te wisselen. Sommige functies geven ook de preview-status aan via hun API-pad en vereisen geen extra header.

Voorbeelden:

• Wanneer /openai/v1/evals eerder in preview was, was het nodig een "aoai-evals":"preview" header door te geven. /evals is niet meer in voorvertoning.
• /openai/v1/fine_tuning/alpha/graders/ is in preview en vereist geen aangepaste header vanwege de aanwezigheid van alpha in het API-pad.

Voor de eerste algemene beschikbaarstelling van de v1-API worden slechts een subset van de inferentie- en auteur-API-mogelijkheden ondersteund. Alle GA-functies worden ondersteund voor gebruik in productie. Ondersteuning voor meer mogelijkheden wordt snel toegevoegd.

Codewijzigingen

Python

v1 API

Voorbeelden van Python v1

API-sleutel:

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)) 

Belangrijke verschillen met de vorige API:

• OpenAI() wordt gebruikt in plaats van AzureOpenAI().
• base_url geeft het Azure OpenAI-eindpunt door en /openai/v1 wordt toegevoegd aan het eindpuntadres.
• api-version is geen vereiste parameter meer met de V1 GA API.

API-sleutel met omgevingsvariabelen:

Stel de volgende omgevingsvariabelen in voordat u de code uitvoert:

Variable	Waarde
OPENAI_BASE_URL	https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/
OPENAI_API_KEY	Uw Azure OpenAI API-sleutel

Maak vervolgens de client zonder parameters:

client = OpenAI()

Microsoft Entra-id:

Belangrijk

Het automatisch vernieuwen van tokens werd eerder verwerkt via het gebruik van de AzureOpenAI() client. De v1-API verwijdert deze afhankelijkheid door ondersteuning voor automatisch vernieuwen van tokens toe te voegen aan de OpenAI() client.

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 geeft het Azure OpenAI-eindpunt door en /openai/v1 wordt toegevoegd aan het eindpuntadres.
• api_key de parameter is ingesteld op token_provider, waardoor automatisch ophalen en vernieuwen van een verificatietoken wordt ingeschakeld in plaats van een statische API-sleutel te gebruiken.

C#

v1 API

Voorbeelden van C# v1

API-sleutel:

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

Microsoft Entra-id:

#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/"),
    })

JavaScript

v1 API

Voorbeelden van JavaScript v1

API-sleutel:

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

API-sleutel met omgevingsvariabelen ingesteld voor OPENAI_BASE_URL en OPENAI_API_KEY:

const client = new OpenAI();

Microsoft Entra-id:

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
});

Go

v1 API

Go v1-voorbeelden

API-sleutel:

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

API-sleutel met omgevingsvariabelen ingesteld voor OPENAI_BASE_URL en OPENAI_API_KEY:

client := openai.NewClient()

Microsoft Entra-id:

tokenCredential, err := azidentity.NewDefaultAzureCredential(nil)

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

Java

Voorbeelden van Java v1

v1 API

API-sleutel:

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

API-sleutel met omgevingsvariabelen ingesteld voor OPENAI_BASE_URL en OPENAI_API_KEY:

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

Microsoft Entra-id:

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();

REST

v1 API

API-sleutel:

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"
    }'

Microsoft Entra-id:

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"
    }'

Modelondersteuning

Voor Azure OpenAI-modellen raden we u aan om de antwoorden-API te gebruiken, maar met de v1-API kunt u ook chat-voltooiingsoproepen uitvoeren met modellen van andere providers, zoals DeepSeek en Grok, die ondersteuning bieden voor de syntaxis voor voltooiing van de OpenAI v1-chat.

base_url accepteert zowel https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/ als https://YOUR-RESOURCE-NAME.services.ai.azure.com/openai/v1/ formaten.

Opmerking

De antwoorden-API werkt ook met Foundry-modellen die rechtstreeks worden verkocht door Azure, zoals Microsoft AI- en DeepSeek- en Grok-modellen. Zie Hoe u tekstantwoorden genereert met Microsoft Foundry-modellen voor meer informatie over het gebruik van de antwoorden-API voor deze modellen.

Python

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))

C#

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}");

JavaScript

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);

Go

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)
}

Java

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);
        }
    }
}

REST

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?"
      }
    ]
  }'

v1 API-ondersteuning

• v1 OpenAPI 3.0-specificatie

Wijzigingslogboek van API-versie

In de volgende secties worden wijzigingen tussen API-versies samengevat.

Wijzigingen tussen versie v1 preview en 2025-04-01-preview

• v1 preview-API
• Ondersteuning voor het genereren van video's
• NIEUW Api-functies voor antwoorden:
  • Integratie van hulpprogramma's voor REMOTE Model Context Protocol (MCP)-servers
  • Ondersteuning voor asynchrone achtergrondtaken
  • Versleutelde redeneeropgaven
  • Afbeeldingsgeneratie

Wijzigingen tussen 2025-04-01-preview en 2025-03-01-preview

• GPT-image-1 ondersteuning
• Redeneringsoverzicht voor o3 en o4-mini
• Evaluatie-API

Wijzigingen tussen 2025-03-01-preview en 2025-02-01-preview

• Antwoord-API
• Computergebruik

Wijzigingen tussen 2025-02-01-preview en 2025-01-01-preview

• Opgeslagen voltooiingen (ondersteuning voor distillatie-API).

Wijzigingen tussen 2025-01-01-preview en 2024-12-01-preview

• predictionparameter toegevoegd voor ondersteuning voor voorspelde uitvoer.
• gpt-4o-audio-preview modelondersteuning.

Wijzigingen tussen 2024-12-01-preview en 2024-10-01-preview

• store en metadata parameters toegevoegd voor de ondersteuning van opgeslagen voltooiingen.
• reasoning_effort toegevoegd voor de nieuwste redeneringsmodellen.
• user_security_contexttoegevoegd voor Microsoft Defender voor Cloud-integratie.

Wijzigingen tussen 2024-09-01-preview en 2024-08-01-preview

• max_completion_tokens toegevoegd om o1-preview en o1-mini modellen te ondersteunen. max_tokens werkt niet met de o1-seriemodellen .
• parallel_tool_calls toegevoegd.
• completion_tokens_details & reasoning_tokens toegevoegd.
• stream_options & include_usage toegevoegd.

Wijzigingen tussen 2024-07-01-preview en 2024-08-01-preview API-specificatie

• Ondersteuning voor gestructureerde uitvoer.
• Api voor het uploaden van grote bestanden is toegevoegd.
• Wijzigingen in uw gegevens:
  • Mongo DB-integratie.
  • role_information parameter verwijderd.
  • rerank_score toegevoegd aan bronvermeldingsobject.
  • AML-gegevensbron is verwijderd.
  • Verbeteringen in de AI-zoek-vectorisatie-integratie.

Wijzigingen tussen 2024-05-01-preview en 2024-07-01-preview API-specificatie

• Ondersteuning voor Batch-API toegevoegd
• Segmenteringsstrategieparameters voor vectorarchieven
• max_num_results dat het hulpprogramma voor het zoeken van bestanden moet uitvoeren.

Wijzigingen tussen 2024-04-01-preview en 2024-05-01-preview API-specificatie

• Ondersteuning voor assistenten v2 - hulpprogramma voor bestandszoekopdrachten en vectoropslag
• Controlepunten verfijnen, seed, gebeurtenissen
• Uw gegevensupdates
• DALL-E 2 ondersteunt nu modelimplementatie en kan worden gebruikt met de nieuwste preview-API.
• Updates voor inhoudsfilters

Wijzigingen tussen 2024-03-01-preview en 2024-04-01-preview API-specificatie

• Incompatibele wijziging: Verbeteringsparameters zijn verwijderd. Dit heeft invloed op het gpt-4versie:vision-preview model.
• timestamp_granularities parameter toegevoegd.
• audioWord object toegevoegd.
• Aanvullende TTS response_formats: wav & pcm.

Bekende problemen

• De 2025-04-01-preview Azure OpenAI-specificatie maakt gebruik van OpenAPI 3.1. Het is een bekend probleem dat deze versie niet volledig wordt ondersteund door Azure API Management.

Volgende stappen

• Ondersteunde programmeertalen voor de v1-API
• Foundry Models die door Azure rechtstreeks worden verkocht
• Werken met Azure OpenAI-modellen
• Quota en limieten voor Azure OpenAI
• v1 OpenAPI 3.0-specificatie