6faa50ae5b
- Usage in classes that are already deprecated - Usage related to realtime LLMs, which don't yet support `LLMContext` - Usage in (soon-to-be-deprecated) code paths related to `OpenAILLMContext` itself and associated machinery
52 lines
1.7 KiB
Python
52 lines
1.7 KiB
Python
#
|
||
# Copyright (c) 2024–2025, Daily
|
||
#
|
||
# SPDX-License-Identifier: BSD 2-Clause License
|
||
#
|
||
|
||
"""User response aggregation for text frames.
|
||
|
||
This module provides an aggregator that collects user responses and outputs
|
||
them as TextFrame objects, useful for capturing and processing user input
|
||
in conversational pipelines.
|
||
"""
|
||
|
||
from pipecat.frames.frames import TextFrame
|
||
from pipecat.processors.aggregators.llm_context import LLMContext
|
||
from pipecat.processors.aggregators.llm_response_universal import LLMUserAggregator
|
||
|
||
|
||
class UserResponseAggregator(LLMUserAggregator):
|
||
"""Aggregates user responses into TextFrame objects.
|
||
|
||
This aggregator extends LLMUserAggregator to specifically handle
|
||
user input by collecting text responses and outputting them as TextFrame
|
||
objects when the aggregation is complete.
|
||
"""
|
||
|
||
def __init__(self, **kwargs):
|
||
"""Initialize the user response aggregator.
|
||
|
||
Args:
|
||
**kwargs: Additional arguments passed to parent LLMUserAggregator.
|
||
"""
|
||
super().__init__(context=LLMContext(), **kwargs)
|
||
|
||
async def push_aggregation(self):
|
||
"""Push the aggregated user response as a TextFrame.
|
||
|
||
Creates a TextFrame from the current aggregation if it contains content,
|
||
resets the aggregation state, and pushes the frame downstream.
|
||
"""
|
||
if len(self._aggregation) > 0:
|
||
frame = TextFrame(self._aggregation.strip())
|
||
|
||
# Reset the aggregation. Reset it before pushing it down, otherwise
|
||
# if the tasks gets cancelled we won't be able to clear things up.
|
||
self._aggregation = ""
|
||
|
||
await self.push_frame(frame)
|
||
|
||
# Reset our accumulator state.
|
||
await self.reset()
|