mirror of
https://github.com/google/adk-docs.git
synced 2026-09-14 16:16:59 +08:00
Kaz Sato
e1c5d8b780
* docs(runtime): correct TypeScript claims in RunConfig streaming docs The streaming sections of runtime/runconfig.md told TypeScript readers three things that are not true of the TypeScript SDK. - The BIDI bullet directed readers to `runner.run_live()`. That entry point does not exist in TypeScript: `Runner` exposes no `runLive()` and `LlmAgent.runLiveFlow` throws. The bullet also omitted that passing BIDI degrades to non-streaming with no error and no warning. - The TypeScript tab recommended `supportCfc: true`. Copying it yields a single event with `errorCode: 'UNKNOWN_ERROR'` and `errorMessage: 'CFC is not yet supported in callLlmAsync'` and no response text at all. Removed from the snippet and documented in the existing experimental admonition. - "Configure live agents" carried a TypeScript support tag and a TypeScript snippet, but the whole section describes `run_live()` parameters. The three fields the TypeScript `RunConfig` declares feed only `liveConnectConfig`, which nothing reachable consumes. Tag and snippet removed, with a note explaining why the fields exist but do nothing. Verified against @google/adk 1.6.0 and adk-js at HEAD; `mkdocs build --strict` is clean. * docs(runtime): name the streaming mode property per language The prose said "set the `streaming_mode` parameter" in a language-neutral sentence, but the TypeScript property is `streamingMode` (as the TypeScript code tab below it already shows). * docs(runtime): apply review feedback on the streaming sections Addresses @joefernandez's review of #2101 and the staleness the technical review report found in three of the four original changes. Two adk-js merges landed after this PR was written and invalidated its TypeScript claims: adk-js#692 (2026-08-13) makes StreamingMode.BIDI throw instead of silently degrading, and adk-js#523 (2026-08-18) implements Runner.runLive and the LlmAgent live flow. Rather than re-state per-SDK behavior that is still moving, the TypeScript-specific claims are dropped entirely, per the review direction not to document what a feature does not do. - Rename "Enable streaming" to "Text response options" and reword the intro so it cannot be confused with the Live and voice path. The #enable-streaming anchor is preserved via attr_list, since docs/live/configuration.md links to it and external links may too. - Drop the per-language property-name parenthetical. The snippets below already show the syntax, and it was wrong for Go, Java and Kotlin. - Replace the StreamingMode.BIDI bullet with a paragraph pointing at Live and Voice Agents, instead of listing BIDI as a parallel option to NONE and SSE. - Drop the "run_live() is not available in the TypeScript SDK" warning; both Runner.runLive and LlmAgent.runLiveFlow exist at adk-js HEAD. - Drop the TypeScript detail from the CFC "Experimental" admonition. Removing supportCfc: true from the TypeScript snippet stands: it still throws at llm_agent.ts and surfaces as an error event with no response text. - Restore the TypeScript language tag and snippet under "Configure live agents" and add the Java tag. The three TypeScript fields are in LIVE_KEYS and are applied by the now-working live flow; Java has Runner.runLive and implements avatar_config. - Lead "Configure live agents" with a pointer to Live and Voice Agents. * docs(runtime): add Java live RunConfig example * Apply batched suggestions from code review Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com> * Apply batched suggestions from code review Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com> --------- Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com>