pyrit.prompt_converter.SuffixAppendConverter#
- class SuffixAppendConverter(*, suffix: str)[source]#
Bases:
PromptConverter
Appends a specified suffix to the prompt. E.g. with a suffix !!!, it converts a prompt of test to test !!!.
See Azure/PyRIT for adversarial suffix generation.
Methods
__init__
(*, suffix)Initializes the prompt converter.
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.
get_identifier
()Returns an identifier dictionary for the converter.
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]#
Converts the given prompt into the target format supported by the converter.
- Parameters:
prompt (str) – The prompt to be converted.
input_type (PromptDataType) – The type of input data.
- Returns:
The result containing the converted output and its type.
- Return type:
- 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 (PromptDataType) – The input type to check.
- Returns:
True if the input type is supported, False otherwise.
- Return type:
- 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 (PromptDataType) – The output type to check.
- Returns:
True if the output type is supported, False otherwise.
- Return type: