pyrit.prompt_converter.AtbashConverter

pyrit.prompt_converter.AtbashConverter#

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

Encodes text using the Atbash cipher.

Uses the following to encode:

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

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

Initializes 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])	Initializes the converter with an option to append a description.
`convert_async`(*, prompt[, input_type])	Converts the given prompt using the Atbash cipher.
`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', 'reasoning', 'error'] = 'text') → ConverterResult[source]#: Converts the given prompt using the Atbash cipher.

input_supported(input_type: Literal['text', 'image_path', 'audio_path', 'video_path', 'url', 'reasoning', 'error']) → bool[source]#

Checks if the input type is supported by the converter.

output_supported(output_type: Literal['text', 'image_path', 'audio_path', 'video_path', 'url', 'reasoning', 'error']) → bool[source]#

Checks if the output type is supported by the converter.