如何在 OpenAI 和 Azure OpenAI 终结点之间切换

虽然 OpenAI 和 Azure OpenAI 依赖于常见的 Python 客户端库，但需要对代码进行少量更改，以便在终结点之间来回切换。新的统一 OpenAI v1 聊天完成终结点无需单独的 Azure 特定代码路径。

OpenAI
Azure OpenAI

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.getenv("OPENAI_API_KEY")
)

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

Microsoft Entra 身份验证

Microsoft Entra 身份验证仅受 Azure OpenAI 资源支持。完成以下步骤：

安装 Azure 标识客户端库：
```
pip install azure-identity
```

按如下所示配置 OpenAI 客户端对象：

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

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

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

小窍门

DefaultAzureCredential 可以针对运行应用的环境进行优化。有关详细信息，请参阅如何自定义 DefaultAzureCredential。

分配适当的 Azure 基于角色的访问控制（RBAC）权限。有关详细信息，请参阅 Azure 基于角色的访问控制（RBAC）。

在 Azure 上运行时，将角色分配给 Azure 主机资源使用的托管身份。在本地开发环境中运行时，将角色分配给运行应用的用户。

OpenAI
Azure OpenAI

using OpenAI;
using System;
using System.ClientModel;

string apiKey = Environment.GetEnvironmentVariable("OPENAI_API_KEY");
OpenAIClient client = new(new ApiKeyCredential(apiKey));

using OpenAI;
using System;
using System.ClientModel;

// code omitted for brevity

OpenAIClientOptions clientOptions = new()
{
    Endpoint = new Uri($"{resourceEndpoint}/openai/v1/")
};

string apiKey = Environment.GetEnvironmentVariable("AZURE_OPENAI_API_KEY");
OpenAIClient client = new(new ApiKeyCredential(apiKey), clientOptions);

Microsoft Entra 身份验证

Microsoft Entra 身份验证仅受 Azure OpenAI 资源支持。完成以下步骤：

安装 Azure 标识客户端库：
```
dotnet add package Azure.Identity
```

配置 OpenAIClient 对象如下：

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

// code omitted for brevity

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

OpenAIClientOptions clientOptions = new()
{
    Endpoint = new Uri($"{resourceEndpoint}/openai/v1/")
};

OpenAIClient client = new(tokenPolicy, clientOptions);

小窍门

DefaultAzureCredential 可以针对运行应用的环境进行优化。有关详细信息，请参阅如何自定义 DefaultAzureCredential。

分配适当的 Azure 基于角色的访问控制（RBAC）权限。有关详细信息，请参阅 Azure 基于角色的访问控制（RBAC）。

在 Azure 上运行时，将角色分配给 Azure 主机资源使用的托管身份。在本地开发环境中运行时，将角色分配给运行应用的用户。

OpenAI
Azure OpenAI

import { OpenAI } from "openai";
import "dotenv/config";

const apiKey = process.env["OPENAI_API_KEY"];

if (!endpoint) {
  throw new Error("Please set the OPENAI_API_KEY environment variable.");
}

const client = new OpenAI({ apiKey });

import { OpenAI } from "openai";
import "dotenv/config";

const endpoint = process.env["AZURE_OPENAI_ENDPOINT"];

if (!endpoint) {
  throw new Error("Please set the AZURE_OPENAI_ENDPOINT environment variable.");
}

const apiKey = process.env["AZURE_OPENAI_API_KEY"];

if (!apiKey) {
  throw new Error("Please set the AZURE_OPENAI_API_KEY environment variable.");
}

const client = new OpenAI({ baseURL: endpoint + "/openai/v1", apiKey });

Microsoft Entra 身份验证

Microsoft Entra 身份验证仅受 Azure OpenAI 资源支持。完成以下步骤：

安装 Azure 标识客户端库：
```
npm install @azure/identity
```

按如下所示配置 OpenAI 客户端对象：

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

const endpoint = process.env["AZURE_OPENAI_ENDPOINT"];

if (!endpoint) {
  throw new Error("Please set the AZURE_OPENAI_ENDPOINT environment variable.");
}

