Skip to main content

okareo.augmentations

Voice simulation augmentation payload wrappers.

Import these from okareo.augmentations and pass them into Okareo.run_simulation(..., augmentation=...).

AugmentationConfig Objects​

@_attrs_define
class AugmentationConfig(_DictSerializable)

Base helper for simulation augmentation payload wrappers.

Subclasses are thin JSON shapers for simulation_params["augmentation"]. They serialize only the fields you set.

CAPAugmentation Objects​

@_attrs_define
class CAPAugmentation(AugmentationConfig)

Concurrent-ask augmentation config.

Arguments:

  • probability - Probability that the driver emits an extra follow-up message.
  • pause_ms - Pause duration in milliseconds before emitting the follow-up message.

DirectedSpeechAugmentation Objects​

@_attrs_define
class DirectedSpeechAugmentation(AugmentationConfig)

Directed-speech augmentation config.

Arguments:

  • probability - Probability that directed speech is injected for a given opportunity.
  • prompt - Optional independent prompt for the directed speech content.
  • lpf_cutoff_hz - Low-pass filter cutoff used for off-mic speech.
  • gain_db - Gain reduction applied to off-mic speech.

NoiseAugmentation Objects​

@_attrs_define
class NoiseAugmentation(AugmentationConfig)

Background noise augmentation config.

Arguments:

  • probability - Probability that background noise is applied during a run.
  • profile - Noise profile name, e.g. "cafeteria" or "traffic".
  • snr_db - Target signal-to-noise ratio in dB.

SecondarySpeakerAugmentation Objects​

@_attrs_define
class SecondarySpeakerAugmentation(AugmentationConfig)

Secondary-speaker augmentation config.

Arguments:

  • probability - Probability that a secondary-speaker segment is injected for a given opportunity.
  • voice - Voice identifier for the secondary speaker.
  • prompt - Optional independent prompt for the secondary speaker.
  • lpf_cutoff_hz - Optional low-pass filter cutoff applied only to the secondary speaker audio.
  • gain_db - Optional gain adjustment applied only to the secondary speaker audio.
  • inter_speaker_pause_ms - Optional pause inserted between the primary and secondary speaker audio segments.

BackchannelAugmentation Objects​

@_attrs_define
class BackchannelAugmentation(AugmentationConfig)

Backchannel injection augmentation config.

Arguments:

  • probability - Probability that a short backchannel is injected.
  • utterance - Optional backchannel text override, e.g. "mm-hmm".
  • min_offset_ms - Minimum delay before the injection fires.
  • max_offset_ms - Maximum delay before the injection fires.

BargeInAugmentation Objects​

@_attrs_define
class BargeInAugmentation(AugmentationConfig)

Barge-in injection augmentation config.

Arguments:

  • probability - Probability that a barge-in interruption is injected.
  • replacement_text - Text to use for the interruption utterance.
  • prompt - Optional independent prompt for the barge-in content.
  • utterance - Optional direct text override for the injected content.
  • min_offset_ms - Minimum delay before the injection fires.
  • max_offset_ms - Maximum delay before the injection fires.

Augmentation Objects​

@_attrs_define
class Augmentation(_DictSerializable)

Container for voice simulation augmentation strategy config.

Configure one primary strategy at a time. noise may be combined with one additional strategy.

Example:

Augmentation(noise=NoiseAugmentation(profile="cafeteria", snr_db=10))