Skip to content

AudioFillerSettings

Source code in docs_src/capo_lex_models_v2/types/audio_filler_settings.py
class AudioFillerSettings(TypedDict, closed=True):
    enabled: "capo_lex_models_v2.types.boolean.Boolean"
    """<p>Specifies whether audio filler playback is enabled for the bot locale. Set to <code>true</code> to play filler audio while Amazon Lex processes a user utterance. Set to <code>false</code> to disable filler audio.</p>"""
    audio_type: NotRequired[
        "capo_lex_models_v2.types.audio_filler_type.AudioFillerType"
    ]
    """<p>The identifier of the audio filler to play while Amazon Lex processes the user's input. This field is required when <code>enabled</code> is <code>true</code>.</p>"""
    start_delay_in_milliseconds: NotRequired[
        "capo_lex_models_v2.types.audio_filler_delay_in_milliseconds.AudioFillerDelayInMilliseconds"
    ]
    """<p>The time, in milliseconds, to wait after the end of the user's utterance before starting audio filler playback. Valid range is <code>500</code> to <code>5000</code> milliseconds. If not specified, Amazon Lex uses a default of <code>2500</code> milliseconds.</p>"""
    minimum_play_duration_in_milliseconds: NotRequired[
        "capo_lex_models_v2.types.audio_filler_duration_in_milliseconds.AudioFillerDurationInMilliseconds"
    ]
    """<p>The minimum time, in milliseconds, that audio filler plays once it has started, even if the bot response becomes ready sooner. Valid range is <code>1000</code> to <code>5000</code> milliseconds. If not specified, Amazon Lex uses a default of <code>3000</code> milliseconds.</p>"""
    response_delivery_delay_in_milliseconds: NotRequired[
        "capo_lex_models_v2.types.audio_filler_delivery_delay_in_milliseconds.AudioFillerDeliveryDelayInMilliseconds"
    ]
    """<p>The silent delay, in milliseconds, inserted between the end of audio filler playback and the start of the bot's response. Valid range is <code>200</code> to <code>1000</code> milliseconds. If not specified, Amazon Lex uses a default of <code>500</code> milliseconds.</p>"""

audio_type instance-attribute

audio_type: NotRequired[AudioFillerType]

The identifier of the audio filler to play while Amazon Lex processes the user's input. This field is required when enabled is true.

enabled instance-attribute

enabled: Boolean

Specifies whether audio filler playback is enabled for the bot locale. Set to true to play filler audio while Amazon Lex processes a user utterance. Set to false to disable filler audio.

minimum_play_duration_in_milliseconds instance-attribute

minimum_play_duration_in_milliseconds: NotRequired[AudioFillerDurationInMilliseconds]

The minimum time, in milliseconds, that audio filler plays once it has started, even if the bot response becomes ready sooner. Valid range is 1000 to 5000 milliseconds. If not specified, Amazon Lex uses a default of 3000 milliseconds.

response_delivery_delay_in_milliseconds instance-attribute

response_delivery_delay_in_milliseconds: NotRequired[
    AudioFillerDeliveryDelayInMilliseconds
]

The silent delay, in milliseconds, inserted between the end of audio filler playback and the start of the bot's response. Valid range is 200 to 1000 milliseconds. If not specified, Amazon Lex uses a default of 500 milliseconds.

start_delay_in_milliseconds instance-attribute

start_delay_in_milliseconds: NotRequired[AudioFillerDelayInMilliseconds]

The time, in milliseconds, to wait after the end of the user's utterance before starting audio filler playback. Valid range is 500 to 5000 milliseconds. If not specified, Amazon Lex uses a default of 2500 milliseconds.