pyrit.prompt_converter.ColloquialWordswapConverter

pyrit.prompt_converter.ColloquialWordswapConverter#

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

Bases: PromptConverter

Converts text into colloquial Singaporean context.

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

Initialize 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])

Initialize the converter with optional deterministic mode and custom substitutions.

convert_async(*, prompt[, input_type])

Convert the given prompt by replacing words with colloquial Singaporean terms.

convert_tokens_async(*, prompt[, ...])

Convert substrings within a prompt that are enclosed by specified start and end tokens.

get_identifier()

Get the typed identifier for this object.

input_supported(input_type)

Check if the input type is supported by the converter.

output_supported(output_type)

Check if the output type is supported by the converter.

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.
SUPPORTED_INPUT_TYPES: tuple[Literal['text', 'image_path', 'audio_path', 'video_path', 'binary_path', 'url', 'reasoning', 'error', 'function_call', 'tool_call', 'function_call_output'], ...] = ('text',)#

Tuple of input modalities supported by this converter. Subclasses must override this.

SUPPORTED_OUTPUT_TYPES: tuple[Literal['text', 'image_path', 'audio_path', 'video_path', 'binary_path', 'url', 'reasoning', 'error', 'function_call', 'tool_call', 'function_call_output'], ...] = ('text',)#

Tuple of output modalities supported by this converter. Subclasses must override this.

async convert_async(*, prompt: str, input_type: Literal['text', 'image_path', 'audio_path', 'video_path', 'binary_path', 'url', 'reasoning', 'error', 'function_call', 'tool_call', 'function_call_output'] = 'text') → ConverterResult[source]#

Convert the given prompt by replacing words with colloquial Singaporean terms.

Parameters:

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

  • input_type (PromptDataType) – The type of the input prompt. Defaults to “text”.

Returns:

The result containing the converted prompt.

Return type:

ConverterResult

Raises:

ValueError – If the input type is not supported.

Contents