pyrit.prompt_converter.AudioFrequencyConverter

pyrit.prompt_converter.AudioFrequencyConverter#

class AudioFrequencyConverter(*, output_format: Literal['wav'] = 'wav', shift_value: int = 20000)[source]#

Bases: PromptConverter

Shifts the frequency of an audio file by a specified value. By default, it will shift it above the human hearing range (=20 kHz).

__init__(*, output_format: Literal['wav'] = 'wav', shift_value: int = 20000) → None[source]#

Initializes the converter with the specified output format and shift value.

Parameters:

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

  • shift_value (int) – The value by which the frequency will be shifted, defaults to 20000 Hz.

Methods

__init__(*[, output_format, shift_value])

Initializes the converter with the specified output format and shift value.

convert_async(*, prompt[, input_type])

Converts the given audio file by shifting its frequency.

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

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

get_identifier()

Returns an identifier dictionary for the converter.

input_supported(input_type)

Checks if the input type is supported by the converter.

output_supported(output_type)

Checks 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', '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', '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', 'url', 'reasoning', 'error', 'function_call', 'tool_call', 'function_call_output'] = 'audio_path') → ConverterResult[source]#

Converts the given audio file by shifting its frequency.

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 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