pyrit.prompt_converter.AudioWhiteNoiseConverter

pyrit.prompt_converter.AudioWhiteNoiseConverter#

class AudioWhiteNoiseConverter(*, output_format: Literal['wav'] = 'wav', noise_scale: float = 0.02)[source]#

Bases: PromptConverter

Adds white noise to an audio file.

White noise is generated and mixed into the original signal at a level controlled by the noise_scale parameter. The output preserves the original sample rate, bit depth, channel count, and number of samples.

__init__(*, output_format: Literal['wav'] = 'wav', noise_scale: float = 0.02) → None[source]#

Initialize the converter with the white noise parameters.

Parameters:

  • output_format (str) – The format of the audio file, defaults to “wav”.

  • noise_scale (float) – Controls the amplitude of the added noise, expressed as a fraction of the signal’s maximum possible value. For int16 audio the noise amplitude will be noise_scale * 32767. Must be greater than 0 and at most 1.0. Defaults to 0.02.

Raises:

ValueError – If noise_scale is not in (0, 1].

Methods

__init__(*[, output_format, noise_scale])

Initialize the converter with the white noise parameters.

convert_async(*, prompt[, input_type])

Convert the given audio file by adding white noise.

convert_tokens_async(*, prompt[, ...])

Convert substrings within a prompt that are enclosed by specified start and end tokens.

get_identifier()

Get the component's identifier, building it lazily on first access.

input_supported(input_type)

Check if the input type is supported by the converter.

output_supported(output_type)

Check if the output type is supported by the converter.

Attributes

AcceptedAudioFormats

Accepted audio formats for conversion.

SUPPORTED_INPUT_TYPES

Tuple of input modalities supported by this converter.

SUPPORTED_OUTPUT_TYPES

Tuple of output modalities supported by this converter.

supported_input_types

Returns a list of supported input types for the converter.

supported_output_types

Returns a list of supported output types for the converter.
AcceptedAudioFormats#

Accepted audio formats for conversion.

alias of Literal[‘wav’]

SUPPORTED_INPUT_TYPES: tuple[Literal['text', 'image_path', 'audio_path', 'video_path', 'binary_path', 'url', 'reasoning', 'error', 'function_call', 'tool_call', 'function_call_output'], ...] = ('audio_path',)#

Tuple of input modalities supported by this converter. Subclasses must override this.

SUPPORTED_OUTPUT_TYPES: tuple[Literal['text', 'image_path', 'audio_path', 'video_path', 'binary_path', 'url', 'reasoning', 'error', 'function_call', 'tool_call', 'function_call_output'], ...] = ('audio_path',)#

Tuple of output modalities supported by this converter. Subclasses must override this.

async convert_async(*, prompt: str, input_type: Literal['text', 'image_path', 'audio_path', 'video_path', 'binary_path', 'url', 'reasoning', 'error', 'function_call', 'tool_call', 'function_call_output'] = 'audio_path') → ConverterResult[source]#

Convert the given audio file by adding white noise.

Parameters:

  • prompt (str) – File path to the audio file to be converted.

  • input_type (PromptDataType) – The type of input data.

Returns:

The result containing the converted audio file path.

Return type:

ConverterResult

Raises:

  • ValueError – If the input type is not supported.

  • Exception – If there is an error during the conversion process.

Contents