Merge branch 'main' into add-evaluation-cookbook

Author: lspacagna-oai

.github/scripts/check_notebooks.py

@@ -0,0 +1,61 @@
+import subprocess
+import sys
+from pathlib import Path
+
+import nbformat
+
+
+def get_changed_notebooks(base_ref: str = "origin/main") -> list[Path]:
+    """
+    Returns a list of changed notebook paths in the current git branch
+    compared to the specified base reference.
+    """
+    result = subprocess.run(
+        ["git", "diff", "--name-only", base_ref, "--", "*.ipynb"],
+        capture_output=True,
+        text=True,
+        check=True,
+    )
+    return [Path(line.strip()) for line in result.stdout.splitlines() if line.strip()]
+
+
+def is_valid_notebook(path: Path) -> bool:
+    """
+    Checks if the notebook at the given path is valid by attempting to read it
+    with nbformat.
+    """
+    try:
+        with open(path, "r", encoding="utf-8") as f:
+            nbformat.read(f, as_version=4)
+        return True
+    except Exception as e:
+        print(f"{path}: INVALID - {e}")
+        return False
+
+
+def main() -> None:
+    """
+    Main function to validate the format of changed notebooks.
+    """
+    changed_notebooks = get_changed_notebooks()
+    if not changed_notebooks:
+        print("No changed .ipynb files to validate.")
+        sys.exit(0)
+
+    print(f"Validating {len(changed_notebooks)} notebook(s)...")
+    errors = 0
+    for path in changed_notebooks:
+        if not path.exists():
+            continue  # skip deleted files
+        if not is_valid_notebook(path):
+            errors += 1
+
+    if errors:
+        print(f"{errors} invalid notebook(s) found.")
+        sys.exit(1)
+    else:
+        print("All changed notebooks are valid.")
+
+
+if __name__ == "__main__":
+    main()

.github/workflows/validate-notebooks.yaml

@@ -0,0 +1,25 @@
+name: Validate Changed Notebooks
+
+on: [pull_request]
+
+jobs:
+  validate-notebooks:
+    name: Validate Notebooks
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0  # needed for git diff to work
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: pip install nbformat
+
+      - name: Validate changed .ipynb files
+        run: python .github/scripts/check_notebooks.py

.gitignore

