pyrit.prompt_converter.StringJoinConverter

pyrit.prompt_converter.StringJoinConverter#

class StringJoinConverter(*, join_value='-', word_selection_strategy: WordSelectionStrategy | None = None)[source]#

Bases: WordLevelConverter

Converts text by joining its characters with the specified join value.

__init__(*, join_value='-', word_selection_strategy: WordSelectionStrategy | None = None)[source]#

Initializes the converter with the specified join value and selection strategy.

Parameters:

join_value (str) – The string used to join characters of each word.
word_selection_strategy (Optional[WordSelectionStrategy]) – Strategy for selecting which words to convert. If None, all words will be converted.

Methods

`__init__`(*[, join_value, ...])	Initializes the converter with the specified join value and selection strategy.
`convert_async`(*, prompt[, input_type])	Converts the given prompt into the target format supported by the converter.
`convert_tokens_async`(*, prompt[, ...])	Converts substrings within a prompt that are enclosed by specified start and end tokens.
`convert_word_async`(word)	Converts a single word into the target format supported by the converter.
`get_identifier`()	Returns an identifier dictionary for the converter.
`input_supported`(input_type)	Checks if the input type is supported by the converter.
`join_words`(words)	Provides a way for subclasses to override the default behavior of joining words.
`output_supported`(output_type)	Checks if the output type is supported by the converter.
`validate_input`(prompt)	Validates the input before processing (can be overridden by subclasses).

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_word_async(word: str) → str[source]#

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