Skip to main content
Open In ColabOpen on GitHub

Azure OpenAI

注意

您当前所在的页面记录了 Azure OpenAI 文本补全模型 的使用。最新且最受欢迎的 Azure OpenAI 模型是 聊天补全模型。

除非你明确地在使用 gpt-3.5-turbo-instruct，否则你可能想找的是这个页面。

此页面介绍了如何将 LangChain 与 Azure OpenAI 一起使用。

Azure OpenAI API 与 OpenAI 的 API 兼容。openai Python 包可以轻松地同时使用 OpenAI 和 Azure OpenAI。除了下文提到的例外情况外，你可以像调用 OpenAI 一样来调用 Azure OpenAI。

API 配置​

您可以使用环境变量配置 openai 包以使用 Azure OpenAI。以下是针对 bash 的配置：

# The API version you want to use: set this to `2023-12-01-preview` for the released version.
export OPENAI_API_VERSION=2023-12-01-preview
# The base URL for your Azure OpenAI resource.  You can find this in the Azure portal under your Azure OpenAI resource.
export AZURE_OPENAI_ENDPOINT=https://your-resource-name.openai.azure.com
# The API key for your Azure OpenAI resource.  You can find this in the Azure portal under your Azure OpenAI resource.
export AZURE_OPENAI_API_KEY=<your Azure OpenAI API key>

您也可以在正在运行的Python环境中直接配置该API：

import os
os.environ["OPENAI_API_VERSION"] = "2023-12-01-preview"

Azure Active Directory 身份验证​

有两种方式可以对 Azure OpenAI 进行身份验证：

  • API 密钥
  • Azure Active Directory (AAD)

使用API密钥是开始使用的最简单方法。您可以在Azure门户中您的Azure OpenAI资源下找到您的API密钥。

然而，如果你有复杂的安全需求——你可能希望使用 Azure Active Directory。你可以点击此处了解如何将 AAD 与 Azure OpenAI 配合使用。

如果您在本地进行开发，则需要安装 Azure CLI 并登录。您可以在此处 这里 安装 Azure CLI。然后，运行 az login 进行登录。

为您的 Azure OpenAI 资源添加一个作用域为 Cognitive Services OpenAI User 的 Azure 角色分配。这将允许您从 AAD 获取用于 Azure OpenAI 的令牌。您可以将此角色分配授予用户、组、服务主体或托管身份。有关 Azure OpenAI RBAC 角色的更多信息，请参见 此处。

在 Python 中使用 LangChain 和 AAD 时，请安装 azure-identity 包。然后，将 OPENAI_API_TYPE 设置为 azure_ad。接下来，使用 DefaultAzureCredential 类通过调用 get_token 从 AAD 获取令牌，如下所示。最后，将 OPENAI_API_KEY 环境变量设置为该令牌值。

import os
from azure.identity import DefaultAzureCredential

# Get the Azure Credential
credential = DefaultAzureCredential()

# Set the API type to `azure_ad`
os.environ["OPENAI_API_TYPE"] = "azure_ad"
# Set the API_KEY to the token from the Azure credential
os.environ["OPENAI_API_KEY"] = credential.get_token("https://cognitiveservices.azure.com/.default").token

DefaultAzureCredential 类是开始使用 AAD 身份验证的简便方法。如有必要，您也可以自定义凭据链。在下面所示的示例中，我们首先尝试使用托管身份，然后退回到 Azure CLI。如果您在 Azure 中运行代码但希望在本地进行开发，这将非常有用。

from azure.identity import ChainedTokenCredential, ManagedIdentityCredential, AzureCliCredential

credential = ChainedTokenCredential(
    ManagedIdentityCredential(),
    AzureCliCredential()
)

部署​

通过 Azure OpenAI，您可以设置自己部署的常用 GPT-3 和 Codex 模型。调用 API 时，您需要指定要使用的部署。

注意：这些文档适用于 Azure 文本补全模型。像 GPT-4 这样的模型属于聊天模型，它们具有略微不同的接口，可通过 AzureChatOpenAI 类进行访问。有关 Azure 聊天模型的文档，请参见 Azure Chat OpenAI 文档。

假设你的部署名称为 gpt-35-turbo-instruct-prod。在 openai Python API 中，你可以使用 engine 参数指定此部署。例如：

import openai

client = openai.AzureOpenAI(
    api_version="2023-12-01-preview",
)

response = client.completions.create(
    model="gpt-35-turbo-instruct-prod",
    prompt="Test prompt"
)
%pip install --upgrade --quiet  langchain-openai
import os

os.environ["OPENAI_API_VERSION"] = "2023-12-01-preview"
os.environ["AZURE_OPENAI_ENDPOINT"] = "..."
os.environ["AZURE_OPENAI_API_KEY"] = "..."
# Import Azure OpenAI
from langchain_openai import AzureOpenAI
API 参考:Azure OpenAI
# Create an instance of Azure OpenAI
# Replace the deployment name with your own
llm = AzureOpenAI(
    deployment_name="gpt-35-turbo-instruct-0914",
)
# Run the LLM
llm.invoke("Tell me a joke")
" Why couldn't the bicycle stand up by itself?\n\nBecause it was two-tired!"

我们还可以打印LLM并查看其自定义输出。

print(llm)
AzureOpenAI
Params: {'deployment_name': 'gpt-35-turbo-instruct-0914', 'model_name': 'gpt-3.5-turbo-instruct', 'temperature': 0.7, 'top_p': 1, 'frequency_penalty': 0, 'presence_penalty': 0, 'n': 1, 'logit_bias': {}, 'max_tokens': 256}