strands.experimental.bidi.types.events

Bidirectional streaming types for real-time audio/text conversations.

Type definitions for bidirectional streaming that extends Strands’ existing streaming capabilities with real-time audio and persistent connection support.

Key features:

• Audio input/output events with standardized formats
• Interruption detection and handling
• Connection lifecycle management
• Provider-agnostic event types
• Type-safe discriminated unions with TypedEvent
• JSON-serializable events (audio/images stored as base64 strings)

Audio format normalization:

• Supports PCM, WAV, Opus, and MP3 formats
• Standardizes sample rates (16kHz, 24kHz, 48kHz)
• Normalizes channel configurations (mono/stereo)
• Abstracts provider-specific encodings
• Audio data stored as base64-encoded strings for JSON compatibility

AudioChannel

Number of audio channels.

• Mono: 1
• Stereo: 2

AudioFormat

Audio encoding format.

AudioSampleRate

Audio sample rate in Hz.

Role

Role of a message sender.

• “user”: Messages from the user to the assistant.
• “assistant”: Messages from the assistant to the user.

StopReason

Reason for the model ending its response generation.

• “complete”: Model completed its response.
• “error”: Model encountered an error.
• “interrupted”: Model was interrupted by the user.
• “tool_use”: Model is requesting a tool use.

BidiTextInputEvent

class BidiTextInputEvent(TypedEvent)

Defined in: src/strands/experimental/bidi/types/events.py:97

Text input event for sending text to the model.

Used for sending text content through the send() method.

Arguments:

• text - The text content to send to the model.
• role - The role of the message sender (default: “user”).

__init__

def __init__(text: str, role: Role = "user")

Defined in: src/strands/experimental/bidi/types/events.py:107

Initialize text input event.

text

@property
def text() -> str

Defined in: src/strands/experimental/bidi/types/events.py:118

The text content to send to the model.

role

@property
def role() -> Role

Defined in: src/strands/experimental/bidi/types/events.py:123

The role of the message sender.

BidiAudioInputEvent

class BidiAudioInputEvent(TypedEvent)

Defined in: src/strands/experimental/bidi/types/events.py:128

Audio input event for sending audio to the model.

Used for sending audio data through the send() method.

Arguments:

• audio - Base64-encoded audio string to send to model.
• format - Audio format from SUPPORTED_AUDIO_FORMATS.
• sample_rate - Sample rate from SUPPORTED_SAMPLE_RATES.
• channels - Channel count from SUPPORTED_CHANNELS.

__init__

def __init__(audio: str, format: AudioFormat | str,
             sample_rate: AudioSampleRate, channels: AudioChannel)

Defined in: src/strands/experimental/bidi/types/events.py:140

Initialize audio input event.

audio

@property
def audio() -> str

Defined in: src/strands/experimental/bidi/types/events.py:159

Base64-encoded audio string.

format

@property
def format() -> AudioFormat

Defined in: src/strands/experimental/bidi/types/events.py:164

Audio encoding format.

sample_rate

@property
def sample_rate() -> AudioSampleRate

Defined in: src/strands/experimental/bidi/types/events.py:169

Number of audio samples per second in Hz.

channels

@property
def channels() -> AudioChannel

Defined in: src/strands/experimental/bidi/types/events.py:174

Number of audio channels (1=mono, 2=stereo).

BidiImageInputEvent

class BidiImageInputEvent(TypedEvent)

Defined in: src/strands/experimental/bidi/types/events.py:179

Image input event for sending images/video frames to the model.

Used for sending image data through the send() method.

Arguments:

• image - Base64-encoded image string.
• mime_type - MIME type (e.g., “image/jpeg”, “image/png”).

__init__

def __init__(image: str, mime_type: str)

Defined in: src/strands/experimental/bidi/types/events.py:189

Initialize image input event.

image

@property
def image() -> str

Defined in: src/strands/experimental/bidi/types/events.py:204

Base64-encoded image string.

mime_type

@property
def mime_type() -> str

Defined in: src/strands/experimental/bidi/types/events.py:209

MIME type of the image (e.g., “image/jpeg”, “image/png”).

BidiConnectionStartEvent

class BidiConnectionStartEvent(TypedEvent)

Defined in: src/strands/experimental/bidi/types/events.py:219

Streaming connection established and ready for interaction.

Arguments:

• connection_id - Unique identifier for this streaming connection.
• model - Model identifier (e.g., “gpt-realtime”, “gemini-2.0-flash-live”).

__init__

def __init__(connection_id: str, model: str)

Defined in: src/strands/experimental/bidi/types/events.py:227

Initialize connection start event.

connection_id

@property
def connection_id() -> str

Defined in: src/strands/experimental/bidi/types/events.py:238

Unique identifier for this streaming connection.

model

