AzureChatOpenAI

这本指南将帮助你开始使用AzureOpenAI 聊天模型。有关所有AzureChatOpenAI功能和配置的详细文档，请参阅API参考。

Azure OpenAI 有几个聊天模型。您可以在 Azure 文档中找到有关它们的最新模型、费用、上下文窗口以及支持的输入类型的信息。

Azure OpenAI vs OpenAI

Azure OpenAI指的是托管在Microsoft Azure平台上的OpenAI模型。OpenAI还提供了自己的模型API。要直接访问OpenAI服务，请使用ChatOpenAI集成。

概览

集成细节

Class	包	本地	序列化	JS支持	Package downloads	Package 最新版本
AzureChatOpenAI	langchain-openai	❌	beta	✅

模型特性

工具调用	结构化输出	JSON 模式	图像输入	音频输入	视频输入	Token级流式传输	原生异步	Token 使用	对数概率
✅	✅	✅	✅	❌	❌	✅	✅	✅	✅

设置

要访问 AzureOpenAI 模型，您需要创建一个 Azure 账户、部署一个 Azure OpenAI 模型、获取模型的名称和端点、获取 Azure OpenAI API 密钥，并安装 langchain-openai 整合包。

Credentials

前往Azure 文档创建您的部署并生成一个 API 密钥。完成这些步骤后，请设置 AZURE_OPENAI_API_KEY 和 AZURE_OPENAI_ENDPOINT 环境变量：

import getpass
import os

if "AZURE_OPENAI_API_KEY" not in os.environ:
    os.environ["AZURE_OPENAI_API_KEY"] = getpass.getpass(
        "Enter your AzureOpenAI API key: "
    )
os.environ["AZURE_OPENAI_ENDPOINT"] = "https://YOUR-ENDPOINT.openai.azure.com/"

要启用对您的模型调用的自动跟踪，请设置您的LangSmith API密钥：

# os.environ["LANGSMITH_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")
# os.environ["LANGSMITH_TRACING"] = "true"

安装

The LangChain AzureOpenAI 整合存在于 langchain-openai 包中:

%pip install -qU langchain-openai

Instantiation

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

替换azure_deployment为您的部署名称,
您可以在以下链接找到最新支持的api_version： https://learn.microsoft.com/en-us/azure/ai-services/openai/reference.

from langchain_openai import AzureChatOpenAI

llm = AzureChatOpenAI(
    azure_deployment="gpt-35-turbo",  # or your deployment
    api_version="2023-06-01-preview",  # or your api version
    temperature=0,
    max_tokens=None,
    timeout=None,
    max_retries=2,
    # other params...
)

API 参考:AzureChatOpenAI

Invocation

messages = [
    (
        "system",
        "You are a helpful assistant that translates English to French. Translate the user sentence.",
    ),
    ("human", "I love programming."),
]
ai_msg = llm.invoke(messages)
ai_msg

AIMessage(content="J'adore la programmation.", response_metadata={'token_usage': {'completion_tokens': 8, 'prompt_tokens': 31, 'total_tokens': 39}, 'model_name': 'gpt-35-turbo', 'system_fingerprint': None, 'prompt_filter_results': [{'prompt_index': 0, 'content_filter_results': {'hate': {'filtered': False, 'severity': 'safe'}, 'self_harm': {'filtered': False, 'severity': 'safe'}, 'sexual': {'filtered': False, 'severity': 'safe'}, 'violence': {'filtered': False, 'severity': 'safe'}}}], 'finish_reason': 'stop', 'logprobs': None, 'content_filter_results': {'hate': {'filtered': False, 'severity': 'safe'}, 'self_harm': {'filtered': False, 'severity': 'safe'}, 'sexual': {'filtered': False, 'severity': 'safe'}, 'violence': {'filtered': False, 'severity': 'safe'}}}, id='run-bea4b46c-e3e1-4495-9d3a-698370ad963d-0', usage_metadata={'input_tokens': 31, 'output_tokens': 8, 'total_tokens': 39})

print(ai_msg.content)

J'adore la programmation.

链式调用

我们可以通过以下方式将模型与提示模板进行链接：

from langchain_core.prompts import ChatPromptTemplate

prompt = ChatPromptTemplate.from_messages(
    [
        (
            "system",
            "You are a helpful assistant that translates {input_language} to {output_language}.",
        ),
        ("human", "{input}"),
    ]
)

chain = prompt | llm
chain.invoke(
    {
        "input_language": "English",
        "output_language": "German",
        "input": "I love programming.",
    }
)

API 参考:ChatPromptTemplate

AIMessage(content='Ich liebe das Programmieren.', response_metadata={'token_usage': {'completion_tokens': 6, 'prompt_tokens': 26, 'total_tokens': 32}, 'model_name': 'gpt-35-turbo', 'system_fingerprint': None, 'prompt_filter_results': [{'prompt_index': 0, 'content_filter_results': {'hate': {'filtered': False, 'severity': 'safe'}, 'self_harm': {'filtered': False, 'severity': 'safe'}, 'sexual': {'filtered': False, 'severity': 'safe'}, 'violence': {'filtered': False, 'severity': 'safe'}}}], 'finish_reason': 'stop', 'logprobs': None, 'content_filter_results': {'hate': {'filtered': False, 'severity': 'safe'}, 'self_harm': {'filtered': False, 'severity': 'safe'}, 'sexual': {'filtered': False, 'severity': 'safe'}, 'violence': {'filtered': False, 'severity': 'safe'}}}, id='run-cbc44038-09d3-40d4-9da2-c5910ee636ca-0', usage_metadata={'input_tokens': 26, 'output_tokens': 6, 'total_tokens': 32})

指定模型版本

Azure OpenAI响应包含model_name响应元数据属性，这是生成响应所用的模型名称。然而，与原生OpenAI响应不同，它不包含在Azure中设置的具体模型版本。例如，它不能区分gpt-35-turbo-0125和gpt-35-turbo-0301。这使得很难知道生成响应使用的是哪个模型版本，最终可能导致例如使用OpenAICallbackHandler进行错误的成本计算。

要解决这个问题，您可以在AzureChatOpenAI类中传递model_version参数，这将在模型名称中添加到llm输出。这样您可以轻松区分不同版本的模型。

%pip install -qU langchain-community

from langchain_community.callbacks import get_openai_callback

with get_openai_callback() as cb:
    llm.invoke(messages)
    print(
        f"Total Cost (USD): ${format(cb.total_cost, '.6f')}"
    )  # without specifying the model version, flat-rate 0.002 USD per 1k input and output tokens is used

API 参考:get_openai_callback

Total Cost (USD): $0.000063

llm_0301 = AzureChatOpenAI(
    azure_deployment="gpt-35-turbo",  # or your deployment
    api_version="2023-06-01-preview",  # or your api version
    model_version="0301",
)
with get_openai_callback() as cb:
    llm_0301.invoke(messages)
    print(f"Total Cost (USD): ${format(cb.total_cost, '.6f')}")

Total Cost (USD): $0.000074

API 参考

详细文档涵盖了所有AzureChatOpenAI功能和配置，请参阅API参考：https://python.langchain.com/api_reference/openai/chat_models/langchain_openai.chat_models.azure.AzureChatOpenAI.html

聊天模型概念指南
聊天模型使用指南

概览​

集成细节​

模型特性​

设置​

Credentials​

安装​

Instantiation​

Invocation​

链式调用​

指定模型版本​

API 参考​

相关​

概览