docs: document prompt API usage#26
Open
varin-nair-factory wants to merge 8 commits into
Open
Conversation
factory-davidgu
previously approved these changes
May 2, 2026
varin-nair-factory
force-pushed
the
vn/prompt-one-shot
branch
3 times, most recently
from
596dfa8 to
d50f4f4
Compare
varin-nair-factory
dismissed
factory-davidgu’s stale review
The base branch was changed.
Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
varin-nair-factory
force-pushed
the
vn/prompt-docs
branch
from
08fc79e to
1d729b2
Compare
Update docs and example scripts to use the run API, safer temp-file flows, and lint/typecheck coverage for examples. Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
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
2 participants
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
run()as the one-shot aggregated-result API while keepingquery()as the streaming one-shot API.DroidResult/ message sends.Validation
npm run typechecknpm run typecheck:examplesnpm run format:checknpm testnpm run lintnpm run builddroid-devsmoke checks for structured output, result metadata, query streaming, abort handling, and SDK MCP tool usage