Azure OpenAI в API Microsoft Foundry Models версии 1 (классическая версия)

В настоящее время просмотр:Версия портала Foundry (классическая версия) - Переключиться на версию для нового портала Foundry

Примечание

Содержание в новой документации Microsoft Foundry может открываться по ссылкам в этой статье вместо документации Foundry (классической версии), которую вы просматриваете сейчас.

В этой статье показано, как использовать API OpenAI версии 1 Azure. API версии 1 упрощает проверку подлинности, удаляет потребность в устаревших api-version параметрах и поддерживает вызовы модели между поставщиками.

Примечание

Новые объекты ответа API могут добавляться в ответ API в любое время. Рекомендуется анализировать только необходимые объекты ответа.

Необходимые условия

• Подписка Azure — Создайте бесплатно
• Ресурс Foundry или ресурс Azure OpenAI, развернутый в поддерживаемом регионе
• По крайней мере одно развертывание модели
• Для проверки подлинности Microsoft Entra ID: роль Cognitive Services OpenAI User, назначенная вашему удостоверению. Дополнительные сведения см. в статье Управление доступом на основе ролей для Azure OpenAI

Эволюция API

Ранее Azure OpenAI получила ежемесячные обновления новых версий API. Воспользоваться новыми функциями требовало постоянного обновления кода и переменных среды с каждым новым выпуском API. Azure OpenAI также требует дополнительного этапа использования специфических клиентов Azure, вносящих дополнительные накладные расходы при переносе кода между OpenAI и Azure OpenAI.

Начиная с августа 2025 г. вы можете принять участие в следующем поколении версии 1 Azure API OpenAI, которые добавляют поддержку:

• Постоянный доступ к новейшим функциям без необходимости указывать новые api-version каждый месяц.
• Более быстрый цикл выпуска API с новыми функциями, запускаемыми чаще.
• Поддержка клиента OpenAI с минимальными изменениями кода для переключения между OpenAI и Azure OpenAI при использовании проверки подлинности на основе ключей.
• Поддержка клиента OpenAI для аутентификации на основе токенов и автоматического обновления токенов без необходимости зависеть от отдельного клиента Azure OpenAI.
• Используйте модели других поставщиков, таких как DeepSeek и Grok, которые поддерживают синтаксис завершения чата версии 1, для вызовов завершения чата.

Доступ к новым вызовам API, которые по-прежнему находятся в предварительной версии, будет контролироваться путем передачи определенных заголовков предварительной версии функций, позволяющих использовать нужные функции без необходимости переключать версии API. Кроме того, некоторые функции будут указывать состояние предварительного просмотра через путь к API и не требуют дополнительного заголовка.

Примеры:

• Когда /openai/v1/evals был в предварительной версии, требовалась передача заголовка "aoai-evals":"preview". /evals больше не находится в предварительной версии.
• /openai/v1/fine_tuning/alpha/graders/ находится в предварительной версии и не требует пользовательского заголовка из-за наличия alpha в пути API.

Для первоначального запуска API версии 1 (GA) поддерживается только ограниченный набор возможностей API для предсказания и создания. Все GA-функции поддерживаются для использования в производственной среде. Быстро внедряется поддержка дополнительных возможностей.

Изменения кода

Python

API версии 1

примеры Python версии 1

Ключ 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)) 

Основные отличия от предыдущего API:

• OpenAI() клиент используется вместо AzureOpenAI().
• base_url передает конечную точку OpenAI Azure и /openai/v1 добавляется к адресу конечной точки.
• api-version больше не является обязательным параметром с API общедоступной версии 1.

Ключ API с переменными среды:

Задайте следующие переменные среды перед выполнением кода:

Переменная	Значение
OPENAI_BASE_URL	https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/
OPENAI_API_KEY	Ключ API Azure OpenAI

Затем создайте клиент без параметров:

client = OpenAI()

Microsoft Entra ID:

Важно

Обработка автоматического обновления токенов AzureOpenAI() ранее происходила с использованием клиента. API версии 1 устраняет эту зависимость, добавляя поддержку автоматического обновления токенов в клиенте 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 передает конечную точку OpenAI Azure и /openai/v1 добавляется к адресу конечной точки.
• api_key параметр устанавливается в token_provider, что позволяет автоматически извлекать и обновлять токен аутентификации вместо использования статического API-ключа.

C#

API версии 1

Примеры C# версии 1

Ключ API:

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

API версии 1

Примеры JavaScript версии 1

Ключ API:

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

Ключ API с заданными переменными среды для OPENAI_BASE_URL и 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
});

Иди

API версии 1

