Open
Conversation
added 7 commits
March 6, 2026 16:10
Improve the GPT-5.4 prompting guide notebook by expanding guidance on long-context workflows, tool usage, structured extraction, prompt migration, and evaluation practices. Align structure with existing GPT-5.x guides and strengthen practical prompting patterns for production workflows.
… guidance Improve the GPT-5.4 prompting guide notebook by adding completion criteria, prompt pattern selection guidance, workflow prompt templates, evaluation and debugging practices, and expanded examples. Strengthen practical guidance for long-context workflows, tool-integrated execution, and production prompt design while maintaining alignment with existing GPT-5.x documentation patterns.
Repair the GPT-5.4 prompting guide notebook structure to ensure it is valid .ipynb JSON and renders correctly in GitHub diffs. Fix cell formatting, metadata, and serialization issues without changing the guide’s content.
Refine the GPT-5.4 prompting guide notebook with a final editorial pass to improve tone, consistency, and publication readiness. Tighten wording, remove overly informal phrasing, and soften any language that could imply undocumented behavior while preserving the guide’s structure and practical guidance.
Author
|
This PR is ready for maintainer review. Summary of final updates:
The guide now includes:
From my side, the PR is finalized and ready for review. Happy to make any follow-up changes if maintainers want adjustments for style or alignment. |
8 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a new notebook:
examples/gpt-5/gpt-5-4_prompting_guide.ipynbThe notebook introduces practical prompting patterns for GPT-5.4 workflows, including:
The notebook structure follows the style of the existing GPT-5.2 Prompting Guide while focusing on practical prompt design patterns for GPT-5.4.
The PR also includes the necessary registry.yaml entry so the notebook renders on the OpenAI Cookbook website.
Motivation
Developers building GPT-5-class applications often need practical guidance on how to structure prompts for complex workflows such as:
This notebook provides a structured set of prompt patterns and examples that developers can reuse when designing GPT-5.4 workflows.
The goal is to extend the existing GPT-5 prompting guidance in the Cookbook with a focused guide for GPT-5.4 while maintaining consistency with the structure and style of the existing GPT-5.2 guide.
For new content
I have added a new entry in [registry.yaml](https://github.com/openai/openai-cookbook/blob/main/registry.yaml) (and, optionally, in [authors.yaml](https://github.com/openai/openai-cookbook/blob/main/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](https://github.com/openai/openai-cookbook/blob/main/CONTRIBUTING.md#rubric):
Relevance: The notebook focuses on prompt design patterns for GPT-5-class models and is intended to help developers building applications with OpenAI models.
Uniqueness: I reviewed existing Cookbook examples and confirmed that this notebook focuses specifically on GPT-5.4 prompt patterns and workflow considerations.
Spelling and Grammar: I reviewed the document for spelling and grammatical accuracy.
Clarity: The notebook is structured in clearly separated sections covering prompting patterns, workflows, and examples.
Correctness: The code examples follow the current OpenAI Responses API structure and execute successfully.
Completeness: The guide includes explanations, examples, and references necessary for developers to understand and apply the patterns.