pyrit.prompt_converter.LLMGenericTextConverter

pyrit.prompt_converter.LLMGenericTextConverter#

class LLMGenericTextConverter(*, converter_target: PromptChatTarget, system_prompt_template: SeedPrompt | None = None, user_prompt_template_with_objective: SeedPrompt | None = None, **kwargs)[source]#

Bases: PromptConverter

__init__(*, converter_target: PromptChatTarget, system_prompt_template: SeedPrompt | None = None, user_prompt_template_with_objective: SeedPrompt | None = None, **kwargs)[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])

Convert a prompt based on the prompt template

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]#

Convert a prompt based on the prompt template

Parameters:

  • prompt (str) – The prompt to convert.

  • input_type (PromptDataType, Optional) – The data type of the input prompt. Defaults to “text”.

Returns:

The result of the conversion, including the converted output text and output type.

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[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

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

Checks if the output type is supported by the converter

Parameters:

output_type – The output type to check

Returns:

True if the output type is supported, False otherwise

Return type:

bool

Contents