@property
def model() -> str

Defined in: src/strands/experimental/bidi/types/events.py:243

Model identifier (e.g., ‘gpt-realtime’, ‘gemini-2.0-flash-live’).

BidiConnectionRestartEvent

class BidiConnectionRestartEvent(TypedEvent)

Defined in: src/strands/experimental/bidi/types/events.py:248

Agent is restarting the model connection after timeout.

__init__

def __init__(timeout_error: "BidiModelTimeoutError")

Defined in: src/strands/experimental/bidi/types/events.py:251

Initialize.

Arguments:

• timeout_error - Timeout error reported by the model.

timeout_error

@property
def timeout_error() -> "BidiModelTimeoutError"

Defined in: src/strands/experimental/bidi/types/events.py:265

Model timeout error.

BidiResponseStartEvent

class BidiResponseStartEvent(TypedEvent)

Defined in: src/strands/experimental/bidi/types/events.py:270

Model starts generating a response.

Arguments:

• response_id - Unique identifier for this response (used in response.complete).

__init__

def __init__(response_id: str)

Defined in: src/strands/experimental/bidi/types/events.py:277

Initialize response start event.

response_id

@property
def response_id() -> str

Defined in: src/strands/experimental/bidi/types/events.py:282

Unique identifier for this response.

BidiAudioStreamEvent

class BidiAudioStreamEvent(TypedEvent)

Defined in: src/strands/experimental/bidi/types/events.py:287

Streaming audio output from the model.

Arguments:

• audio - Base64-encoded audio string.
• format - Audio encoding format.
• sample_rate - Number of audio samples per second in Hz.
• channels - Number of audio channels (1=mono, 2=stereo).

__init__

def __init__(audio: str, format: AudioFormat, sample_rate: AudioSampleRate,
             channels: AudioChannel)

Defined in: src/strands/experimental/bidi/types/events.py:297

Initialize audio stream event.

audio

@property
def audio() -> str

Defined in: src/strands/experimental/bidi/types/events.py:316

Base64-encoded audio string.

format

@property
def format() -> AudioFormat

Defined in: src/strands/experimental/bidi/types/events.py:321

Audio encoding format.

sample_rate

@property
def sample_rate() -> AudioSampleRate

Defined in: src/strands/experimental/bidi/types/events.py:326

Number of audio samples per second in Hz.

channels

@property
def channels() -> AudioChannel

Defined in: src/strands/experimental/bidi/types/events.py:331

Number of audio channels (1=mono, 2=stereo).

BidiTranscriptStreamEvent

class BidiTranscriptStreamEvent(ModelStreamEvent)

Defined in: src/strands/experimental/bidi/types/events.py:336

Audio transcription streaming (user or assistant speech).

Supports incremental transcript updates for providers that send partial transcripts before the final version.

Arguments:

• delta - The incremental transcript change (ContentBlockDelta).
• text - The delta text (same as delta content for convenience).
• role - Who is speaking (“user” or “assistant”).
• is_final - Whether this is the final/complete transcript.
• current_transcript - The accumulated transcript text so far (None for first delta).

__init__

def __init__(delta: ContentBlockDelta,
             text: str,
             role: Role,
             is_final: bool,
             current_transcript: str | None = None)

Defined in: src/strands/experimental/bidi/types/events.py:350

Initialize transcript stream event.

delta

@property
def delta() -> ContentBlockDelta

Defined in: src/strands/experimental/bidi/types/events.py:371

The incremental transcript change.

text

@property
def text() -> str

Defined in: src/strands/experimental/bidi/types/events.py:376

The text content to send to the model.

role

@property
def role() -> Role

Defined in: src/strands/experimental/bidi/types/events.py:381

The role of the message sender.

is_final

@property
def is_final() -> bool

Defined in: src/strands/experimental/bidi/types/events.py:386

Whether this is the final/complete transcript.

current_transcript

@property
def current_transcript() -> str | None

Defined in: src/strands/experimental/bidi/types/events.py:391

The accumulated transcript text so far.

BidiInterruptionEvent

class BidiInterruptionEvent(TypedEvent)

Defined in: src/strands/experimental/bidi/types/events.py:396

Model generation was interrupted.

Arguments:

• reason - Why the interruption occurred.

__init__

def __init__(reason: Literal["user_speech", "error"])

Defined in: src/strands/experimental/bidi/types/events.py:403

Initialize interruption event.

reason

@property
def reason() -> str

Defined in: src/strands/experimental/bidi/types/events.py:413

Why the interruption occurred.

BidiResponseCompleteEvent

class BidiResponseCompleteEvent(TypedEvent)

Defined in: src/strands/experimental/bidi/types/events.py:418

Model finished generating response.

Arguments:

• response_id - ID of the response that completed (matches response.start).
• stop_reason - Why the response ended.