@@ -137,6 +137,12 @@ dmypy.json
 *.DS_Store
 tmp_*
 examples/fine-tuned_qa/local_cache/*
+examples/multimodal/.local_cache/*
 
 # PyCharm files
 .idea/
+.cursorignore
+
+# VS Code files
+.vscode/
+.cursorignore

README.md

@@ -9,12 +9,12 @@
 
 > ✨ Navigate at [cookbook.openai.com](https://cookbook.openai.com)
 
-Example code and guides for accomplishing common tasks with the [OpenAI API](https://platform.openai.com/docs/introduction). To run these examples, you'll need an OpenAI account and associated API key ([create a free account here](https://beta.openai.com/signup)). Set an environment variable called `OPENAI_API_KEY` with your API key. Alternatively, in most IDEs such as Visual Studio Code, you can create an `.env` file at the root of your repo containing `OPENAI_API_KEY=<your API key>`, which will be picked up by the notebooks.
+Example code and guides for accomplishing common tasks with the [OpenAI API](https://platform.openai.com/docs/introduction). To run these examples, you'll need an OpenAI account and associated API key ([create a free account here](https://platform.openai.com/signup)). Set an environment variable called `OPENAI_API_KEY` with your API key. Alternatively, in most IDEs such as Visual Studio Code, you can create an `.env` file at the root of your repo containing `OPENAI_API_KEY=<your API key>`, which will be picked up by the notebooks.
 
 Most code examples are written in Python, though the concepts can be applied in any language.
 
 For other useful tools, guides and courses, check out these [related resources from around the web](https://cookbook.openai.com/related_resources).
 
 ## License
 
-MIT
+MIT License

articles/related_resources.md

@@ -7,6 +7,7 @@ People are writing great tools and papers for improving outputs from GPT. Here a
 - [Arthur Shield](https://www.arthur.ai/get-started): A paid product for detecting toxicity, hallucination, prompt injection, etc.
 - [Baserun](https://baserun.ai/): A paid product for testing, debugging, and monitoring LLM-based apps
 - [Chainlit](https://docs.chainlit.io/overview): A Python library for making chatbot interfaces.
+- [ElatoAI](https://github.com/akdeb/ElatoAI): A platform for running OpenAI Realtime API Speech on ESP32 on Arduino using Deno Edge Runtime and Supabase.
 - [Embedchain](https://github.com/embedchain/embedchain): A Python library for managing and syncing unstructured data with LLMs.
 - [FLAML (A Fast Library for Automated Machine Learning & Tuning)](https://microsoft.github.io/FLAML/docs/Getting-Started/): A Python library for automating selection of models, hyperparameters, and other tunable choices.
 - [Guidance](https://github.com/microsoft/guidance): A handy looking Python library from Microsoft that uses Handlebars templating to interleave generation, prompting, and logical control.

authors.yaml

@@ -2,6 +2,25 @@
 
 # You can optionally customize how your information shows up cookbook.openai.com over here.
 # If your information is not present here, it will be pulled from your GitHub profile.
+prashantmital-openai:
+  name: "Prashant Mital"
+  website: "https://www.linkedin.com/in/pmital/"
+  avatar: "https://avatars.githubusercontent.com/u/173949238?v=4"
+
+theophile-oai:
+  name: "Theophile Sautory"
+  website: "https://www.linkedin.com/in/theophilesautory"
+  avatar: "https://avatars.githubusercontent.com/u/206768658?v=4"
+
+robert-tinn:
+  name: "Robert Tinn"
+  website: "https://www.linkedin.com/in/robert-tinn/"
+  avatar: "https://avatars.githubusercontent.com/u/208724428?v=4"
+
+minh-hoque:
+  name: "Minhajul Hoque"
+  website: "https://www.linkedin.com/in/minhajul-hoque-83242b163/"
+  avatar: "https://avatars.githubusercontent.com/u/84698472?v=4"
 
 shikhar-cyber:
   name: "Shikhar Kwatra"
@@ -58,6 +77,11 @@ ibigio:
   website: "https://twitter.com/ilanbigio"
   avatar: "https://pbs.twimg.com/profile_images/1841544725654077440/DR3b8DMr_400x400.jpg"
 
+willhath-openai:
+  name: "Will Hathaway"
+  website: "https://www.willhath.com"
+  avatar: "https://media.licdn.com/dms/image/v2/D4E03AQEHOtMrHtww4Q/profile-displayphoto-shrink_200_200/B4EZRR64p9HgAc-/0/1736541178829?e=2147483647&v=beta&t=w1rX0KhLZaK5qBkVLkJjmYmfNMbsV2Bcn8InFVX9lwI"
+
 jhills20:
   name: "James Hills"
   website: "https://twitter.com/jamesmhills"
@@ -126,13 +150,13 @@ aaronwilkowitz-openai:
 charuj:
   name: "Charu Jaiswal"
   website: "https://www.linkedin.com/in/charu-j-8a866471"
-  avatar: "https://avatars.githubusercontent.com/u/18404643?v=4" 
+  avatar: "https://avatars.githubusercontent.com/u/18404643?v=4"
 
 rupert-openai:
   name: "Rupert Truman"
   website: "https://www.linkedin.com/in/rupert-truman/"
   avatar: "https://avatars.githubusercontent.com/u/171234447"
-  
+
 keelan-openai:
   name: "Keelan Schule"
   website: "https://www.linkedin.com/in/keelanschule/"
@@ -171,8 +195,8 @@ evanweiss-openai:
 girishd:
   name: "Girish Dusane"
   website: "https://www.linkedin.com/in/girishdusane/"
-  avatar: "https://avatars.githubusercontent.com/u/272708"   
-  
+  avatar: "https://avatars.githubusercontent.com/u/272708"
+
 lxing-oai:
   name: "Luke Xing"
   website: "https://www.linkedin.com/in/lukexing/"
@@ -227,7 +251,7 @@ erickgort:
   name: "Erick Gort"
   website: "https://www.linkedin.com/in/erick-gort-32ab1678/"
   avatar: "https://avatars.githubusercontent.com/u/189261906?v=4"
-  
+
 kylecote-tray:
   name: "Kyle Cote"
   website: "https://github.com/kylecote-tray"
@@ -248,6 +272,11 @@ msingh-openai:
   website: "https://github.com/msingh-openai"
   avatar: "https://avatars.githubusercontent.com/u/168678187?v=4"
 
+akashdeepdeb:
+  name: "Akashdeep Deb"
+  website: "https://github.com/akdeb"
+  avatar: "https://avatars.githubusercontent.com/u/20175219"
+
 ted-at-openai:
   name: "Ted Sanders"
   website: "https://github.com/ted-at-openai"
@@ -277,3 +306,33 @@ josiah-openai:
   name: "Josiah Grace"
   website: "https://www.linkedin.com/in/josiahbgrace"
   avatar: "https://avatars.githubusercontent.com/u/181146311?v=4"
+
+vishnu-oai:
+  name: "Vishnu Chopra"
+  website: "https://www.linkedin.com/in/vishnu-chopra/"
+  avatar: "https://avatars.githubusercontent.com/u/206769912?v=4"
+
+nm-openai:
+  name: "Noah MacCallum"
+  website: "https://x.com/noahmacca"
+  avatar: "https://avatars.githubusercontent.com/u/171723556"
+
+julian-openai:
+  name: "Julian Lee"
+  website: "https://x.com/julianl093"
+  avatar: "https://avatars.githubusercontent.com/u/199828632"
+
+rzhao-openai:
+  name: "Randy Zhao"
+  website: "https://www.linkedin.com/in/randy-zhao-27433616b"
+  avatar: "https://avatars.githubusercontent.com/u/208724779?v=4"
+
+brandonbaker-openai:
+  name: "Brandon Baker"
+  website: "https://www.linkedin.com/in/brandonbaker18"
+  avatar: "https://avatars.githubusercontent.com/u/208719822"
+
+tompakeman-oai:
+  name: "Tom Pakeman"
+  website: "https://www.linkedin.com/in/tom-pakeman/"
+  avatar: "https://avatars.githubusercontent.com/u/204937754"