Примеры Go версии 1

Ключ API:

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

Ключ API с заданными переменными среды для OPENAI_BASE_URL и 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

примеры Java версии 1

API версии 1

Ключ API:

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

Ключ API с заданными переменными среды для OPENAI_BASE_URL и 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

API версии 1

Ключ 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"
    }'

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

Поддержка модели

Для моделей OpenAI Azure мы рекомендуем использовать API Responses API, однако API версии 1 также позволяет выполнять вызовы завершения чата с моделями других поставщиков, таких как DeepSeek и Grok, которые поддерживают синтаксис завершения чата OpenAI версии 1.

base_url будет принимать оба https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/ формата и https://YOUR-RESOURCE-NAME.services.ai.azure.com/openai/v1/ форматы.

Примечание

API для ответов также работает с моделями Foundry, проданными непосредственно через Azure, такими как модели Microsoft AI, DeepSeek и Grok. Сведения об использовании API ответов с этими моделями см. в статье How to create text responses with Microsoft Foundry Models.

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

Иди

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

Поддержка API версии 1

• v1 Спецификация OpenAPI 3.0

Журнал изменений версий API

В следующих разделах перечислены изменения между версиями API.

Изменения между предварительной версией версии 1 и 2025-04-01-preview

• API предварительной версии 1
• Поддержка создания видео
• НОВЫЕ ФУНКЦИИ Функции API ответов:
  • Интеграция инструментов с серверами протокола контекста удаленной модели (MCP)
  • Поддержка асинхронных фоновых задач
  • Зашифрованные элементы логического мышления
  • Создание образа

Изменения между 2025-04-01-preview и 2025-03-01-preview

• GPT-image-1 Поддержка
• Сводка по обоснованию для o3 и o4-mini
• API оценки

Изменения между 2025-03-01-preview и 2025-02-01-preview

• API ответов
• Использование компьютера

Изменения между 2025-02-01-preview и 2025-01-01-preview

• Хранимые результаты (поддержка API для дистилляции).

Изменения между 2025-01-01-preview и 2024-12-01-preview

• prediction параметр, добавленный для поддержки прогнозируемых выходных данных .
• gpt-4o-audio-preview поддержка модели.

Изменения между 2024-12-01-preview и 2024-10-01-preview

• store, и metadata параметры, добавленные для поддержки хранимых операций завершения.
• reasoning_effort добавлена последняя модель причин.
• добавлен для интеграции Microsoft Defender для облака.

Изменения между 2024-09-01-preview и 2024-08-01-preview

• max_completion_tokens добавлена поддержка моделей o1-preview и o1-mini. max_tokens не работает с моделями серии o1 .
• parallel_tool_calls Добавили.
• Добавлены completion_tokens_details и reasoning_tokens.
• Добавлены stream_options и include_usage.

Изменения между спецификацией API 2024-07-01-preview и 2024-08-01-preview API

• Поддержка структурированных выходных данных.
• Добавлен API отправки больших файлов.
• Изменения ваших данных:
  • Интеграция с Mongo DB.
  • role_information удален параметр.
  • rerank_score добавлен в объект ссылки.
  • Удален источник данных AML.
  • Улучшения интеграции векторизации поиска ИИ.

Изменения между спецификацией API 2024-05-01-preview и 2024-07-01-preview

• Добавлена поддержка пакетного API
• Параметры стратегии сегментации хранилища векторов
• max_num_results что должно выводить средство поиска файлов.

Изменения в спецификации API между 2024-04-01-preview и 2024-05-01-preview

• Поддержка помощников версии 2— средство поиска файлов и векторное хранилище
• Настройка контрольных точек, seed, событий
• Обновления данных
• DALL-E 2 теперь поддерживает развертывание модели и может использоваться с последними предварительными версиями API.
• Обновления фильтрации содержимого

Изменения между спецификацией API 2024-03-01-preview и 2024-04-01-preview API

• Критическое изменение: удалены параметры улучшения. Это влияет на модель gpt-4версии:vision-preview.
• добавлен параметр timestamp_granularities.
• добавлен объект audioWord.
• Дополнительные TTS response_formats: wav & pcm.

Известные проблемы

• Спецификация OpenAI 2025-04-01-preview Azure использует OpenAPI 3.1. Известно, что эта версия не полностью поддерживается Azure API Management.

Дальнейшие действия

• Поддерживаемые языки программирования для API версии 1
• Модели Foundry, продаваемые непосредственно Azure
• Работка с Azure моделями OpenAI
• Квоты и ограничения Azure OpenAI
• v1 Спецификация OpenAPI 3.0