From e811c5e8c68a9113acdfa1ec4d72e0da2450afd3 Mon Sep 17 00:00:00 2001
From: schop-rob <49682405+schop-rob@users.noreply.github.com>
Date: Wed, 12 Jul 2023 02:51:58 +0200
Subject: [PATCH] Add OpenAI organization ID to docs (#7398)

Description: I added an example of how to reference the OpenAI API
Organization ID, because I couldn't find it before. In the example, it
is mentioned how to achieve this using environment variables as well as
parameters for the OpenAI()-class
Issue: -
Dependencies: -
Twitter @schop-rob
---
 .../models/chat/integrations/openai.ipynb     | 19 +++++-
 .../models/llms/integrations/openai.ipynb     | 59 ++++++++++++-------
 2 files changed, 55 insertions(+), 23 deletions(-)

diff --git a/docs/extras/modules/model_io/models/chat/integrations/openai.ipynb b/docs/extras/modules/model_io/models/chat/integrations/openai.ipynb
index 9fd2d36cdf5..c94cc92e499 100644
--- a/docs/extras/modules/model_io/models/chat/integrations/openai.ipynb
+++ b/docs/extras/modules/model_io/models/chat/integrations/openai.ipynb
@@ -41,6 +41,19 @@
     "chat = ChatOpenAI(temperature=0)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "4e5fe97e",
+   "metadata": {},
+   "source": [
+    "The above cell assumes that your OpenAI API key is set in your environment variables. If you would rather manually specify your API key and/or organization ID, use the following code:\n",
+    "\n",
+    "```python\n",
+    "chat = ChatOpenAI(temperature=0, openai_api_key=\"YOUR_API_KEY\", openai_organization=\"YOUR_ORGANIZATION_ID\")\n",
+    "```\n",
+    "Remove the openai_organization parameter should it not apply to you."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 3,
@@ -52,7 +65,7 @@
     {
      "data": {
       "text/plain": [
-       "AIMessage(content=\"J'aime programmer.\", additional_kwargs={}, example=False)"
+       "AIMessage(content=\"J'adore la programmation.\", additional_kwargs={}, example=False)"
       ]
      },
      "execution_count": 3,
@@ -108,7 +121,7 @@
     {
      "data": {
       "text/plain": [
-       "AIMessage(content=\"J'adore la programmation.\", additional_kwargs={})"
+       "AIMessage(content=\"J'adore la programmation.\", additional_kwargs={}, example=False)"
       ]
      },
      "execution_count": 5,
@@ -154,7 +167,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.9.7"
   }
  },
  "nbformat": 4,
diff --git a/docs/extras/modules/model_io/models/llms/integrations/openai.ipynb b/docs/extras/modules/model_io/models/llms/integrations/openai.ipynb
index 68f8d205c40..9cd691e1047 100644
--- a/docs/extras/modules/model_io/models/llms/integrations/openai.ipynb
+++ b/docs/extras/modules/model_io/models/llms/integrations/openai.ipynb
@@ -14,20 +14,12 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 1,
    "id": "5d71df86-8a17-4283-83d7-4e46e7c06c44",
    "metadata": {
     "tags": []
    },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      " ········\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "# get a token: https://platform.openai.com/account/api-keys\n",
     "\n",
@@ -38,7 +30,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 2,
    "id": "5472a7cd-af26-48ca-ae9b-5f6ae73c74d2",
    "metadata": {
     "tags": []
@@ -50,9 +42,24 @@
     "os.environ[\"OPENAI_API_KEY\"] = OPENAI_API_KEY"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "129a3275",
+   "metadata": {},
+   "source": [
+    "Should you need to specify your organization ID, you can use the following cell. However, it is not required if you are only part of a single organization or intend to use your default organization. You can check your default organization [here](https://platform.openai.com/account/api-keys).\n",
+    "\n",
+    "To specify your organization, you can use this:\n",
+    "```python\n",
+    "OPENAI_ORGANIZATION = getpass()\n",
+    "\n",
+    "os.environ[\"OPENAI_ORGANIZATION\"] = OPENAI_ORGANIZATION\n",
+    "```"
+   ]
+  },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 3,
    "id": "6fb585dd",
    "metadata": {
     "tags": []
@@ -65,7 +72,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 4,
    "id": "035dea0f",
    "metadata": {
     "tags": []
@@ -81,7 +88,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 5,
    "id": "3f3458d9",
    "metadata": {
     "tags": []
@@ -91,9 +98,21 @@
     "llm = OpenAI()"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "4fc152cd",
+   "metadata": {},
+   "source": [
+    "If you manually want to specify your OpenAI API key and/or organization ID, you can use the following:\n",
+    "```python\n",
+    "llm = OpenAI(openai_api_key=\"YOUR_API_KEY\", openai_organization=\"YOUR_ORGANIZATION_ID\")\n",
+    "```\n",
+    "Remove the openai_organization parameter should it not apply to you."
+   ]
+  },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 6,
    "id": "a641dbd9",
    "metadata": {
     "tags": []
@@ -105,7 +124,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 7,
    "id": "9f844993",
    "metadata": {
     "tags": []
@@ -114,10 +133,10 @@
     {
      "data": {
       "text/plain": [
-       "' Justin Bieber was born in 1994, so we are looking for the Super Bowl winner from that year. The Super Bowl in 1994 was Super Bowl XXVIII, and the winner was the Dallas Cowboys.'"
+       "' Justin Bieber was born in 1994, so the NFL team that won the Super Bowl in 1994 was the Dallas Cowboys.'"
       ]
      },
-     "execution_count": 10,
+     "execution_count": 7,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -138,7 +157,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 8,
    "id": "55142cec",
    "metadata": {},
    "outputs": [],
@@ -163,7 +182,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.1"
+   "version": "3.9.7"
   },
   "vscode": {
    "interpreter": {