Azure OpenAI
此页面介绍了如何将 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 资源添加一个作用域为“认知服务 OpenAI 用户”的 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 聊天 OpenAI 文档。
假设您的部署名称为 gpt-35-turbo-instruct-prod。在 openai Python API 中，您可以使用 engine 参数指定此部署。例如
import openai
client = 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
# 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)
[1mAzureOpenAI[0m
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}