pyrit.prompt_converter.BrailleConverter

pyrit.prompt_converter.BrailleConverter#

class BrailleConverter[source]#

Bases: PromptConverter

Converts text into Braille Unicode representation.

This converter transforms standard text into Braille patterns using Unicode Braille characters (U+2800 to U+28FF). It supports lowercase and uppercase letters, numbers, common punctuation, and spaces. Uppercase letters are prefixed with the Braille capitalization indicator.

The Braille mapping is based on the implementation from Garak: NVIDIA/garak

Note: This converter is useful for testing how AI systems handle Braille-encoded text, which can be used to obfuscate potentially harmful content.

__init__() → None#

Initialize the prompt converter.

Methods

__init__()

Initialize the prompt converter.

convert_async(*, prompt[, input_type])

Convert the given text into Braille Unicode representation.

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 text into Braille Unicode representation.

Parameters:

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

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

Returns:

The text converted to Braille Unicode characters.

Return type:

ConverterResult

Raises:

ValueError – If the input type is not supported (only “text” is supported).

Contents