docs: update for pipecat PR #4592#853
Open
markbackman wants to merge 1 commit into
Open
Conversation
Update LLMUserAggregatorParams deprecated field descriptions to match the cleaned-up docstrings from pipecat PR #4592, which removed inline [DEPRECATED] tags while keeping Sphinx directives. Changes: - filter_incomplete_user_turns: Lead with functional description (turn-completion markers) instead of generic "Enable..." text - user_turn_completion_config: Clarify it's only used in the deprecated path and recommend the new strategy-based API
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 #4592.
Changes
api-reference/server/utilities/turn-management/filter-incomplete-turns.mdx
Updated the deprecated parameter descriptions for
filter_incomplete_user_turnsanduser_turn_completion_configto align with the source code changes in pipecat PR #4592:filter_incomplete_user_turns: Updated description to lead with the functional explanation (turn-completion markers: ✓, ○, ◐) instead of generic "Enable LLM-based turn completion detection" text. This matches the source docstring which now presents functionality first, followed by the deprecation directive.
user_turn_completion_config: Enhanced description to clarify that this parameter is only used when
filter_incomplete_user_turnsisTrue(the deprecated path), and that the new strategy-based API should useFilterIncompleteUserTurnStrategies(config=...)instead.Both parameters retain their
deprecatedattribute and deprecation notices, consistent with the Sphinx.. deprecated::directive in the source.Gaps identified
None