Skip to main content

Azure OpenAI

caution

您当前正在查看有关使用 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 资源添加一个角色 Azure 角色分配 Cognitive Services OpenAI User。这将允许您从 AAD 获取一个令牌以用于 Azure OpenAI。您可以将此角色分配授予用户、组、服务主体或托管身份。有关 Azure OpenAI RBAC 角色的更多信息,请查看 这里

要在 Python 中使用 AAD 和 LangChain,请安装 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 = 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"] = "..."
<!--IMPORTS:[{"imported": "AzureOpenAI", "source": "langchain_openai", "docs": "https://python.langchain.com/api_reference/openai/llms/langchain_openai.llms.azure.AzureOpenAI.html", "title": "Azure OpenAI"}]-->
# 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)
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}

相关


Was this page helpful?


You can also leave detailed feedback on GitHub.

扫我,入群扫我,找书