FunctionFilter

​

Overview

​

Constructor Parameters

​

Functionality

1. Lifecycle frames are always passed through, and so are other system frames unless filter_system_frames is True
2. Frames moving in a different direction than specified are always passed through
3. Other frames are passed to the filter function
4. If the filter function returns True, the frame is passed through

​

Output Frames

• Frame type (lifecycle frames always pass, and system frames pass unless filter_system_frames is True)
• Frame direction (only filters in the specified direction)
• Result of the custom filter function

​

Usage Example

from pipecat.frames.frames import TextFrame, Frame
from pipecat.pipeline.pipeline import Pipeline
from pipecat.processors.filters.function_filter import FunctionFilter
from pipecat.processors.frame_processor import FrameDirection

# Create filter that only allows TextFrames with more than 10 characters
async def long_text_filter(frame: Frame) -> bool:
    if isinstance(frame, TextFrame):
        return len(frame.text) > 10
    return False

# Apply filter to downstream frames only
text_length_filter = FunctionFilter(
    filter=long_text_filter,
    direction=FrameDirection.DOWNSTREAM
)

# Add to pipeline
pipeline = Pipeline([
    source,
    text_length_filter,  # Filters out short text frames
    destination
])

​

Frame Flow

​

Notes

• Provides maximum flexibility for complex filtering logic
• Can incorporate dynamic conditions that change at runtime
• Only filters frames moving in the specified direction
• Always passes through system frames for proper pipeline operation
• Can be used to create sophisticated content-based filters
• Supports async filter functions for complex processing