docs: update for pipecat PR #4447#807
Open
markbackman wants to merge 1 commit into
Open
Conversation
- Add note about cancel_on_interruption=False support in both services - Document Ultravox's placeholder behavior for async tools - Document Grok's async tool result delivery mechanism - Add links to new async tool example files - Note that streamed intermediate results are not supported Related to pipecat-ai/pipecat#4447
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 #4447.
Changes
Grok Realtime (
api-reference/server/services/s2s/grok.mdx)cancel_on_interruption=False)is_final=False) are not supportedrealtime-grok-async-tool.pyUltravox Realtime (
api-reference/server/services/s2s/ultravox.mdx)cancel_on_interruption=False)client_tool_resultimmediately to unfreeze the conversation, then injects actual result as user-side textis_final=False) are not supportedrealtime-ultravox-async-tool.pyGaps identified
Missing doc page: Azure Realtime S2S
The PR also extends async tool support to
AzureRealtimeLLMService(atsrc/pipecat/services/azure/realtime/llm.py), but there is no corresponding documentation page atapi-reference/server/services/s2s/azure.mdx.Azure Realtime inherits from OpenAI Realtime and uses the same async tool handling approach as Grok. A new doc page should be created for this service.
Related source file:
src/pipecat/services/azure/realtime/llm.pyExample file:
examples/realtime/realtime-azure-async-tool.py