__init__

def __init__(response_id: str, stop_reason: StopReason)

Defined in: src/strands/experimental/bidi/types/events.py:426

Initialize response complete event.

response_id

@property
def response_id() -> str

Defined in: src/strands/experimental/bidi/types/events.py:441

Unique identifier for this response.

stop_reason

@property
def stop_reason() -> StopReason

Defined in: src/strands/experimental/bidi/types/events.py:446

Why the response ended.

ModalityUsage

class ModalityUsage(dict)

Defined in: src/strands/experimental/bidi/types/events.py:451

Token usage for a specific modality.

Attributes:

• modality - Type of content.
• input_tokens - Tokens used for this modality’s input.
• output_tokens - Tokens used for this modality’s output.

BidiUsageEvent

class BidiUsageEvent(TypedEvent)

Defined in: src/strands/experimental/bidi/types/events.py:465

Token usage event with modality breakdown for bidirectional streaming.

Tracks token consumption across different modalities (audio, text, images) during bidirectional streaming sessions.

Arguments:

• input_tokens - Total tokens used for all input modalities.
• output_tokens - Total tokens used for all output modalities.
• total_tokens - Sum of input and output tokens.
• modality_details - Optional list of token usage per modality.
• cache_read_input_tokens - Optional tokens read from cache.
• cache_write_input_tokens - Optional tokens written to cache.

__init__

def __init__(input_tokens: int,
             output_tokens: int,
             total_tokens: int,
             modality_details: list[ModalityUsage] | None = None,
             cache_read_input_tokens: int | None = None,
             cache_write_input_tokens: int | None = None)

Defined in: src/strands/experimental/bidi/types/events.py:480

Initialize usage event.

input_tokens

@property
def input_tokens() -> int

Defined in: src/strands/experimental/bidi/types/events.py:505

Total tokens used for all input modalities.

output_tokens

@property
def output_tokens() -> int

Defined in: src/strands/experimental/bidi/types/events.py:510

Total tokens used for all output modalities.

total_tokens

@property
def total_tokens() -> int

Defined in: src/strands/experimental/bidi/types/events.py:515

Sum of input and output tokens.

modality_details

@property
def modality_details() -> list[ModalityUsage]

Defined in: src/strands/experimental/bidi/types/events.py:520

Optional list of token usage per modality.

cache_read_input_tokens

@property
def cache_read_input_tokens() -> int | None

Defined in: src/strands/experimental/bidi/types/events.py:525

Optional tokens read from cache.

cache_write_input_tokens

@property
def cache_write_input_tokens() -> int | None

Defined in: src/strands/experimental/bidi/types/events.py:530

Optional tokens written to cache.

BidiConnectionCloseEvent

class BidiConnectionCloseEvent(TypedEvent)

Defined in: src/strands/experimental/bidi/types/events.py:535

Streaming connection closed.

Arguments:

• connection_id - Unique identifier for this streaming connection (matches BidiConnectionStartEvent).
• reason - Why the connection was closed.

__init__

def __init__(connection_id: str,
             reason: Literal["client_disconnect", "timeout", "error",
                             "complete", "user_request"])

Defined in: src/strands/experimental/bidi/types/events.py:543

Initialize connection close event.

connection_id

@property
def connection_id() -> str

Defined in: src/strands/experimental/bidi/types/events.py:558

Unique identifier for this streaming connection.

reason

@property
def reason() -> str

Defined in: src/strands/experimental/bidi/types/events.py:563

Why the interruption occurred.

BidiErrorEvent

class BidiErrorEvent(TypedEvent)

Defined in: src/strands/experimental/bidi/types/events.py:568

Error occurred during the session.

Stores the full Exception object as an instance attribute for debugging while keeping the event dict JSON-serializable. The exception can be accessed via the error property for re-raising or type-based error handling.

Arguments:

• error - The exception that occurred.
• details - Optional additional error information.

__init__

def __init__(error: Exception, details: dict[str, Any] | None = None)

Defined in: src/strands/experimental/bidi/types/events.py:580

Initialize error event.

error

@property
def error() -> Exception

Defined in: src/strands/experimental/bidi/types/events.py:599

The original exception that occurred.

Can be used for re-raising or type-based error handling.

code

@property
def code() -> str

Defined in: src/strands/experimental/bidi/types/events.py:607

Error code derived from exception class name.

message

@property
def message() -> str

Defined in: src/strands/experimental/bidi/types/events.py:612

Human-readable error message from the exception.

details

@property
def details() -> dict[str, Any] | None

Defined in: src/strands/experimental/bidi/types/events.py:617

Additional error context beyond the exception itself.

BidiInputEvent

Union of different bidi input event types.

BidiOutputEvent

Union of different bidi output event types.