docs: update for pipecat PR #4533#856
Open
markbackman wants to merge 1 commit into
Open
Conversation
Updated documentation for all realtime (s2s) services to clarify: - Whether each service emits UserStartedSpeakingFrame/UserStoppedSpeakingFrame - How to use with LLMContextAggregatorPair(..., realtime_service_mode=True) - How to handle local VAD configuration when needed - References to relevant example files Services that emit turn frames: - OpenAI Realtime - Grok Realtime - Inworld Realtime Services that do NOT emit turn frames: - Gemini Live - Ultravox - AWS Nova Sonic Corresponds to pipecat PR #4533
markbackman
added
auto-docs
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
1 participant
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.
Automated documentation update for pipecat PR #4533.
Changes
Updated all realtime (speech-to-speech) service documentation pages to clarify user turn frame behavior:
Services updated
OpenAI Realtime (
api-reference/server/services/s2s/openai.mdx)UserStartedSpeakingFrame/UserStoppedSpeakingFramefrom server-side VADrealtime_service_mode=TrueGemini Live (
api-reference/server/services/s2s/gemini-live.mdx)realtime_service_mode=TrueUltravox (
api-reference/server/services/s2s/ultravox.mdx)realtime_service_mode=TrueGrok Realtime (
api-reference/server/services/s2s/grok.mdx)realtime_service_mode=TrueInworld Realtime (
api-reference/server/services/s2s/inworld.mdx)realtime_service_mode=TrueAWS Nova Sonic (
api-reference/server/services/s2s/aws.mdx)realtime_service_mode=TrueSummary
All changes are additions to the Notes sections of each service page. The updates help users understand:
LLMContextAggregatorPairfor realtime servicesGaps identified
None - all relevant service documentation pages have been updated.