pyrit.prompt_converter.CharSwapConverter

pyrit.prompt_converter.CharSwapConverter#

class CharSwapConverter(*, max_iterations: int = 10, word_selection_strategy: WordSelectionStrategy | None = None)[source]#

Bases: WordLevelConverter

Applies character swapping to words in the prompt to test adversarial textual robustness.

__init__(*, max_iterations: int = 10, word_selection_strategy: WordSelectionStrategy | None = None)[source]#

Initialize the converter with the specified parameters.

By default, 20% of randomly selected words will be perturbed.

Parameters:

max_iterations (int) – Number of times to generate perturbed prompts. The higher the number the higher the chance that words are different from the original prompt.
word_selection_strategy (Optional[WordSelectionStrategy]) – Strategy for selecting which words to convert. If None, defaults to WordProportionSelectionStrategy(proportion=0.2).

Raises:

ValueError – If max_iterations is not greater than 0.

Methods

`__init__`(*[, max_iterations, ...])	Initialize the converter with the specified parameters.
`convert_async`(*, prompt[, input_type])	Convert the given prompt into the target format supported by the converter.
`convert_tokens_async`(*, prompt[, ...])	Convert substrings within a prompt that are enclosed by specified start and end tokens.
`convert_word_async`(word)	Convert a single word into the target format supported by the converter.
`get_identifier`()	Get the typed identifier for this object.
`input_supported`(input_type)	Check if the input type is supported by the converter.
`join_words`(words)	Provide a way for subclasses to override the default behavior of joining words.
`output_supported`(output_type)	Check if the output type is supported by the converter.
`validate_input`(prompt)	Validate the input before processing (can be overridden by subclasses).

Attributes

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

async convert_word_async(word: str) → str[source]#

Convert a single word into the target format supported by the converter.