Skip to content

Publish Practical guide to data-intensive apps with the Realtime API #1868

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 29, 2025

Conversation

alistair-openai
Copy link
Contributor

@alistair-openai alistair-openai commented May 29, 2025

Summary

New cookbook on Data-intensive apps using the Realtime API, specifically focused on Realtime conversations.

Motivation

Devs love to give Realtime agents access to large amounts of data. This cookbook provides guiding principles on how to avoid common failure modes in these settings.


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.

@alistair-openai alistair-openai requested a review from Copilot May 29, 2025 12:59
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.

@alistair-openai alistair-openai self-assigned this May 29, 2025
@alistair-openai alistair-openai changed the title Publish Practical guide to data-intensive apps with the Realtime AP Publish Practical guide to data-intensive apps with the Realtime API May 29, 2025
Copy link
Contributor

@charu-openai charu-openai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@alistair-openai alistair-openai marked this pull request as ready for review May 29, 2025 21:19
@alistair-openai alistair-openai merged commit f0cc298 into main May 29, 2025
1 check passed
@alistair-openai alistair-openai deleted the alistair-realtime-data-heavy branch May 29, 2025 21:24
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