Merge pull request #1 from sxflynn/updates

Updated all examples to latest OpenAI package with new syntax, plus other upgrades

.env.example

@@ -0,0 +1 @@
+OPENAI_API_KEY="your-key-here-in-quotes"

.gitignore

@@ -0,0 +1,5 @@
+.venv
+venv
+.env
+__pycache__/
+node_modules/

00_curl/curl_gpt.sh

@@ -1,3 +1,7 @@
+set -a
+source ../.env
+set +a 
+
 curl https://api.openai.com/v1/chat/completions \
   -H "Authorization: Bearer $OPENAI_API_KEY" \
   -H "Content-Type: application/json" \

00_curl/curl_gpt_streaming.sh

@@ -1,3 +1,7 @@
+set -a
+source ../.env
+set +a 
+
 curl https://api.openai.com/v1/chat/completions \
   -H "Authorization: Bearer $OPENAI_API_KEY" \
   -H "Content-Type: application/json" \

01_template/gpt_prompt.py

@@ -1,8 +1,11 @@
-import openai
 import os
 import sys
+from openai import OpenAI
+from dotenv import load_dotenv
+
 
 def do_the_thing(arg1: str, arg2: str) -> str:
+    client = OpenAI(api_key=os.getenv("OPENAI_API_KEY"))
     prompt = f"""Dear ChatGPT, 
 
     Please do the thing with {arg1} and {arg2}.
@@ -22,8 +25,9 @@ def do_the_thing(arg1: str, arg2: str) -> str:
     exit(1)
 
 # Exit early if the api key is not provided
-openai.api_key = os.getenv("OPENAI_API_KEY")
-if openai.api_key is None:
+load_dotenv()
+api_key = os.getenv("OPENAI_API_KEY")
+if api_key is None:
     print("Must define environment variable OPENAI_API_KEY")
     exit(1)
 

02_script/gpt_prompt.py

@@ -1,7 +1,8 @@
-import openai
 import os
 import sys
 import json
+from openai import OpenAI
+from dotenv import load_dotenv
 
 class Suggestion:
     def __init__(self, label, description):
@@ -11,6 +12,7 @@ def __init__(self, label, description):
 
 # Uses ChatGPT to offer troubleshooting suggestions based on sound & location
 def troubleshoot_car(sound: str, location: str) -> list[Suggestion]:
+    client = OpenAI(api_key=os.getenv("OPENAI_API_KEY"))
     prompt = f"""Your goal is to help me troubleshoot a problem with my car.  
 I'm hearing a {sound} near {location}.  
 Suggest 3 ideas for determining the issue.
@@ -28,16 +30,14 @@ def troubleshoot_car(sound: str, location: str) -> list[Suggestion]:
 """
 
     # Calls ChatGPT 3.5 with the above prompt.
-    response = openai.ChatCompletion.create(
-        model="gpt-3.5-turbo",
-        messages=[
-            {"role": "system", "content": "You are a helpful assistant."},
-            {"role": "user", "content": prompt},
-        ]
-    )
+    response = client.chat.completions.create(model="gpt-3.5-turbo",
+    messages=[
+        {"role": "system", "content": "You are a helpful assistant."},
+        {"role": "user", "content": prompt},
+    ])
 
     # Extracts the text content from the response.
-    response_content = response.choices[0].message["content"]
+    response_content = response.choices[0].message.content
 
     # Parses the response into Suggestions and returns them
     return parse_suggestions(response_content)
@@ -69,14 +69,15 @@ def parse_suggestions(text: str) -> list[Suggestion]:
     exit(1)
 
 # Exit early if the api key is not provided
-openai.api_key = os.getenv("OPENAI_API_KEY")
-if openai.api_key is None:
+load_dotenv()
+api_key = os.getenv("OPENAI_API_KEY")
+if api_key is None:
     print("Must define environment variable OPENAI_API_KEY")
     exit(1)
 
 sound = sys.argv[1]
 location = sys.argv[2]
 
 suggestions = troubleshoot_car(sound, location)
-print(json.dumps([s.__dict__ for s in suggestions]))
+print(json.dumps([s.__dict__ for s in suggestions], indent=4))
 

03_api/api.py

@@ -1,15 +1,17 @@
-import openai
 import os
 from fastapi import FastAPI
-from pydantic import BaseModel
 from fastapi.middleware.cors import CORSMiddleware
+from pydantic import BaseModel
+from openai import OpenAI
+from dotenv import load_dotenv
 
 class Suggestion(BaseModel):
     label: str
     description: str
 
 # Uses ChatGPT to offer troubleshooting suggestions based on sound & location
 def troubleshoot_car(sound: str, location: str) -> list[Suggestion]:
+    client = OpenAI(api_key=os.getenv("OPENAI_API_KEY"))
     prompt = f"""Your goal is to help me troubleshoot a problem with my car.  
 I'm hearing a {sound} near {location}.  
 Suggest 3 ideas for determining the issue.
@@ -27,16 +29,16 @@ def troubleshoot_car(sound: str, location: str) -> list[Suggestion]:
 """
 
     # Calls ChatGPT 3.5 with the above prompt.
-    response = openai.ChatCompletion.create(
+    response = client.chat.completions.create(
         model="gpt-3.5-turbo",
         messages=[
-            {"role": "system", "content": "You are a helpful assistant."},
-            {"role": "user", "content": prompt},
-        ]
+        {"role": "system", "content": "You are a helpful assistant."},
+        {"role": "user", "content": prompt},
+        ],
     )
 
     # Extracts the text content from the response.
-    response_content = response.choices[0].message["content"]
+    response_content = response.choices[0].message.content
 
     # Parses the response into Suggestions and returns them
     return parse_suggestions(response_content)
@@ -65,15 +67,21 @@ def parse_suggestions(text: str) -> list[Suggestion]:
 def create_app() -> FastAPI:
     app = FastAPI()
 
+    @app.on_event("startup")
+    def startup_event():
+        clickable_url = "http://127.0.0.1:8000/search?sound=shuddering&location=wheels"
+        print(f"Try out the API: {clickable_url}")
+
     @app.get("/search")
     def search(sound: str, location: str) -> list[Suggestion]:
         return troubleshoot_car(sound, location)
 
     return app
 
 # Exit early if the api key is not provided
-openai.api_key = os.getenv("OPENAI_API_KEY")
-if openai.api_key is None:
+load_dotenv()
+api_key = os.getenv("OPENAI_API_KEY")
+if api_key is None:
     print("Must define environment variable OPENAI_API_KEY")
     exit(1)
 

04_frontend/api.py

@@ -1,17 +1,17 @@
-import openai
 import os
-import sys
-import json
 from fastapi import FastAPI
-from pydantic import BaseModel
 from fastapi.middleware.cors import CORSMiddleware
+from pydantic import BaseModel
+from openai import OpenAI
+from dotenv import load_dotenv
 
 class Suggestion(BaseModel):
     label: str
     description: str
 
 # Uses ChatGPT to offer troubleshooting suggestions based on sound & location
 def troubleshoot_car(sound: str, location: str) -> list[Suggestion]:
+    client = OpenAI(api_key=os.getenv("OPENAI_API_KEY"))
     prompt = f"""Your goal is to help me troubleshoot a problem with my car.  
 I'm hearing a {sound} near {location}.  
 Suggest 3 ideas for determining the issue.
@@ -29,16 +29,16 @@ def troubleshoot_car(sound: str, location: str) -> list[Suggestion]:
 """
 
     # Calls ChatGPT 3.5 with the above prompt.
-    response = openai.ChatCompletion.create(
+    response = client.chat.completions.create(
         model="gpt-3.5-turbo",
         messages=[
-            {"role": "system", "content": "You are a helpful assistant."},
-            {"role": "user", "content": prompt},
-        ]
+        {"role": "system", "content": "You are a helpful assistant."},
+        {"role": "user", "content": prompt},
+        ],
     )
 
     # Extracts the text content from the response.
-    response_content = response.choices[0].message["content"]
+    response_content = response.choices[0].message.content
 
     # Parses the response into Suggestions and returns them
     return parse_suggestions(response_content)
@@ -74,8 +74,9 @@ def search(sound: str, location: str) -> list[Suggestion]:
     return app
 
 # Exit early if the api key is not provided
-openai.api_key = os.getenv("OPENAI_API_KEY")
-if openai.api_key is None:
+load_dotenv()
+api_key = os.getenv("OPENAI_API_KEY")
+if api_key is None:
     print("Must define environment variable OPENAI_API_KEY")
     exit(1)
 

04_frontend/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>04_frontend</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.jsx"></script>
+  </body>
+</html>