Skip to content

Update Cookbook notebooks with fixes and improvements#2604

Open
shreekant-openai wants to merge 4 commits intomainfrom
codex/docs-reliability-test-20260319
Open

Update Cookbook notebooks with fixes and improvements#2604
shreekant-openai wants to merge 4 commits intomainfrom
codex/docs-reliability-test-20260319

Conversation

@shreekant-openai
Copy link
Copy Markdown

Summary

Updates existing Cookbook notebooks to make the Evals, Qdrant, and knowledge retrieval examples more current, executable, and easier to follow.

This PR includes:

  • Modernized model references where examples used older model names.
  • Updated Qdrant examples to use current client APIs.
  • Clearer setup and execution guidance for the OpenAI Evals notebook.
  • Small fixes for notebook execution reliability.
  • Cleanup of stale saved-output noise where applicable.
  • An update to the Qdrant Docker setup used by the vector database examples.

This PR does not add new Cookbook content; it refreshes existing notebooks so they remain useful and accurate for readers.

Motivation

Some existing notebooks had become stale as API patterns, model names, and third-party client usage evolved. A few examples also had setup or execution gaps that could make them harder for readers to run successfully.

These updates improve the Cookbook by making the affected examples:

  • More aligned with current OpenAI API usage.
  • Easier to execute from a clean environment.
  • Clearer in their setup instructions.
  • Less likely to run into deprecated dependency or client-method behavior.
  • Better aligned with current notebook quality expectations.

Validation performed:

  • Ran git diff --check.
  • Ran full real notebook validation with nbclient for the changed notebooks:
    • examples/How_to_call_functions_for_knowledge_retrieval.ipynb
    • examples/evaluation/Getting_Started_with_OpenAI_Evals.ipynb
    • examples/vector_databases/qdrant/Getting_started_with_Qdrant_and_OpenAI.ipynb
    • examples/vector_databases/qdrant/Using_Qdrant_for_embeddings_search.ipynb

Qdrant validation included starting a local Qdrant Docker service, running the notebooks, then stopping and removing the temporary container/network. Generated runtime datasets and zip files were removed and are not included in this PR.


For new content

This PR updates existing content only and does not add a new Cookbook entry.

  • I have added a new entry in registry.yaml (and, optionally, in authors.yaml) so that my content renders on the cookbook website.
  • I have conducted a self-review of my content based on the contribution guidelines:
    • Relevance: This content is related to building with OpenAI technologies and is useful to others.
    • Uniqueness: I have searched for related examples in the OpenAI Cookbook, and verified that my content offers new insights or unique information compared to existing documentation.
    • Spelling and Grammar: I have checked for spelling or grammatical mistakes.
    • Clarity: I have done a final read-through and verified that my submission is well-organized and easy to understand.
    • Correctness: The information I include is correct and all of my code executes successfully.
    • Completeness: I have explained everything fully, including all necessary references and citations.

@openai openai deleted a comment from bendasgfyug Apr 10, 2026
@bendasgfyug
Copy link
Copy Markdown

great job

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants