pyrit.prompt_converter.SearchReplaceConverter

class SearchReplaceConverter(pattern: str, replace: str | list[str], regex_flags=0)

Bases: PromptConverter

Converts a string by replacing chosen phrase with a new phrase of choice.

__init__(pattern: str, replace: str | list[str], regex_flags=0) → None

Initializes the converter with the specified regex pattern and replacement phrase(s).

Parameters:

• pattern (str) – The regex pattern to replace.

• replace (str | list[str]) – The new phrase to replace with. Can be a single string or a list of strings. If a list is provided, a random element will be chosen for replacement.

• regex_flags (int) – Regex flags to use for the replacement. Defaults to 0 (no flags).

Methods

__init__(pattern, replace[, regex_flags])	Initializes the converter with the specified regex pattern and replacement phrase(s).
convert_async(*, prompt[, input_type])	Converts the given prompt by replacing the specified pattern with a random choice from the replacement list.
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

Converts the given prompt by replacing the specified pattern with a random choice from the replacement list.

Parameters:

• prompt (str) – The prompt to be converted.

• input_type (PromptDataType) – The type of input data.

Returns:

The result containing the converted text.

Return type:

ConverterResult

Raises:

ValueError – If the input type is not supported.

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

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:

bool

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

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:

bool