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

Parameters:

• pattern (str) – the regex pattern to replace

• replace (str) – the new phrase to replace with, can be a list and a random element is chosen

• regex_flags (int) – regex flags to use for the replacement

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

Methods

__init__(pattern, replace[, regex_flags])
convert_async(*, prompt[, input_type])	Simple converter that just replaces character in string with a chosen new character
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

Simple converter that just replaces character in string with a chosen new character

Parameters:

• prompt (str) – prompt to convert

• input_type (PromptDataType) – type of input

Returns: converted text as a ConverterResult object

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