const scope = "https://cognitiveservices.azure.com/.default";
const azureADTokenProvider = getBearerTokenProvider(new DefaultAzureCredential(), scope);
const client = new OpenAI({ baseURL: endpoint + "/openai/v1", apiKey: azureADTokenProvider });

小窍门

DefaultAzureCredential 可以针对运行应用的环境进行优化。有关详细信息，请参阅如何自定义 DefaultAzureCredential。

分配适当的 Azure 基于角色的访问控制（RBAC）权限。有关详细信息，请参阅 Azure 基于角色的访问控制（RBAC）。

在 Azure 上运行时，将角色分配给 Azure 主机资源使用的托管身份。在本地开发环境中运行时，将角色分配给运行应用的用户。

OpenAI
Azure OpenAI

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;

public class OpenAISample {

    public static void main(String[] args) {
        OpenAIClient openAIClient = OpenAIOkHttpClient.builder()
                .apiKey(System.getenv("OPENAI_API_KEY"))
                .build();
    }
}

import com.openai.azure.credential.AzureApiKeyCredential;
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;

public class AzureOpenAISample {

    public static void main(String[] args) {
        OpenAIClient azureOpenAIClient = OpenAIOkHttpClient.builder()
                .baseUrl(System.getenv("AZURE_OPENAI_ENDPOINT"))
                .credential(AzureApiKeyCredential.create(System.getenv("AZURE_OPENAI_API_KEY")))
                .build();
    }
}

Microsoft Entra 身份验证

Microsoft Entra 身份验证仅受 Azure OpenAI 资源支持。完成以下步骤：

在项目中包括 azure-identity 依赖项。

配置 OpenAIClient 对象如下：

import com.azure.identity.AuthenticationUtil;
import com.azure.identity.DefaultAzureCredential;
import com.azure.identity.DefaultAzureCredentialBuilder;
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.credential.BearerTokenCredential;

import java.util.function.Supplier;

public class AzureOpenAISample {

    public static void main(String[] args) {
        DefaultAzureCredential tokenCredential = new DefaultAzureCredentialBuilder().build();
        Supplier<String> bearerTokenSupplier = AuthenticationUtil.getBearerTokenSupplier(
                tokenCredential, "https://cognitiveservices.azure.com/.default");
        OpenAIClient azureOpenAIClient = OpenAIOkHttpClient.builder()
                .fromEnv()
                // Set the Azure Entra ID
                .credential(BearerTokenCredential.create(bearerTokenSupplier))
                .build();
    }
}

小窍门

DefaultAzureCredential 可以针对运行应用的环境进行优化。有关详细信息，请参阅如何自定义 DefaultAzureCredential。

分配适当的 Azure 基于角色的访问控制（RBAC）权限。有关详细信息，请参阅 Azure 基于角色的访问控制（RBAC）。

在 Azure 上运行时，将角色分配给 Azure 主机资源使用的托管身份。在本地开发环境中运行时，将角色分配给运行应用的用户。

OpenAI
Azure OpenAI

// import (
//    "github.com/openai/openai-go/v3"
//    "github.com/openai/openai-go/v3/option"
// )

client := openai.NewClient(
    option.WithAPIKey(os.Getenv("OPENAI_API_KEY")),
)

// import (
//    "github.com/openai/openai-go/v3"
//    "github.com/openai/openai-go/v3/azure"
//    "github.com/openai/openai-go/v3/option"
// )

client := openai.NewClient(
    option.WithBaseURL("https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/"),
    azure.WithAPIKey(os.Getenv("AZURE_OPENAI_API_KEY")),
)

Microsoft Entra 身份验证

Microsoft Entra 身份验证仅受 Azure OpenAI 资源支持。完成以下步骤：

在项目中包括 azure-identity 依赖项。

配置 OpenAIClient 对象如下：

// import (
//    "github.com/openai/openai-go/v3"
//    "github.com/openai/openai-go/v3/azure"
//    "github.com/openai/openai-go/v3/option"
// )

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

小窍门

