AzureOpenAI

警告

您当前所在的页面记录了使用 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 完成模型 (LLMs)。有关 AzureOpenAI 功能和配置选项的详细文档，请参阅API 参考。

概述

集成细节

类	包	本地	可序列化	PY 支持	包下载	包最新
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 LANGCHAIN_TRACING_V2="true"
# export LANGCHAIN_API_KEY="your-api-key"

安装

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

提示

请参阅本节以获取有关安装集成包的一般说明。

npm
yarn
pnpm

npm i @langchain/openai

yarn add @langchain/openai

pnpm add @langchain/openai

实例化

现在我们可以实例化我们的模型对象并生成聊天完成内容

import { AzureOpenAI } from "@langchain/openai";

const llm = new AzureOpenAI({
  model: "gpt-3.5-turbo-instruct",
  azureOpenAIApiKey: "<your_key>", // In Node.js defaults to process.env.AZURE_OPENAI_API_KEY
  azureOpenAIApiInstanceName: "<your_instance_name>", // In Node.js defaults to process.env.AZURE_OPENAI_API_INSTANCE_NAME
  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
  temperature: 0,
  maxTokens: undefined,
  timeout: undefined,
  maxRetries: 2,
  // other params...
});

调用

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.

链接

我们可以链接我们的完成模型和提示模板，如下所示

import { PromptTemplate } from "@langchain/core/prompts";

const prompt = new PromptTemplate({
  template: "How to say {input} in {output_language}:\n",
  inputVariables: ["input", "output_language"],
});

const chain = prompt.pipe(llm);
await chain.invoke({
  output_language: "German",
  input: "I love programming.",
});


Ich liebe Programmieren.

使用 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>", // 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
});

从 Azure OpenAI SDK 迁移

如果您使用的是 @langchain/azure-openai 包的已弃用的 Azure OpenAI SDK，您可以按照以下步骤更新您的代码以使用新的 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 参考：https://api.js.langchain.com/classes/langchain_openai.AzureOpenAI.html

LLM 概念指南
LLM 操作指南

AzureOpenAI

概述

集成细节

设置

凭据

安装

实例化

调用

链接

使用 Azure 托管标识

使用不同的域

从 Azure OpenAI SDK 迁移

API 参考

此页面对您有帮助吗？

您也可以留下详细的反馈在 GitHub 上.

概述​

集成细节​

设置​

凭据​

安装​

实例化​

调用​

链接​

使用 Azure 托管标识​

使用不同的域​

从 Azure OpenAI SDK 迁移​

API 参考​

相关​

此页面对您有帮助吗？

您也可以留下详细的反馈 在 GitHub 上.

概述

集成细节

设置

凭据

安装

实例化

调用

链接

使用 Azure 托管标识

使用不同的域

从 Azure OpenAI SDK 迁移

API 参考

相关

您也可以留下详细的反馈在 GitHub 上.