Skip to content

docs(bidi): update python readme information for bidi - #4866

Merged
pgrayy merged 2 commits into
strands-agents:mainfrom
mehtarac:bidi_update_readme
Oct 4, 2026
Merged

pgrayy merged 2 commits into
strands-agents:mainfrom
mehtarac:bidi_update_readme

Conversation

@mehtarac

@mehtarac mehtarac commented Oct 4, 2026

Copy link
Copy Markdown
Member

Human Overview

Description

The bidi section of strands-py/README.md was out of date. Bidi graduated to strands.bidi (#4707), but the experimental warning stayed. The example's strands_tools.stop no longer ends a bidi conversation since cancellation moved to agent.cancel() (#4664). The install commands also only covered Nova Sonic. The section now has per-provider install commands, a minimal example, and a link to the quickstart. The root README links to the bidi docs.

Related Issues

N/A

Documentation PR

N/A. This PR is the documentation change.

Type of Change

Documentation update

Testing

Ran the example's setup on Python 3.12: imports resolve, the agent constructs, and agent.cancel() sets cancel_signal. Checked the extras against pyproject.toml. No live voice session was run.

  • I ran hatch run prepare

Checklist

  • I have read the CONTRIBUTING document
  • I have reviewed and understand every line of code in this PR, including any generated by AI tools, and I can explain why it works
  • My change is focused and reasonably small; I have split unrelated work into separate PRs
  • I have added any necessary tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@mehtarac
mehtarac requested a review from a team as a code owner October 4, 2026 22:56
@mehtarac
mehtarac requested a review from notowen333 October 4, 2026 22:56
@github-actions github-actions Bot added documentation Documentation changes, improvements, additions, content updates, site improvements, examples, guides area-bidirectional-streaming Related to bidirectional streaming python Pull requests that update python code strands-running size/s labels Oct 4, 2026
@github-actions

github-actions Bot commented Oct 4, 2026

Copy link
Copy Markdown
Contributor

Issue: The PR description states "The root README links to the bidi docs," but the diff only touches strands-py/README.md — there is no change to the root README.md.

Suggestion: Either include the root README link change in this PR, or update the description to match the actual scope so reviewers/changelog aren't misled. Minor, non-blocking.

(Also noting the "Human Overview" section is still the template HTML comment — per the PR template / AI usage policy a human should add a short overview in their own words.)

@github-actions

github-actions Bot commented Oct 4, 2026

Copy link
Copy Markdown
Contributor

Assessment: Approve

Clean, accurate rewrite of the bidi README section. I verified every technical claim against the source and pyproject.toml and everything checks out.

Verification details
  • Correctness: Experimental warning removal matches the strands.bidi graduation (feat(bidi): graduate bidirectional streaming API #4707); agent.cancel() replacing the stop tool matches cancellation moving to agent.cancel() (feat(bidi): support cancellation from custom tools #4664). ✅
  • Install commands: bidi, bidi-io, bidi-pyaudio, bidi-google, bidi-openai all exist in pyproject.toml; Gemini/OpenAI correctly omit the bidi extra (that one is Nova Sonic AWS deps only). ✅
  • Example: BidiAgent, AudioIO, BedrockNovaSonicModel are all exported; BidiAgent(model=...) with optional tools, and run(inputs=, outputs=) match current signatures. "Prints transcripts to the terminal" is accurate since AudioIO defaults to a transcript-enabled ConsoleIO. ✅
  • Links: quickstart link resolves (200). ✅

Minor, non-blocking notes left inline: description/scope mismatch (root README link not in diff), empty "Human Overview", and loss of the config-options pointer.

Nice improvement — the new section is noticeably easier to follow than the old one.

Comment thread strands-py/README.md Outdated
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 4, 2026

Copy link
Copy Markdown
Contributor

Suggestion (non-blocking, re: removed "Configuration Options" block): Trimming it makes the section much cleaner, but it also removes the only in-README pointer to the knobs people reach for early — custom voice, params (turn detection / inference config), and input_device_index/output_device_index. The quickstart link covers this, so this is fine as-is; just flagging that device selection in particular tends to be a frequent first question. Consider a one-line "for voice, audio config, and device selection, see the quickstart" if you want to set expectations.

@pgrayy
pgrayy merged commit e60a1e1 into strands-agents:main Oct 4, 2026
23 of 25 checks passed
@pgrayy
pgrayy deleted the bidi_update_readme branch October 4, 2026 23:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-bidirectional-streaming Related to bidirectional streaming documentation Documentation changes, improvements, additions, content updates, site improvements, examples, guides python Pull requests that update python code size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants