pyrit.prompt_converter.FirstLetterConverter

class FirstLetterConverter(*, letter_separator=' ', word_selection_strategy: WordSelectionStrategy | None = None)

Bases: WordLevelConverter

Replaces each word of the prompt with its first letter (or digit). Whitespace and words that do not contain any letter or digit are ignored.

__init__(*, letter_separator=' ', word_selection_strategy: WordSelectionStrategy | None = None)

Initializes the converter with the specified letter separator and selection strategy.

Parameters:

• letter_separator (str) – The string used to join the first letters.

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

Methods

__init__(*[, letter_separator, ...])	Initializes the converter with the specified letter separator 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

Converts 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

Provides a way for subclasses to override the default behavior of joining words.