docs: refresh the README for the v2 API#215
Merged
Merged
Conversation
The landing-page examples still used the v1 ResultEnvelope surface and would not run on v2. Align them with the shipped API: - run() returns Output (result.text); run_many()/collect_deferred() return OutputCollection (.answers); drop dict-subscript access. - Structured output kwarg is output=, not response_schema. - Drop the nonexistent defer_many() from the entry-point table. - Note local multimodal (text/image/audio) and optional model. Add a "Multi-Turn Threads and Agent Loops" section covering interact() and Session, plus links to the agent-loop and 2.0 migration guides.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
1 participant
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
The README landing-page examples still used the v1
ResultEnvelopesurface (result["answers"][0],response_schema,defer_many(), "text-only" local) and would not run on v2. This aligns the README with the shipped v2 API and surfaces the new agent-loop capabilities ahead of the 2.0 RC.run()returnsOutput(result.text);run_many()/collect_deferred()returnOutputCollection(.answers). Replaced dict-subscript access throughout.output=, notresponse_schema.defer_many()from the entry-point table.model.interact()/Session) and links to the agent-loop and 2.0 migration guides.Related issue
None
Test plan
run,run_many,Session.interactwith continuation): all attributes/methods exist and the shapes are correct.just lintpasses (ruff format --check,ruff check,rumdl check .- no issues across 31 files)./agent-loop/,/migrating-to-v2/) verified againstmkdocs.ymlnav.No code changed, so no unit tests were added (non-behavioral docs change).
Notes
None
just checkpasses