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.
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
Accepted audio formats for conversion.
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.
- async convert_async(*, prompt: str, input_type: Literal['text', 'image_path', 'audio_path', 'video_path', 'url', 'reasoning', 'error'] = '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:
- Raises:
ValueError – If the input type is not supported.
Exception – If there is an error during the conversion process.
- input_supported(input_type: Literal['text', 'image_path', 'audio_path', 'video_path', 'url', 'reasoning', 'error']) bool [source]#
Checks if the input type is supported by the converter.
- Parameters:
input_type (PromptDataType) – The input type to check.
- Returns:
True if the input type is supported, False otherwise.
- Return type:
- output_supported(output_type: Literal['text', 'image_path', 'audio_path', 'video_path', 'url', 'reasoning', 'error']) bool [source]#
Checks if the output type is supported by the converter.
- Parameters:
output_type (PromptDataType) – The output type to check.
- Returns:
True if the output type is supported, False otherwise.
- Return type: