update more azure docs (#13093)

2025-08-12 06:13:36 +00:00 · 2023-11-08 14:11:16 -08:00 · 2023-11-08 14:11:16 -08:00 · 72e12f6bcf
commit 72e12f6bcf
parent 1703f132c6
5 changed files with 54 additions and 93 deletions
--- a/cookbook/openai_v1_cookbook.ipynb
+++ b/cookbook/openai_v1_cookbook.ipynb
@ -17,7 +17,8 @@
   "metadata": {},
   "outputs": [],
   "source": [
-    "!pip install -U openai \"langchain>=0.0.331rc3\" langchain-experimental"
+    "# need openai>=1.1.0, langchain>=0.0.332, langchain-experimental>=0.0.39\n",
+    "!pip install -U openai langchain langchain-experimental"
   ]
  },
  {
--- a/docs/docs/integrations/chat/azure_chat_openai.ipynb
+++ b/docs/docs/integrations/chat/azure_chat_openai.ipynb
@ -5,18 +5,20 @@
   "id": "38f26d7a",
   "metadata": {},
   "source": [
-    "# Azure\n",
+    "# Azure OpenAI\n",
    "\n",
-    "This notebook goes over how to connect to an Azure hosted OpenAI endpoint"
+    "This notebook goes over how to connect to an Azure hosted OpenAI endpoint. We recommend having version `openai>=1` installed."
   ]
  },
  {
   "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 3,
   "id": "96164b42",
   "metadata": {},
   "outputs": [],
   "source": [
+    "import os\n",
+    "\n",
    "from langchain.chat_models import AzureChatOpenAI\n",
    "from langchain.schema import HumanMessage"
   ]
@ -24,57 +26,51 @@
  {
   "cell_type": "code",
   "execution_count": 4,
+   "id": "cbe4bb58-ba13-4355-8af9-cd990dc47a64",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "os.environ[\"AZURE_OPENAI_API_KEY\"] = \"...\"\n",
+    "os.environ[\"AZURE_OPENAI_ENDPOINT\"] = \"https://<your-endpoint>.openai.azure.com/\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 14,
   "id": "8161278f",
   "metadata": {},
   "outputs": [],
   "source": [
-    "BASE_URL = \"https://${TODO}.openai.azure.com\"\n",
-    "API_KEY = \"...\"\n",
-    "DEPLOYMENT_NAME = \"chat\"\n",
    "model = AzureChatOpenAI(\n",
-    "    openai_api_base=BASE_URL,\n",
    "    openai_api_version=\"2023-05-15\",\n",
-    "    deployment_name=DEPLOYMENT_NAME,\n",
-    "    openai_api_key=API_KEY,\n",
-    "    openai_api_type=\"azure\",\n",
+    "    azure_deployment=\"your-deployment-name\",\n",
    ")"
   ]
  },
  {
   "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 15,
   "id": "99509140",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
-       "AIMessage(content=\"\\n\\nJ'aime programmer.\", additional_kwargs={})"
+       "AIMessage(content=\"J'adore la programmation.\")"
      ]
     },
-     "execution_count": 5,
+     "execution_count": 15,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
-    "model(\n",
-    "    [\n",
-    "        HumanMessage(\n",
-    "            content=\"Translate this sentence from English to French. I love programming.\"\n",
-    "        )\n",
-    "    ]\n",
-    ")"
+    "message = HumanMessage(\n",
+    "    content=\"Translate this sentence from English to French. I love programming.\"\n",
+    ")\n",
+    "model([message])"
   ]
  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "3b6e9376",
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  },
  {
   "cell_type": "markdown",
   "id": "f27fa24d",
@ -88,7 +84,7 @@
  },
  {
   "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 8,
   "id": "0531798a",
   "metadata": {},
   "outputs": [],
@ -98,48 +94,19 @@
  },
  {
   "cell_type": "code",
-   "execution_count": 14,
-   "id": "3fd97dfc",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "BASE_URL = \"https://{endpoint}.openai.azure.com\"\n",
-    "API_KEY = \"...\"\n",
-    "DEPLOYMENT_NAME = \"gpt-35-turbo\"  # in Azure, this deployment has version 0613 - input and output tokens are counted separately"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 15,
+   "execution_count": null,
   "id": "aceddb72",
   "metadata": {
    "scrolled": true
   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Total Cost (USD): $0.000054\n"
-     ]
-    }
-   ],
+   "outputs": [],
   "source": [
    "model = AzureChatOpenAI(\n",
-    "    openai_api_base=BASE_URL,\n",
    "    openai_api_version=\"2023-05-15\",\n",
-    "    deployment_name=DEPLOYMENT_NAME,\n",
-    "    openai_api_key=API_KEY,\n",
-    "    openai_api_type=\"azure\",\n",
+    "    azure_deployment=\"gpt-35-turbo\",  # in Azure, this deployment has version 0613 - input and output tokens are counted separately\n",
    ")\n",
    "with get_openai_callback() as cb:\n",
-    "    model(\n",
-    "        [\n",
-    "            HumanMessage(\n",
-    "                content=\"Translate this sentence from English to French. I love programming.\"\n",
-    "            )\n",
-    "        ]\n",
-    "    )\n",
+    "    model([message])\n",
    "    print(\n",
    "        f\"Total Cost (USD): ${format(cb.total_cost, '.6f')}\"\n",
    "    )  # without specifying the model version, flat-rate 0.002 USD per 1k input and output tokens is used"
@ -169,21 +136,12 @@
   ],
   "source": [
    "model0613 = AzureChatOpenAI(\n",
-    "    openai_api_base=BASE_URL,\n",
    "    openai_api_version=\"2023-05-15\",\n",
-    "    deployment_name=DEPLOYMENT_NAME,\n",
-    "    openai_api_key=API_KEY,\n",
-    "    openai_api_type=\"azure\",\n",
+    "    deployment_name=\"gpt-35-turbo,\n",
    "    model_version=\"0613\",\n",
    ")\n",
    "with get_openai_callback() as cb:\n",
-    "    model0613(\n",
-    "        [\n",
-    "            HumanMessage(\n",
-    "                content=\"Translate this sentence from English to French. I love programming.\"\n",
-    "            )\n",
-    "        ]\n",
-    "    )\n",
+    "    model0613([message])\n",
    "    print(f\"Total Cost (USD): ${format(cb.total_cost, '.6f')}\")"
   ]
  },
