docs: update README (fixes #2119) #2284
Open
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.
Updated the README introduction to address Issue #2119 by:
Summary
This PR modernizes the README introduction to reflect current OpenAI APIs and correct example directory references, addressing Issue #2119.
Motivation
The current README introduction was no longer adequate for new users to the Cookbook.
The two primary ways in which it created friction were:
The other significant issue with the previous README introduction was the minimal onboarding experience provided. There were no clear instructions for new users to set up Cookbook with the different environments.
The final issue with the original README introduction was that the example index was incomplete. There were many examples missing from the directory (i.e., Python, JavaScript, Assistants, Data ETL, etc.).
This update provides developers with the necessary information about what is available in the Cookbook and provides them with clear guidance on how they can quickly start working with the API without any confusion.
What was changed:
gpt-4o,gpt-4o-mini,gpt-4o-audio-preview).response_format(structured output) were documented.For new content
When contributing new content, read through our contribution guidelines, and mark the following action items as completed:
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.