pyrit.prompt_converter.PromptConverter

pyrit.prompt_converter.PromptConverter#

class PromptConverter[source]#

Bases: ABC, Identifier

A prompt converter is responsible for converting prompts into a different representation.

__init__()#

Methods

__init__()

convert_async(*, prompt[, input_type])

Converts the given prompts into a different representation

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

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

get_identifier()

input_supported(input_type)

Checks if the input type is supported by the converter
abstract async convert_async(*, prompt: str, input_type: Literal['text', 'image_path', 'audio_path', 'url', 'error'] = 'text') → ConverterResult[source]#

Converts the given prompts into a different representation

Parameters:

prompt – The prompt to be converted.

Returns:

The converted representation of the prompts.

Return type:

str

async convert_tokens_async(*, prompt: str, input_type: Literal['text', 'image_path', 'audio_path', 'url', 'error'] = 'text', start_token: str = '⟪', end_token: str = '⟫') → ConverterResult[source]#

Converts substrings within a prompt that are enclosed by specified start and end tokens. If there are no tokens present, the entire prompt is converted.

Parameters:

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

  • input_type (str) – The type of input data. Defaults to “text”.

  • start_token (str) – The token indicating the start of a substring to be converted. Defaults to “⟪” which is relatively distinct.

  • end_token (str) – The token indicating the end of a substring to be converted. Defaults to “⟫” which is relatively distinct.

Returns:

The prompt with specified substrings converted.

Return type:

str

Raises:

ValueError – If the input is inconsistent.

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

Checks if the input type is supported by the converter

Parameters:

input_type – The input type to check

Returns:

True if the input type is supported, False otherwise

Return type:

bool