Firebase.AI.RealtimeInputConfig

Configures model input behavior when generating content in the Live API via the realtime supported methods

Summary

Constructors and Destructors
RealtimeInputConfig(ActivityDetectionConfig? automaticActivityDetection, ActivityHandling? activityHandling, TurnCoverage? turnCoverage)
Creates a new RealtimeInputConfig value.

Public types
ActivityHandling{
  Interrupt,
  NoInterrupt
} 		enum
How a model handles user input activity.
TurnCoverage{
  OnlyActivity,
  AllInput,
  AudioActivityAndAllVideo
} 		enum
How the model considers which input is included in the user's turn.

Public attributes
AutomaticActivityDetection => _automaticActivityDetection
Configures automatic activity detection on the model.
Coverage => _turnCoverage
Defines which input is included in the user's turn.
Handling => _activityHandling
Defines how the model treats user input activity.

Public types

ActivityHandling

 Firebase::AI::RealtimeInputConfig::ActivityHandling

How a model handles user input activity.

Properties
Interrupt

When the user sends input marking the start of activity, the model's current response will be cut-off immediately.

NoInterrupt

When the user sends input marking the start of activity, the model will process it, but won't cut-off its current response.

TurnCoverage

 Firebase::AI::RealtimeInputConfig::TurnCoverage

How the model considers which input is included in the user's turn.

Properties
AllInput

The model will include all input (including inactivity) since the last turn as the user's input.

AudioActivityAndAllVideo

Includes audio activity and all video since the last turn.

With automatic activity detection, audio activity means speech and excludes silence.

OnlyActivity

The model will exclude inactivity (e.g, silence on the audio stream) from the user's input.

Public attributes

AutomaticActivityDetection

ActivityDetectionConfig Firebase::AI::RealtimeInputConfig::AutomaticActivityDetection => _automaticActivityDetection

Configures automatic activity detection on the model.

Coverage

TurnCoverage Firebase::AI::RealtimeInputConfig::Coverage => _turnCoverage

Defines which input is included in the user's turn.

Handling

ActivityHandling Firebase::AI::RealtimeInputConfig::Handling => _activityHandling

Defines how the model treats user input activity.

Public functions

RealtimeInputConfig

 Firebase::AI::RealtimeInputConfig::RealtimeInputConfig(
  ActivityDetectionConfig? automaticActivityDetection,
  ActivityHandling? activityHandling,
  TurnCoverage? turnCoverage
)

Creates a new RealtimeInputConfig value.

Details
Parameters
automaticActivityDetection
Configures automatic activity detection on the model.
activityHandling
Defines how the model treats user input activity.
turnCoverage
Defines which input is included in the user's turn.