pyrit.prompt_converter.AtbashConverter

pyrit.prompt_converter.AtbashConverter#

class AtbashConverter(*, append_description: bool = False)[source]#

Bases: PromptConverter

Encodes text using the Atbash cipher.

Uses the following to encode:

  • ABCDEFGHIJKLMNOPQRSTUVWXYZ 0123456789

  • ZYXWVUTSRQPONMLKJIHGFEDCBA 9876543210

‘Hello 123’ would encode to ‘Svool 876’.

__init__(*, append_description: bool = False) → None[source]#

Initialize the converter with an option to append a description.

Parameters:

append_description (bool) – If True, appends plaintext “expert” text to the prompt. This includes instructions to only communicate using the cipher, a description of the cipher, and an example encoded using the cipher.

Methods

__init__(*[, append_description])

Initialize the converter with an option to append a description.

convert_async(*, prompt[, input_type])

Convert the given prompt using the Atbash cipher.

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 using the Atbash cipher.

Parameters:

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

  • input_type (PromptDataType) – The type of input data.

Returns:

The result containing the encoded prompt.

Return type:

ConverterResult

Raises:

ValueError – If the input type is not supported.

Contents