Skip to content

Realtime session

[BETA] Defines a base class for realtime session modules.

BaseRealtimeSession()

Bases: ABC

[BETA] A base class for realtime session modules.

The BaseRealtimeSession class provides a framework for processing real-time conversation sessions.

Initializes a new instance of the BaseRealtimeSession class.

start(input_streamers=None, output_streamers=None) async

Starts the real-time conversation session using the provided input and output streamers.

This method validates the input and output streamers, and then calls the _start method.

Parameters:

Name Type Description Default
input_streamers list[BaseInputStreamer] | None

The input streamers to use. Defaults to None.

None
output_streamers list[BaseOutputStreamer] | None

The output streamers to use. Defaults to None.

None

Raises:

Type Description
ValueError

If the input_streamers or output_streamers is an empty list.