pyrit.prompt_converter.SuffixAppendConverter

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.

__init__(*, suffix: str)[source]#

Initialize the converter with the specified suffix.

Parameters:

suffix (str) – The suffix to append to the prompt.

Raises:

ValueError – If suffix is not provided.

Methods

__init__(*, suffix)

Initialize the converter with the specified suffix.

convert_async(*, prompt[, input_type])

Convert the given prompt by appending the specified suffix.

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

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

get_identifier()

Return an identifier dictionary for the converter.

input_supported(input_type)

Check if the input type is supported by the converter.

output_supported(output_type)

Check if the output type is supported by the converter.

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.
SUPPORTED_INPUT_TYPES: tuple[Literal['text', 'image_path', 'audio_path', 'video_path', 'binary_path', 'url', 'reasoning', 'error', 'function_call', 'tool_call', 'function_call_output'], ...] = ('text',)#

Tuple of input modalities supported by this converter. Subclasses must override this.

SUPPORTED_OUTPUT_TYPES: tuple[Literal['text', 'image_path', 'audio_path', 'video_path', 'binary_path', 'url', 'reasoning', 'error', 'function_call', 'tool_call', 'function_call_output'], ...] = ('text',)#

Tuple of output modalities supported by this converter. Subclasses must override this.

async convert_async(*, prompt: str, input_type: Literal['text', 'image_path', 'audio_path', 'video_path', 'binary_path', 'url', 'reasoning', 'error', 'function_call', 'tool_call', 'function_call_output'] = 'text') → ConverterResult[source]#

Convert the given prompt by appending the specified suffix.

Parameters:

  • prompt (str) – The prompt to be converted.

  • input_type (PromptDataType, optional) – Type of input data. Defaults to “text”.

Returns:

The prompt with the suffix appended.

Return type:

ConverterResult

Raises:

ValueError – If the input type is not supported.

Contents