DefaultAzureCredential 可以针对运行应用的环境进行优化。有关详细信息，请参阅如何自定义 DefaultAzureCredential。

分配适当的 Azure 基于角色的访问控制（RBAC）权限。有关详细信息，请参阅 Azure 基于角色的访问控制（RBAC）。

在 Azure 上运行时，将角色分配给 Azure 主机资源使用的托管身份。在本地开发环境中运行时，将角色分配给运行应用的用户。

OpenAI 使用 model 关键字参数指定要使用的模型。 Azure OpenAI 具有唯一模型部署的概念。使用 Azure OpenAI 时， model 应引用部署模型时选择的基础部署名称。

重要

Azure OpenAI 和 OpenAI 在 API 调用中以不同的方式处理模型名称。 OpenAI 只需要模型名称。即使使用模型参数，Azure OpenAI 也始终需要部署名称。调用 Azure OpenAI API 时，必须使用部署名称而不是模型名称。我们的文档通常显示与模型名称匹配的部署名称，以显示哪个模型适用于每个 API 终结点。选择任何最适合你的部署名称的命名约定。

OpenAI
Azure OpenAI

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

chat_completion = client.chat.completions.create(
    model="gpt-4o", 
    messages="<messages>"
)

embedding = client.embeddings.create(
    model="text-embedding-3-large", 
    input="<input>"
)

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

chat_completion = client.chat.completions.create(
    model="gpt-4o", # model = "deployment_name".
    messages="<messages>"
)

embedding = client.embeddings.create(
    model="text-embedding-3-large", # model = "deployment_name".
    input="<input>"
)

OpenAI 使用 model 参数来指定要使用的模型。 Azure OpenAI 具有唯一模型部署的概念。使用 Azure OpenAI 时， model 应引用部署模型时选择的基础部署名称。

重要

Azure OpenAI 和 OpenAI 在 API 调用中以不同的方式处理模型名称。 OpenAI 只需要模型名称。即使使用模型参数，Azure OpenAI 也始终需要部署名称。调用 Azure OpenAI API 时，必须使用部署名称而不是模型名称。我们的文档通常显示与模型名称匹配的部署名称，以显示哪个模型适用于每个 API 终结点。选择任何最适合你的部署名称的命名约定。

OpenAI
Azure OpenAI

string modelName = "gpt-4.1-nano";
OpenAIResponseClient response = client.GetOpenAIResponseClient(modelName);

modelName = "gpt-4o";
ChatClient chatCompletion = client.GetChatClient(modelName);

modelName = "text-embedding-3-large";
EmbeddingClient embedding = client.GetEmbeddingClient(modelName);

string deploymentName = "my-gpt-4.1-nano-deployment";
OpenAIResponseClient response = client.GetOpenAIResponseClient(deploymentName);

deploymentName = "my-gpt-4o-deployment";
ChatClient chatCompletion = client.GetChatClient(deploymentName);

deploymentName = "my-text-embedding-3-large-deployment";
EmbeddingClient embedding = client.GetEmbeddingClient(deploymentName);

OpenAI 使用 model 关键字参数指定要使用的模型。 Azure OpenAI 具有唯一模型部署的概念。使用 Azure OpenAI 时， model 应引用部署模型时选择的基础部署名称。

重要

Azure OpenAI 和 OpenAI 在 API 调用中以不同的方式处理模型名称。 OpenAI 只需要模型名称。即使使用模型参数，Azure OpenAI 也始终需要部署名称。调用 Azure OpenAI API 时，必须使用部署名称而不是模型名称。我们的文档通常显示与模型名称匹配的部署名称，以显示哪个模型适用于每个 API 终结点。选择任何最适合你的部署名称的命名约定。

OpenAI
Azure OpenAI

const response = await client.responses.create({
  model: "gpt-4.1-nano",
  input: "This is a test",
});

const chatCompletions = await client.chat.completions.create({
  model: "gpt-4o",
  messages: ["<messages>"],
});

const embeddings = await client.embeddings.create({
  model: "text-embedding-3-large",
  input: "<input>",
});

const response = await client.responses.create({
  model: "gpt-4.1-nano", // Replace with your model deployment name 
  input: "This is a test",
});

const chatCompletions = await client.chat.completions.create({
  model: "gpt-4o", // Replace with your model deployment name 
  messages: ["<messages>"],
});

const embeddings = await client.embeddings.create({
  model: "text-embedding-3-large", // Replace with your model deployment name
  input: "<input>",
});

OpenAI 使用 model 关键字参数指定要使用的模型。 Azure OpenAI 具有唯一模型部署的概念。使用 Azure OpenAI 时， model 应引用部署模型时选择的基础部署名称。

重要

Azure OpenAI 和 OpenAI 在 API 调用中以不同的方式处理模型名称。 OpenAI 只需要模型名称。即使使用模型参数，Azure OpenAI 也始终需要部署名称。调用 Azure OpenAI API 时，必须使用部署名称而不是模型名称。我们的文档通常显示与模型名称匹配的部署名称，以显示哪个模型适用于每个 API 终结点。选择任何最适合你的部署名称的命名约定。

OpenAI
Azure OpenAI

ResponseCreateParams responseCreateParams = ResponseCreateParams.builder()
        .input("This is a test")
        .model(ChatModel.GPT_4_1_NANO)
        .build();

Response response = client.responses().create(responseCreateParams);

ChatCompletionCreateParams chatCompletionCreateParams = ChatCompletionCreateParams.builder()
        .model(ChatModel.GPT_4O)
        .addUserMessage("<message>")
        .build();

ChatCompletion chatCompletion = client.chat().completions().create(chatCompletionCreateParams);

EmbeddingCreateParams embeddingCreateParams = EmbeddingCreateParams.builder()
        .input("<input>")
        .model(EmbeddingModel.TEXT_EMBEDDING_3_LARGE)
        .build();

CreateEmbeddingResponse createEmbeddingResponse = client.embeddings().create(embeddingCreateParams);

ResponseCreateParams responseCreateParams = ResponseCreateParams.builder()
        .input("This is a test")
        .model(ChatModel.GPT_4_1_NANO) // Replace with your model deployment name 
        .build();

Response response = client.responses().create(responseCreateParams);

ChatCompletionCreateParams chatCompletionCreateParams = ChatCompletionCreateParams.builder()
        .model(ChatModel.GPT_4O) // Replace with your model deployment name
        .addUserMessage("<message>")
        .build();

ChatCompletion chatCompletion = client.chat().completions().create(chatCompletionCreateParams);

EmbeddingCreateParams embeddingCreateParams = EmbeddingCreateParams.builder()
        .input("<input>")
        .model(EmbeddingModel.TEXT_EMBEDDING_3_LARGE) // Replace with your model deployment name
        .build();

CreateEmbeddingResponse createEmbeddingResponse = client.embeddings().create(embeddingCreateParams);

OpenAI 使用 Model 关键字参数指定要使用的模型。 Azure OpenAI 具有唯一模型部署的概念。使用 Azure OpenAI 时， Model 应引用部署模型时选择的基础部署名称。

重要

Azure OpenAI 和 OpenAI 在 API 调用中以不同的方式处理模型名称。 OpenAI 只需要模型名称。即使使用模型参数，Azure OpenAI 也始终需要部署名称。调用 Azure OpenAI API 时，必须使用部署名称而不是模型名称。我们的文档通常显示与模型名称匹配的部署名称，以显示哪个模型适用于每个 API 终结点。选择任何最适合你的部署名称的命名约定。

OpenAI
Azure OpenAI

resp, err := client.Responses.New(context.TODO(), responses.ResponseNewParams{
    Model: "gpt-4.1-nano", 
    Input: responses.ResponseNewParamsInputUnion{
        OfString: openai.String("This is a test."),
    },
})

resp, err := client.Chat.Completions.New(context.TODO(), openai.ChatCompletionNewParams{
    Model: "gpt-4o", 
    Messages: []openai.ChatCompletionMessageParamUnion{
        // messages
    },
})

resp, err := client.Embeddings.New(context.TODO(), openai.EmbeddingNewParams{
    Model: "text-embedding-3-large", 
    Input: openai.EmbeddingNewParamsInputUnion{
        OfString: openai.String("<input>"),
    },
})

resp, err := client.Responses.New(context.TODO(), responses.ResponseNewParams{
    Model: "gpt-4.1-nano", // Replace with your model deployment name
    Input: responses.ResponseNewParamsInputUnion{
        OfString: openai.String("This is a test."),
    },
})

resp, err := client.Chat.Completions.New(context.TODO(), openai.ChatCompletionNewParams{
    Model: "gpt-4o", // Model = "deployment_name"
    Messages: []openai.ChatCompletionMessageParamUnion{
        // messages
    },
})

resp, err := client.Embeddings.New(context.TODO(), openai.EmbeddingNewParams{
    Model: "text-embedding-3-large", // Model = "deployment_name"
    Input: openai.EmbeddingNewParamsInputUnion{
        OfString: openai.String("<input>"),
    },
})

OpenAI
Azure OpenAI

inputs = ["A", "B", "C"] 

embedding = client.embeddings.create(
    input=inputs,
    model="text-embedding-3-large"
)

inputs = ["A", "B", "C"] #max array size=2048

embedding = client.embeddings.create(
    input=inputs,
    model="my-text-embedding-3-large-deployment" # This must match the custom deployment name you chose for your model.
    # engine="text-embedding-ada-002"
)

OpenAI
Azure OpenAI

string[] inputs = [ "A", "B", "C" ];

EmbeddingClient embedding = client.GetEmbeddingClient(
    model: "text-embedding-3-large"
).GenerateEmbedding(
    input: inputs
);

string[] inputs = [ "A", "B", "C" ]; //max array size=2048

EmbeddingClient embedding = client.GetEmbeddingClient(
    model: "my-text-embedding-3-large-deployment" // This must match the custom deployment name you chose for your model.
    // engine:"text-embedding-ada-002"
).GenerateEmbedding(
    input: inputs
);

OpenAI
Azure OpenAI

const embeddings = await client.embeddings.create({
    model: "text-embedding-3-large",
    inputs: ["A", "B", "C"],
})

const embeddings = await client.embeddings.create({
    model: "text-embedding-3-large",
    inputs: ["A", "B", "C"],
})

OpenAI
Azure OpenAI

EmbeddingCreateParams embeddingCreateParams = EmbeddingCreateParams.builder()
        .inputOfArrayOfStrings(List.of("A", "B", "C"))
        .model(EmbeddingModel.TEXT_EMBEDDING_3_LARGE)
        .build();

CreateEmbeddingResponse createEmbeddingResponse = client.embeddings().create(embeddingCreateParams);

EmbeddingCreateParams embeddingCreateParams = EmbeddingCreateParams.builder()
        .inputOfArrayOfStrings(List.of("A", "B", "C"))
        .model(EmbeddingModel.TEXT_EMBEDDING_3_LARGE)
        .build();

CreateEmbeddingResponse createEmbeddingResponse = client.embeddings().create(embeddingCreateParams);

OpenAI
Azure OpenAI

resp, err := client.Embeddings.New(context.TODO(), openai.EmbeddingNewParams{
    Model: "text-embedding-3-large",
    Input: openai.EmbeddingNewParamsInputUnion{
        OfArrayOfStrings: []string{"A", "B", "C"},
    },
})

resp, err := client.Embeddings.New(context.TODO(), openai.EmbeddingNewParams{
    Model: "text-embedding-3-large",
    Input: openai.EmbeddingNewParamsInputUnion{
        OfArrayOfStrings: []string{"A", "B", "C"},
    },
})

通过

如何在 OpenAI 和 Azure OpenAI 终结点之间切换

Authentication

API 密钥身份验证

Microsoft Entra 身份验证

Microsoft Entra 身份验证

Microsoft Entra 身份验证

Microsoft Entra 身份验证

Microsoft Entra 身份验证

指定模型

Azure OpenAI 嵌入多个输入支持

反馈

其他资源