docs: update for pipecat PR #4815#937
Open
pipecat-docs-bot[bot] wants to merge 1 commit into
Open
Conversation
Updates API reference for WorkerRunner, PipelineWorker, and BaseWorker to reflect the task manager injection changes: - WorkerRunner: Added task_manager and check_dangling_tasks parameters; deprecated loop parameter - PipelineWorker: Updated check_dangling_tasks description to clarify ownership semantics - BaseWorker: Added task_manager and check_dangling_tasks parameters Corresponding to changes in pipecat-ai/pipecat#4815
pipecat-docs-bot
Bot
added
auto-docs
Contributor
|
🔍 Mintlify preview for this branch: https://daily-docs-pr-4815.mintlify.app |
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 #4815.
Changes
Updated API reference pages
api-reference/server/workers/runner.mdx— Addedtask_managerandcheck_dangling_tasksparameters; markedloopparameter as deprecated (1.5.0, removed in 2.0.0)api-reference/server/pipeline/pipeline-worker.mdx— Updatedcheck_dangling_tasksdescription to clarify that it only applies when the worker owns its task managerapi-reference/server/workers/base-worker.mdx— Addedtask_managerandcheck_dangling_tasksparametersSummary of pipecat PR #4815
The PR introduces injectable task managers to allow sharing a single event loop and context across the runner and all workers:
TaskManagercan now be constructed with an event loop and optionalcontextvars.ContextWorkerRunneraccepts atask_managerparameter (replaces the deprecatedloopparameter)WorkerRunnerandBaseWorkeraccept acheck_dangling_tasksparameterGaps identified
None — all relevant public API changes are documented.