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 a string to a Singaporean colloquial version

__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 to colloquial Singaporean context.

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[source]#

Convert the given prompt to colloquial Singaporean context.

Parameters:

  • prompt (str) – The text to convert.

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

Returns:

A ConverterResult containing the Singaporean colloquial version of the prompt.

Return type:

ConverterResult

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

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[source]#

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

Contents