Azure OpenAI 是微软 Azure 的一项服务，提供来自 OpenAI 的强大语言模型。 本文将帮助您快速上手 AzureChatOpenAI 聊天模型。有关所有 AzureChatOpenAI 功能和配置的详细文档，请参阅 API 参考。

​
概述

​
集成详情

类包可序列化Python 支持下载量版本
AzureChatOpenAI@langchain/openai✅✅NPM - DownloadsNPM - Version

​
模型功能

请查看下方表头中的链接，了解如何使用特定功能的指南。
工具调用结构化输出图像输入音频输入视频输入令牌级流式传输令牌使用对数概率
✅✅✅❌❌✅✅✅

​
设置

Azure OpenAI 是一项云服务，帮助您借助来自 OpenAI、Meta 等提供的多样预构建和精选模型，快速开发生成式 AI 体验。 LangChain.js 支持通过 OpenAI SDK 中的新 Azure 集成与 Azure OpenAI 进行集成。 您可以在此页面了解更多关于 Azure OpenAI 及其与 OpenAI API 区别的信息。

​
凭证

如果您没有 Azure 账户，可以创建免费账户开始使用。 您还需要部署一个 Azure OpenAI 实例。可以按照此指南在 Azure 门户上部署一个版本。 实例运行后，请确保您拥有实例的名称和密钥。您可以在 Azure 门户中实例的“密钥和终结点”部分找到密钥。然后，如果使用 Node.js，您可以将凭据设置为环境变量： 
AZURE_OPENAI_API_INSTANCE_NAME=<您的实例名称>
AZURE_OPENAI_API_DEPLOYMENT_NAME=<您的部署名称>
AZURE_OPENAI_API_KEY=<您的密钥>
AZURE_OPENAI_API_VERSION="2024-02-01"
如果您希望自动跟踪模型调用，还可以取消注释以下内容来设置您的 LangSmith API 密钥： 
# export LANGSMITH_TRACING="true"
# export LANGSMITH_API_KEY="your-api-key"

​
安装

LangChain 的 AzureChatOpenAI 集成位于 @langchain/openai 包中： 
npm install @langchain/openai @langchain/core

​
实例化

现在我们可以实例化模型对象并生成聊天补全： 
import { AzureChatOpenAI } from "@langchain/openai"

const llm = new AzureChatOpenAI({
    model: "gpt-5.4",
    temperature: 0,
    maxTokens: undefined,
    maxRetries: 2,
    azureOpenAIApiKey: process.env.AZURE_OPENAI_API_KEY, // In Node.js defaults to process.env.AZURE_OPENAI_API_KEY
    azureOpenAIApiInstanceName: process.env.AZURE_OPENAI_API_INSTANCE_NAME, // In Node.js defaults to process.env.AZURE_OPENAI_API_INSTANCE_NAME
    azureOpenAIApiDeploymentName: process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME, // In Node.js defaults to process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME
    azureOpenAIApiVersion: process.env.AZURE_OPENAI_API_VERSION, // In Node.js defaults to process.env.AZURE_OPENAI_API_VERSION
})

​
调用

const aiMsg = await llm.invoke([
    [
        "system",
        "You are a helpful assistant that translates English to French. Translate the user sentence.",
    ],
    ["human", "I love programming."],
])
aiMsg

AIMessage {
  "id": "chatcmpl-9qrWKByvVrzWMxSn8joRZAklHoB32",
  "content": "J'adore la programmation.",
  "additional_kwargs": {},
  "response_metadata": {
    "tokenUsage": {
      "completionTokens": 8,
      "promptTokens": 31,
      "totalTokens": 39
    },
    "finish_reason": "stop"
  },
  "tool_calls": [],
  "invalid_tool_calls": [],
  "usage_metadata": {
    "input_tokens": 31,
    "output_tokens": 8,
    "total_tokens": 39
  }
}

console.log(aiMsg.content)

J'adore la programmation.

​
使用 Azure 托管标识

如果您使用 Azure 托管标识，可以按以下方式配置凭据： 
import {
  DefaultAzureCredential,
  getBearerTokenProvider,
} from "@azure/identity";
import { AzureChatOpenAI } from "@langchain/openai";

const credentials = new DefaultAzureCredential();
const azureADTokenProvider = getBearerTokenProvider(
  credentials,
  "https://cognitiveservices.azure.com/.default"
);

