pyrit.prompt_converter.DenylistConverter

pyrit.prompt_converter.DenylistConverter#

class DenylistConverter(*, converter_target: PromptChatTarget, system_prompt_template: SeedPrompt | None = None, denylist: list[str] = [])[source]#

Bases: LLMGenericTextConverter

Eliminates forbidden words or phrases in a prompt by replacing them with synonyms.

__init__(*, converter_target: PromptChatTarget, system_prompt_template: SeedPrompt | None = None, denylist: list[str] = [])[source]#

Generic LLM converter that expects text to be transformed (e.g. no JSON parsing or format)

Parameters:

  • converter_target (PromptChatTarget) – The endpoint that converts the prompt

  • system_prompt_template (SeedPrompt, Optional) – The prompt template to set as the system prompt.

  • user_prompt_template_with_objective (SeedPrompt, Optional) – The prompt template to set as the user prompt. expects

  • kwargs – Additional parameters for the prompt template.

Methods

__init__(*, converter_target[, ...])

Generic LLM converter that expects text to be transformed (e.g. no JSON parsing or format).

convert_async(*, prompt[, input_type])

Removes any words or phrases from the input prompt that are in the denylist, replacing them with synonomous words.

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

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

Removes any words or phrases from the input prompt that are in the denylist, replacing them with synonomous words.

Parameters:

prompt (str) – The prompt to be converted.

Returns:

The converted prompt without any denied words.

Return type:

str

Contents