Azure OpenAI 集成

您当前正在查看的是关于使用 Azure OpenAI 文本补全模型的文档。最新且最受欢迎的 Azure OpenAI 模型是聊天补全模型。除非您特别使用 gpt-3.5-turbo-instruct，否则您可能需要的是此页面。

此前，LangChain.js 使用专用的 Azure OpenAI SDK 支持与 Azure OpenAI 的集成。该 SDK 现已弃用，转而支持 OpenAI SDK 中的新 Azure 集成，该集成允许在 OpenAI 模型和功能发布当天即可访问，并支持在 OpenAI API 和 Azure OpenAI 之间无缝切换。如果您正在使用已弃用的 SDK 与 Azure OpenAI，请参阅迁移指南以更新到新 API。

Azure OpenAI 是一项 Microsoft Azure 服务，提供来自 OpenAI 的强大语言模型。这将帮助您开始使用 LangChain 的 AzureOpenAI 补全模型（LLM）。有关 AzureOpenAI 功能和配置选项的详细文档，请参阅 API 参考。

概述

集成详情

类	包	本地	可序列化	Python 支持	下载量	版本
`AzureOpenAI`	`@langchain/openai`	❌	✅	✅

设置

要访问 AzureOpenAI 模型，您需要创建一个 Azure 帐户、获取 API 密钥，并安装 @langchain/openai 集成包。

凭据

前往 azure.microsoft.com 注册 AzureOpenAI 并生成 API 密钥。您还需要部署一个 Azure OpenAI 实例。您可以按照此指南在 Azure 门户上部署一个版本。一旦您的实例运行起来，请确保您拥有实例的名称和密钥。您可以在 Azure 门户中实例的“密钥和终结点”部分找到密钥。如果您使用的是 Node.js，可以定义以下环境变量来使用该服务：

AZURE_OPENAI_API_INSTANCE_NAME=<YOUR_INSTANCE_NAME>
AZURE_OPENAI_API_DEPLOYMENT_NAME=<YOUR_DEPLOYMENT_NAME>
AZURE_OPENAI_API_KEY=<YOUR_KEY>
AZURE_OPENAI_API_VERSION="2024-02-01"

或者，您可以将值直接传递给 AzureOpenAI 构造函数。如果您想获得模型调用的自动跟踪，也可以取消注释以下内容来设置您的 LangSmith API 密钥：

# export LANGSMITH_TRACING="true"
# export LANGSMITH_API_KEY="your-api-key"

安装

LangChain AzureOpenAI 集成位于 @langchain/openai 包中：

npm install @langchain/openai @langchain/core

yarn add @langchain/openai @langchain/core

pnpm add @langchain/openai @langchain/core

实例化

现在我们可以实例化模型对象并生成聊天补全：

import { AzureOpenAI } from "@langchain/openai"

const llm = new AzureOpenAI({
  model: "gpt-3.5-turbo-instruct",
  azureOpenAIApiKey: "<your_key>", // 在 Node.js 中默认为 process.env.AZURE_OPENAI_API_KEY
  azureOpenAIApiInstanceName: "<your_instance_name>", // 在 Node.js 中默认为 process.env.AZURE_OPENAI_API_INSTANCE_NAME
  azureOpenAIApiDeploymentName: "<your_deployment_name>", // 在 Node.js 中默认为 process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME
  azureOpenAIApiVersion: "<api_version>", // 在 Node.js 中默认为 process.env.AZURE_OPENAI_API_VERSION
  temperature: 0,
  maxTokens: undefined,
  timeout: undefined,
  maxRetries: 2,
  // 其他参数...
})

调用

const inputText = "AzureOpenAI is an AI company that "

const completion = await llm.invoke(inputText)
completion

provides AI solutions to businesses. They offer a range of services including natural language processing, computer vision, and machine learning. Their solutions are designed to help businesses automate processes, gain insights from data, and improve decision-making. AzureOpenAI also offers consulting services to help businesses identify and implement the best AI solutions for their specific needs. They work with a variety of industries, including healthcare, finance, and retail. With their expertise in AI and their partnership with Microsoft Azure, AzureOpenAI is a trusted provider of AI solutions for businesses looking to stay ahead in the rapidly evolving world of technology.

使用 Azure 托管标识

如果您使用的是 Azure 托管标识，可以这样配置凭据：

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

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

const managedIdentityLLM = new AzureOpenAI({
  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 { AzureOpenAI } from "@langchain/openai";

const differentDomainLLM = new AzureOpenAI({
  azureOpenAIApiKey: "<your_key>", // 在 Node.js 中默认为 process.env.AZURE_OPENAI_API_KEY
  azureOpenAIApiDeploymentName: "<your_deployment_name>", // 在 Node.js 中默认为 process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME
  azureOpenAIApiVersion: "<api_version>", // 在 Node.js 中默认为 process.env.AZURE_OPENAI_API_VERSION
  azureOpenAIBasePath:
    "https://westeurope.api.microsoft.com/openai/deployments", // 在 Node.js 中默认为 process.env.AZURE_OPENAI_BASE_PATH
});

从 Azure OpenAI SDK 迁移

如果您正在使用已弃用的 Azure OpenAI SDK 与 @langchain/azure-openai 包，可以按照以下步骤更新代码以使用新的 Azure 集成：

安装新的 @langchain/openai 包并移除之前的 @langchain/azure-openai 包：
npm install @langchain/openai npm uninstall @langchain/azure-openai
更新您的导入，以使用来自 @langchain/openai 包的新 AzureOpenAI 和 AzureChatOpenAI 类：
import { AzureOpenAI } from "@langchain/openai";
更新您的代码以使用新的 AzureOpenAI 和 AzureChatOpenAI 类，并传递所需的参数：
const model = new AzureOpenAI({ 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 参考

有关所有 AzureOpenAI 功能和配置的详细文档，请前往 API 参考。

将这些文档通过 MCP 连接到 Claude、VSCode 等，以获取实时答案。

在 GitHub 上编辑此页面或提交问题。

Popular Providers

General integrations

RAG integrations

概述

集成详情

设置

凭据

安装

实例化

调用

使用 Azure 托管标识

使用不同的域名

从 Azure OpenAI SDK 迁移

API 参考

​概述

​集成详情

​设置

​凭据

​安装

​实例化

​调用

​使用 Azure 托管标识

​使用不同的域名

​从 Azure OpenAI SDK 迁移

​API 参考

概述

集成详情

设置

凭据

安装

实例化

调用

使用 Azure 托管标识

使用不同的域名

从 Azure OpenAI SDK 迁移

API 参考