docs(fallback): add searchable Agent/Inference Fallback Adapter prefixes#1399
Closed
toubatbrian wants to merge 1 commit into
Closed
docs(fallback): add searchable Agent/Inference Fallback Adapter prefixes#1399toubatbrian wants to merge 1 commit into
toubatbrian wants to merge 1 commit into
Conversation
Mirror the docstring update from livekit/agents#5654 so the agent-side fallback adapters (LLM/STT/TTS) and the inference-side FallbackModel typed configs are easy to locate from the docs. Ports livekit/agents#5654 from livekit/agents.
🦋 Changeset detectedLatest commit: 249aa39 The changes in this PR will be included in the next version bump. This PR includes changesets to release 29 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
|
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
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
Ports the docstring update from livekit/agents#5654 ("add comments to agent side and inference side fallback adapters") into agents-js. The Python PR adds searchable "Agent Fallback Adapter for X" and "Inference Fallback Adapter" prefixes to the relevant docstrings so the LiveKit docs team can deep-link to the correct piece of code (agent-side fallback vs. inference-side fallback) from user-facing documentation.
Files updated
Agent-side fallback adapters — added the "Agent Fallback Adapter for LLM/STT/TTS. Manages multiple X instances with automatic fallback when the primary provider fails." prefix:
agents/src/llm/fallback_adapter.ts—FallbackAdapterclass docstringagents/src/stt/fallback_adapter.ts—FallbackAdapterclass docstring (preserved the existing detailed body about probe streams andStreamAdapterwrapping)agents/src/tts/fallback_adapter.ts—FallbackAdapterclass docstring (preserved the existing Features list and example)Inference-side fallback model configs — replaced the generic "A fallback model with optional extra configuration" comment with the searchable "Inference Fallback Adapter: configuration for a fallback STT/TTS model that runs server-side in LiveKit Inference, providing automatic fallback between providers." prefix:
agents/src/inference/stt.ts—STTFallbackModelinterfaceagents/src/inference/tts.ts—TTSFallbackModelinterfaceImplementation notes / parity caveats
FallbackModelis aTypedDict; the JS equivalent is a TSinterfacenamedSTTFallbackModel/TTSFallbackModel(the TS files prefix the type with the modality to distinguish the STT and TTS variants). The doc text is the same; only the symbol it sits on differs.@exampleblock for TTS, etc.). Rather than overwriting that content with the shorter Python prefix, this PR prepends the searchable prefix to the first line and preserves the existing body so the published TSDoc keeps the additional context. This matches the spirit of the Python PR (make the code findable) without losing JS-specific documentation.Changeset
@livekit/agents: patch.Test plan
pnpm api:checkpasses (no exported types changed; only doc comments)pnpm buildpassescc @toubatbrian @livekit/agent-devs
Ports livekit/agents#5654 from
livekit/agents.Generated by Claude Code