pyrit.prompt_converter.DiacriticConverter

class DiacriticConverter(target_chars: str = 'aeiou', accent: str = 'acute')

Bases: PromptConverter

A PromptConverter that applies diacritics to specified characters in a string.

__init__(target_chars: str = 'aeiou', accent: str = 'acute')

Initializes the DiacriticConverter.

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.

Methods

__init__([target_chars, accent])	Initializes the DiacriticConverter.
convert_async(*, prompt[, input_type])	Converts the given prompt by applying diacritics to target characters.
convert_tokens_async(*, prompt[, ...])	Converts substrings within a prompt that are enclosed by specified start and end tokens.
get_identifier()
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', 'error'] = 'text') → ConverterResult

Converts the given prompt by applying diacritics to target characters.

Parameters:

prompt (str) – The prompt to be converted.

Returns:

The result containing the modified prompt.

Return type:

ConverterResult

input_supported(input_type: Literal['text', 'image_path', 'audio_path', 'video_path', 'url', 'error']) → bool

Checks if the input type is supported by the converter

Parameters:

input_type – The input type to check

Returns:

True if the input type is supported, False otherwise

Return type:

bool

output_supported(output_type: Literal['text', 'image_path', 'audio_path', 'video_path', 'url', 'error']) → bool

Checks if the output type is supported by the converter

Parameters:

output_type – The output type to check

Returns:

True if the output type is supported, False otherwise

Return type:

bool