pyrit.prompt_converter.ColloquialWordswapConverter

pyrit.prompt_converter.ColloquialWordswapConverter#

class ColloquialWordswapConverter(deterministic: bool = False, custom_substitutions: Dict[str, List[str]] | None = None)[source]#

Converts text into colloquial Singaporean context.

__init__(deterministic: bool = False, custom_substitutions: Dict[str, List[str]] | None = None) → None[source]#

Initializes the converter with optional deterministic mode and custom substitutions.

Parameters:

deterministic (bool) – If True, use the first substitution for each wordswap. If False, randomly choose a substitution for each wordswap. Defaults to False.
custom_substitutions (Optional[Dict[str, List[str]]], Optional) – A dictionary of custom substitutions to override the defaults. Defaults to None.

Methods

`__init__`([deterministic, custom_substitutions])	Initializes the converter with optional deterministic mode and custom substitutions.
`convert_async`(*, prompt[, input_type])	Converts the given prompt by replacing words with colloquial Singaporean terms.
`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 replacing words with colloquial Singaporean terms.

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.