@ -212,7 +170,7 @@
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
-   "version": "3.8.10"
+   "version": "3.9.1"
  }
 },
 "nbformat": 4,
--- a/docs/docs/integrations/platforms/microsoft.mdx
+++ b/docs/docs/integrations/platforms/microsoft.mdx
@ -2,7 +2,7 @@

 All functionality related to `Microsoft Azure` and other `Microsoft` products.

-## LLM
+## Chat Models
 ### Azure OpenAI

 >[Microsoft Azure](https://en.wikipedia.org/wiki/Microsoft_Azure), often referred to as `Azure` is a cloud computing platform run by `Microsoft`, which offers access, management, and development of applications and services through global data centers. It provides a range of capabilities, including software as a service (SaaS), platform as a service (PaaS), and infrastructure as a service (IaaS). `Microsoft Azure` supports many programming languages, tools, and frameworks, including Microsoft-specific and third-party software and systems.
@ -18,16 +18,15 @@ Set the environment variables to get access to the `Azure OpenAI` service.
 ```python
 import os

-os.environ["OPENAI_API_TYPE"] = "azure"
-os.environ["OPENAI_API_BASE"] = "https://<your-endpoint.openai.azure.com/"
-os.environ["OPENAI_API_KEY"] = "your AzureOpenAI key"
-os.environ["OPENAI_API_VERSION"] = "2023-05-15"
+os.environ["AZURE_OPENAI_ENDPOINT"] = "https://<your-endpoint.openai.azure.com/"
+os.environ["AZURE_OPENAI_API_KEY"] = "your AzureOpenAI key"
 ```

-See a [usage example](/docs/integrations/llms/azure_openai_example).
+See a [usage example](/docs/integrations/chat/azure_chat_openai)
+

 ```python
-from langchain.llms import AzureOpenAI
+from langchain.chat_models import AzureChatOpenAI
 ```

 ## Text Embedding Models
@ -36,16 +35,16 @@ from langchain.llms import AzureOpenAI
 See a [usage example](/docs/integrations/text_embedding/azureopenai)

 ```python
-from langchain.embeddings import OpenAIEmbeddings
+from langchain.embeddings import AzureOpenAIEmbeddings
 ```

-## Chat Models
+## LLMs
 ### Azure OpenAI

-See a [usage example](/docs/integrations/chat/azure_chat_openai)
+See a [usage example](/docs/integrations/llms/azure_openai_example).

 ```python
-from langchain.chat_models import AzureChatOpenAI
+from langchain.llms import AzureOpenAI
 ```

 ## Document loaders
--- a/docs/docs/integrations/text_embedding/azureopenai.ipynb
+++ b/docs/docs/integrations/text_embedding/azureopenai.ipynb
@ -5,7 +5,7 @@
   "id": "c3852491",
   "metadata": {},
   "source": [
-    "# AzureOpenAI\n",
+    "# Azure OpenAI\n",
    "\n",
    "Let's load the Azure OpenAI Embedding class with environment variables set to indicate to use Azure endpoints."
   ]
@ -20,7 +20,7 @@
    "import os\n",
    "\n",
    "os.environ[\"AZURE_OPENAI_API_KEY\"] = \"...\"\n",
-    "os.environ[\"AZURE_OPENAI_ENDPOINT\"] = \"https://<yout-endpoint>.openai.azure.com/\""
+    "os.environ[\"AZURE_OPENAI_ENDPOINT\"] = \"https://<your-endpoint>.openai.azure.com/\""
   ]
  },
  {
@ -32,7 +32,10 @@
   "source": [
    "from langchain.embeddings import AzureOpenAIEmbeddings\n",
    "\n",
-    "embeddings = AzureOpenAIEmbeddings(azure_deployment=\"<your-embeddings-deployment-name>\")"
+    "embeddings = AzureOpenAIEmbeddings(\n",
+    "    azure_deployment=\"<your-embeddings-deployment-name>\", \n",
+    "    openai_api_version=\"2023-05-15\"\n",
+    ")"
   ]
  },
  {
--- a/libs/langchain/langchain/chat_models/azure_openai.py
+++ b/libs/langchain/langchain/chat_models/azure_openai.py
@ -24,9 +24,9 @@ class AzureChatOpenAI(ChatOpenAI):

    In addition, you should have the ``openai`` python package installed, and the
    following environment variables set or passed in constructor in lower case:
-    - ``OPENAI_API_TYPE`` (default: ``azure``)
-    - ``OPENAI_API_KEY``
-    - ``OPENAI_API_BASE``
+    - ``AZURE_OPENAI_API_KEY``
+    - ``AZURE_OPENAI_API_ENDPOINT``
+    - ``AZURE_OPENAI_AD_TOKEN``
    - ``OPENAI_API_VERSION``
    - ``OPENAI_PROXY``

@ -36,7 +36,7 @@ class AzureChatOpenAI(ChatOpenAI):
    .. code-block:: python

        AzureChatOpenAI(
-            deployment_name="35-turbo-dev",
+            azure_deployment="35-turbo-dev",
            openai_api_version="2023-05-15",
        )