pyrit.prompt_converter.DenylistConverter

pyrit.prompt_converter.DenylistConverter#

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

Bases: LLMGenericTextConverter

Replaces forbidden words or phrases in a prompt with synonyms using an LLM.

An existing PromptChatTarget is used to perform the conversion (like Azure OpenAI).

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

Initializes the converter with a target, an optional system prompt template, and a denylist.

Parameters:

  • converter_target (PromptChatTarget) – The target for the prompt conversion. Can be omitted if a default has been configured via PyRIT initialization.

  • system_prompt_template (Optional[SeedPrompt]) – The system prompt template to use for the conversion. If not provided, a default template will be used.

  • denylist (list[str]) – A list of words or phrases that should be replaced in the prompt.

Methods

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

Initializes the converter with a target, an optional system prompt template, and a denylist.

convert_async(*, prompt[, input_type])

Converts the given prompt by removing any words or phrases that are in the denylist, replacing them with synonymous words.

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

Converts the given prompt by removing any words or phrases that are in the denylist, replacing them with synonymous words.

Parameters:

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

  • input_type (PromptDataType) – The type of input data.

Returns:

The result containing the modified prompt.

Return type:

ConverterResult

Contents