pyrit.prompt_converter.DiacriticConverter

pyrit.prompt_converter.DiacriticConverter#

class DiacriticConverter(target_chars: str = 'aeiou', accent: str = 'acute')[source]#

Applies diacritics to specified characters in a string.

__init__(target_chars: str = 'aeiou', accent: str = 'acute')[source]#

Initializes the converter with specified target characters and diacritic accent.

Parameters:

target_chars (str) – Characters to apply the diacritic to. Defaults to “aeiou”.
accent (str) –
Type of diacritic to apply (default is ‘acute’).
Available options are:
- acute: ́
- grave: ̀
- tilde: ̃
- umlaut: ̈

Raises:

ValueError – If target_chars is empty or if the specified accent is not recognized.

Methods

`__init__`([target_chars, accent])	Initializes the converter with specified target characters and diacritic accent.
`convert_async`(*, prompt[, input_type])	Converts the given prompt by applying diacritics to specified characters.
`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

`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'] = 'text') → ConverterResult[source]#: Converts the given prompt by applying diacritics to specified characters.

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.

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.