pyrit.prompt_converter.UnicodeReplacementConverter#

class UnicodeReplacementConverter(*, encode_spaces: bool = False, word_selection_strategy: WordSelectionStrategy | None = None)[source]#

Bases: WordLevelConverter

Converts a prompt to its unicode representation.

__init__(*, encode_spaces: bool = False, word_selection_strategy: WordSelectionStrategy | None = None)[source]#

Initialize the converter with the specified selection strategy.

Parameters:
  • encode_spaces (bool) – If True, spaces in the prompt will be replaced with unicode representation.

  • word_selection_strategy (Optional[WordSelectionStrategy]) – Strategy for selecting which words to convert. If None, all words will be converted.

Methods

__init__(*[, encode_spaces, ...])

Initialize the converter with the specified selection strategy.

convert_async(*, prompt[, input_type])

Convert the given prompt into the target format supported by the converter.

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

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

convert_word_async(word)

Convert a single word into the target format supported by the converter.

get_identifier()

Get the typed identifier for this object.

input_supported(input_type)

Check if the input type is supported by the converter.

join_words(words)

Join a list of words into a single string, optionally encoding spaces as unicode.

output_supported(output_type)

Check if the output type is supported by the converter.

validate_input(prompt)

Validate the input before processing (can be overridden by subclasses).

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.

async convert_word_async(word: str) str[source]#

Convert a single word into the target format supported by the converter.

Parameters:

word (str) – The word to be converted.

Returns:

The converted word.

Return type:

str

join_words(words: list[str]) str[source]#

Join a list of words into a single string, optionally encoding spaces as unicode.

Parameters:

words (list[str]) – The list of words to join.

Returns:

The joined string.

Return type:

str