You've already forked adk-python
mirror of
https://github.com/encounter/adk-python.git
synced 2026-03-30 10:57:20 -07:00
Josh Soref
59d422ca21
Merge https://github.com/google/adk-python/pull/3394 This PR corrects misspellings identified by the [check-spelling action](https://github.com/marketplace/actions/check-spelling) Note: while I use tooling to identify errors, the tooling doesn't _actually_ provide the corrections, I'm picking them on my own. I'm a human, and I may make mistakes. ### Testing Plan The misspellings have been reported at https://github.com/jsoref/adk-python/actions/runs/19056081305/attempts/1#summary-54426435973 The action reports that the changes in this PR would make it happy: https://github.com/jsoref/adk-python/actions/runs/19056081446/attempts/1#summary-54426436321 **Unit Tests:** - [ ] I have added or updated unit tests for my change. - [ ] All unit tests pass locally. _Please include a summary of passed `pytest` results._ **Manual End-to-End (E2E) Tests:** _Please provide instructions on how to manually test your changes, including any necessary setup or configuration. Please provide logs or screenshots to help reviewers better understand the fix._ ### Checklist - [x] I have read the [CONTRIBUTING.md](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md) document. - [x] I have performed a self-review of my own code. - [ ] I have commented my code, particularly in hard-to-understand areas. - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] New and existing unit tests pass locally with my changes. - [ ] I have manually tested my changes end-to-end. - [ ] Any dependent changes have been merged and published in downstream modules. ### Additional context - https://github.com/google/adk-python/pull/3382#issuecomment-3488654110 COPYBARA_INTEGRATE_REVIEW=https://github.com/google/adk-python/pull/3394 from jsoref:spelling-contributing c3d5e342c4350f7cae9f8f0c6638b176f2e30e80 PiperOrigin-RevId: 828659867
What's this?
This is a sample that shows how to start the ADK api server, and how to connect your agents in a live(bidi-streaming) way. It works text and audio input, and the response is always audio.
Prerequisite
- Make sure you go through https://google.github.io/adk-docs/streaming/
Instruction for this sample
- The audio libraries we used here doesn't have noise cancellation. So the noise may feed back to the model. You can use headset to avoid this or tune down voice volume, or implement your own noise cancellation logic.
- Please ensure you grant the right mic/sound device permission to the terminal that runs the script. Sometimes, terminal inside VSCode etc doesn't really work well. So try native terminals if you have permission issue.
- start api server first for your agent folder. For example, my agents are
located in contributing/samples. So I will run
adk api_server contributing/samples/. Keep this running. - then in a separate window, run
python3 live_agent_example.py
Misc
- Provide a few pre-recorded audio files for testing.