const llmWithManagedIdentity = new AzureChatOpenAI({
  azureADTokenProvider,
  azureOpenAIApiInstanceName: "<your_instance_name>",
  azureOpenAIApiDeploymentName: "<your_deployment_name>",
  azureOpenAIApiVersion: "<api_version>",
});

​
使用不同域名

如果您的实例托管在非默认域名 openai.azure.com 下，您需要使用替代的 AZURE_OPENAI_BASE_PATH 环境变量。 例如，以下是连接到域名 https://westeurope.api.microsoft.com/openai/deployments/{DEPLOYMENT_NAME} 的方法： 
import { AzureChatOpenAI } from "@langchain/openai";

const llmWithDifferentDomain = new AzureChatOpenAI({
  temperature: 0.9,
  azureOpenAIApiKey: "<your_key>", // In Node.js defaults to process.env.AZURE_OPENAI_API_KEY
  azureOpenAIApiDeploymentName: "<your_deployment_name>", // In Node.js defaults to process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME
  azureOpenAIApiVersion: "<api_version>", // In Node.js defaults to process.env.AZURE_OPENAI_API_VERSION
  azureOpenAIBasePath:
    "https://westeurope.api.microsoft.com/openai/deployments", // In Node.js defaults to process.env.AZURE_OPENAI_BASE_PATH
});

​
自定义头

您可以通过传入 configuration 字段来指定自定义头： 
import { AzureChatOpenAI } from "@langchain/openai";

const llmWithCustomHeaders = new AzureChatOpenAI({
  azureOpenAIApiKey: process.env.AZURE_OPENAI_API_KEY, // In Node.js defaults to process.env.AZURE_OPENAI_API_KEY
  azureOpenAIApiInstanceName: process.env.AZURE_OPENAI_API_INSTANCE_NAME, // In Node.js defaults to process.env.AZURE_OPENAI_API_INSTANCE_NAME
  azureOpenAIApiDeploymentName: process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME, // In Node.js defaults to process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME
  azureOpenAIApiVersion: process.env.AZURE_OPENAI_API_VERSION, // In Node.js defaults to process.env.AZURE_OPENAI_API_VERSION
  configuration: {
    defaultHeaders: {
      "x-custom-header": `SOME_VALUE`,
    },
  },
});

await llmWithCustomHeaders.invoke("Hi there!");
configuration 字段还接受官方 SDK 支持的其他 ClientOptions 参数。 注意： 特定的 api-key 头目前无法通过此方式覆盖，它将沿用 azureOpenAIApiKey 的值。

​
从 Azure OpenAI SDK 迁移

如果您正在使用已弃用的 Azure OpenAI SDK 以及 @langchain/azure-openai 包，可以按照以下步骤更新代码以使用新的 Azure 集成：
  1. 安装新的 @langchain/openai 包并移除之前的 @langchain/azure-openai 包：
npm install @langchain/openai

npm uninstall @langchain/azure-openai
  1. 更新导入语句，使用来自 @langchain/openai 包的新版 AzureChatOpenAI 类： 
    import { AzureChatOpenAI } from "@langchain/openai";
  2. 更新代码，使用新版 AzureChatOpenAI 类并传递所需参数： 
    const model = new AzureChatOpenAI({
  azureOpenAIApiKey: "<your_key>",
  azureOpenAIApiInstanceName: "<your_instance_name>",
  azureOpenAIApiDeploymentName: "<your_deployment_name>",
  azureOpenAIApiVersion: "<api_version>",
});
    请注意，构造函数现在需要 azureOpenAIApiInstanceName 参数而不是 azureOpenAIEndpoint 参数，并添加了 azureOpenAIApiVersion 参数来指定 API 版本。
    • 如果您之前使用的是 Azure 托管标识，现在需要使用 azureADTokenProvider 参数而不是 credentials 传递给构造函数，详情参见 Azure 托管标识 部分。
    • 如果您之前使用的是环境变量，现在需要设置 AZURE_OPENAI_API_INSTANCE_NAME 环境变量而不是 AZURE_OPENAI_API_ENDPOINT，并添加 AZURE_OPENAI_API_VERSION 环境变量来指定 API 版本。

​
API 参考

有关所有 AzureChatOpenAI 功能和配置的详细文档，请访问 API 参考。
Connect these docs to Claude, VSCode, and more via MCP for real-time answers.
Edit this page on GitHub or file an issue.