Merge pull request microsoft#179 from nitya/chore/fix-openai-update

Chore/fix openai update
HexiaoTian · Nov 14, 2023 · 902660f · 902660f
2 parents 0488acc + e13a9f5
commit 902660f
Showing 1 changed file with 19 additions and 25 deletions.
diff --git a/04-prompt-engineering-fundamentals/1-introduction.ipynb b/04-prompt-engineering-fundamentals/1-introduction.ipynb
@@ -76,48 +76,42 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# Run this as a common starting point for all the exercises below\n",
-    "# It sets the OpenAI API key and uses a helper function that sets the relevant model and parameters\n",
+    "# The OpenAI SDK was updated on Nov 8, 2023 with new guidance for migration\n",
+    "# See: https://github.com/openai/openai-python/discussions/742\n",
     "\n",
-    "import openai\n",
+    "## Updated\n",
     "import os\n",
+    "import openai\n",
+    "from openai import OpenAI\n",
     "\n",
-    "# Expects OPENAI_API_KEY in env variables \n",
-    "# For GitHub Codespaces: set this as Codespaces secret => shows up as env var in OS\n",
-    "# For Docker Desktop: create a .env file (and .gitignore it explicitly to be safe) => shows up as env var from load_dotenv\n",
-    "from dotenv import load_dotenv, find_dotenv\n",
-    "_ = load_dotenv(find_dotenv())\n",
-    "\n",
-    "# Note that we can set different env variables to different OPENAI keys and just map the right one to openai.api_key here\n",
-    "# Example: have both OPENAI_API_KEY (for OpenAI) and AOAI_API_KEY (for Azure OpenAI) as options \n",
-    "openai.api_key  = os.getenv('OPENAI_API_KEY')\n",
-    "\n",
-    "# Print Environment Variables\n",
-    "#for var in os.environ:\n",
-    "#    print(f\"{var}: {os.environ[var]}\")\n",
+    "client = OpenAI(\n",
+    "  api_key=os.environ['OPENAI_API_KEY'],  # this is also the default, it can be omitted\n",
+    ")\n",
     "\n",
+    "## Updated\n",
     "def get_completion(prompt, model=\"gpt-3.5-turbo\"):\n",
     "    messages = [{\"role\": \"user\", \"content\": prompt}]\n",
-    "    response = openai.ChatCompletion.create(\n",
+    "    response = openai.chat.completions.create(\n",
     "        model=model,\n",
     "        messages=messages,\n",
     "        temperature=0, # this is the degree of randomness of the model's output\n",
     "        max_tokens=1024\n",
     "    )\n",
-    "    return response.choices[0].message[\"content\"]\n",
+    "    return response.choices[0].message.content\n",
+    "\n",
+    "## ---------- Call the helper method\n",
     "\n",
-    "## Set the primary content or simple prompt text here\n",
+    "### 1. Set primary content or prompt text\n",
     "text = f\"\"\"\n",
     "oh say can you see\n",
     "\"\"\"\n",
     "\n",
-    "## This uses a template that embeds the text \n",
-    "## allowing you to add additional content like instructions, cues, examples\n",
+    "### 2. Use that in the prompt template below\n",
     "prompt = f\"\"\"\n",
     "```{text}```\n",
     "\"\"\"\n",
     "\n",
-    "## Run the prompt\n",
+    "## 3. Run the prompt\n",
     "response = get_completion(prompt)\n",
     "print(response)"
    ]
@@ -216,7 +210,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "response = openai.ChatCompletion.create(\n",
+    "response = openai.chat.completions.create(\n",
     "    model=\"gpt-3.5-turbo\",\n",
     "    messages=[\n",
     "        {\"role\": \"system\", \"content\": \"You are a sarcastic assistant.\"},\n",
@@ -225,7 +219,7 @@
     "        {\"role\": \"user\", \"content\": \"Where was it played?\"}\n",
     "    ]\n",
     ")\n",
-    "print(response.choices[0].message[\"content\"])"
+    "print(response.choices[0].message.content)"
    ]
   },
   {
@@ -239,7 +233,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },