pyrit.prompt_converter.VariationConverter

class VariationConverter(*, converter_target: PromptChatTarget, prompt_template: SeedPrompt = None)

Bases: PromptConverter

Generates variations of the input prompts using the converter target.

__init__(*, converter_target: PromptChatTarget, prompt_template: SeedPrompt = None)

Initializes the converter with the specified target and prompt template.

Parameters:

• converter_target (PromptChatTarget) – The target to which the prompt will be sent for conversion.

• prompt_template (SeedPrompt, optional) – The template used for generating the system prompt. If not provided, a default template will be used.

Methods

__init__(*, converter_target[, prompt_template])	Initializes the converter with the specified target and prompt template.
convert_async(*, prompt[, input_type])	Converts the given prompt by generating variations of it using the converter target.
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.
send_variation_prompt_async(request)	Sends the prompt request to the converter target and retrieves the response.

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', 'error'] = 'text') → ConverterResult

Converts the given prompt by generating variations of it using the converter target.

Parameters:

prompt (str) – The prompt to be converted.

Returns:

The result containing the generated variations.

Return type:

ConverterResult

Raises:

ValueError – If the input type is not supported.

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

Checks if the input type is supported by the converter.

Parameters:

input_type (PromptDataType) – The input type to check.

Returns:

True if the input type is supported, False otherwise.

Return type:

bool

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

Checks if the output type is supported by the converter.

Parameters:

output_type (PromptDataType) – The output type to check.

Returns:

True if the output type is supported, False otherwise.

Return type:

bool

async send_variation_prompt_async(request)

Sends the prompt request to the converter target and retrieves the response.