docs(examples): Add canonical OpenAI starter example (#2082)#2083
Open
navanpreet wants to merge 2 commits into567-labs:mainfrom
Open
docs(examples): Add canonical OpenAI starter example (#2082)#2083navanpreet wants to merge 2 commits into567-labs:mainfrom
navanpreet wants to merge 2 commits into567-labs:mainfrom
Conversation
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.
This PR addresses issue #2082 by adding a canonical OpenAI starter example at
examples/openai/run.py.This example demonstrates:
instructorclient usinginstructor.from_provider("openai/<model>").response_model..chat.completions.create(...)call utilizing theresponse_model.Motivation
This example serves as a clear, minimal entry point for new users looking to quickly get started with
instructorand OpenAI, addressing the fragmentation of existing examples mentioned in the issue. It focuses on the core functionality without additional complexity.All code has been formatted with
ruff formatand linted withruff check, and type-checked withmypy --strictto ensure compliance with the project's contributing guidelines.Resolves #2082