Skip to content

Conversation

minh-hoque
Copy link
Contributor

Summary

Briefly describe the changes and the goal of this PR. Make sure the PR title summarizes the changes effectively.

Motivation

Why are these changes necessary? How do they improve the cookbook?


For new content

When contributing new content, read through our contribution guidelines, and mark the following action items as completed:

  • 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.

We will rate each of these areas on a scale from 1 to 4, and will only accept contributions that score 3 or higher on all areas. Refer to our contribution guidelines for more details.

- Introduced a new guide for realtime prompting techniques in examples/Realtime_prompting_guide.ipynb.
- Updated registry.yaml to include metadata for the new guide.
- Added multiple audio files and images to support the guide.
- Updated kernel specifications in Reinforcement_Fine_Tuning.ipynb for consistency.
- Updated the Realtime prompting guide to include a comprehensive introduction to the new gpt-realtime model and its capabilities.
- Added multiple examples demonstrating various prompting techniques tailored for speech-to-speech interactions.
- Introduced new audio files and an image to support the guide's content.
- Improved formatting for clarity and consistency throughout the document.
- Modified the Realtime prompting guide to improve the flow of content and enhance clarity.
- Updated the tags in registry.yaml from 'prompt' to 'speech' to better reflect the guide's focus on speech-based interactions.
- Added new instructions regarding the `speed` parameter in the Realtime API to clarify its impact on playback rate.
- Updated the Realtime prompting guide to reflect the new gpt-realtime model, emphasizing improved instruction following and voice quality.
- Added a new section with general tips for effective prompting techniques.
- Revised existing content for clarity and consistency, including formatting changes and updated audio file references.
- Introduced a new audio file for better demonstration of concepts.
- Renamed the "Not Repeating Things (anti-robotic)" section to "Reduce Repetition" for better understanding.
- Added a new tip emphasizing the importance of clear instructions for optimal model performance.
- Enhanced explanations in the "Advanced Conversation Flow" section to clarify the balance between maintainability and simplicity.
- Improved descriptions in the "Conversation Flow as State Machine" and "Dynamic Conversation Flow" sections for better comprehension.
- Corrected the spelling of "enact" in the realtime model description.
- Fixed the spelling of "Length" in the tone section.
- Removed an outdated rule regarding caller identification in the proactive lookup_account section for better guidance.
- Revised text to enhance clarity, including changes to descriptions of the gpt-realtime model and its capabilities.
- Updated audio file references to reflect the new gpt-realtime model.
- Improved formatting and added additional context for better understanding of prompting techniques.
…ovements

- Updated execution counts in code cells for consistency.
- Replaced outdated audio file 'no_audio_or_gibberish.wav' with 'unclear_audio.wav' for better demonstration.
- Revised text in the guide to clarify instructions on tool usage and improve overall clarity.
- Revised text for improved clarity, including updates to examples and instructions on language control and repetition.
- Added a new section on prompt optimization to help users refine their prompts for better model performance.
- Enhanced descriptions to emphasize the importance of clear instructions and the impact of language constraints on model behavior.
- Corrected the spelling of "cought" to "cough" for accuracy.
- Enhanced the structure of escalation guidelines for better readability and clarity.
- Improved phrasing in the escalation section to provide clearer instructions for users.
…ments

- Updated the "Reduce Repetition" section for clarity and consistency.
- Added new tips on using capitalized text for emphasis and converting non-text rules to text for better understanding.
- Improved overall formatting to enhance readability and user experience.
…ution count adjustments

- Added bullet points for personality and tone descriptions for better readability.
- Updated execution counts in code cells for consistency.
- Revised audio file paths to ensure correct referencing.
- Enhanced clarity in instructional examples and tips throughout the guide.
@minh-hoque minh-hoque merged commit b46fe3c into main Aug 28, 2025
1 check passed
@minh-hoque minh-hoque deleted the minh/realtime_prompting_guide branch August 28, 2025 16:48
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