pyrit.prompt_converter.LLMGenericTextConverter

pyrit.prompt_converter.LLMGenericTextConverter#

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

Bases: PromptConverter

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

__init__(*, converter_target: PromptChatTarget = REQUIRED_VALUE, system_prompt_template: SeedPrompt | None = None, user_prompt_template_with_objective: SeedPrompt | None = None, **kwargs: Any) → None[source]#

Initialize the converter with a target and optional prompt templates.

Parameters:

  • converter_target (PromptChatTarget) – The endpoint that converts the prompt. Can be omitted if a default has been configured via PyRIT initialization.

  • 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.

Raises:

ValueError – If converter_target is not provided and no default has been configured.

Methods

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

Initialize the converter with a target and optional prompt templates.

convert_async(*, prompt[, input_type])

Convert the given prompt using an LLM via the specified converter target.

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

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

get_identifier()

Return an identifier dictionary for the converter.

input_supported(input_type)

Check if the input type is supported by the converter.

output_supported(output_type)

Check if the output type is supported by the converter.

Attributes

SUPPORTED_INPUT_TYPES

Tuple of input modalities supported by this converter.

SUPPORTED_OUTPUT_TYPES

Tuple of output modalities supported by this converter.

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.
SUPPORTED_INPUT_TYPES: tuple[Literal['text', 'image_path', 'audio_path', 'video_path', 'binary_path', 'url', 'reasoning', 'error', 'function_call', 'tool_call', 'function_call_output'], ...] = ('text',)#

Tuple of input modalities supported by this converter. Subclasses must override this.

SUPPORTED_OUTPUT_TYPES: tuple[Literal['text', 'image_path', 'audio_path', 'video_path', 'binary_path', 'url', 'reasoning', 'error', 'function_call', 'tool_call', 'function_call_output'], ...] = ('text',)#

Tuple of output modalities supported by this converter. Subclasses must override this.

async convert_async(*, prompt: str, input_type: Literal['text', 'image_path', 'audio_path', 'video_path', 'binary_path', 'url', 'reasoning', 'error', 'function_call', 'tool_call', 'function_call_output'] = 'text') → ConverterResult[source]#

Convert the given prompt using an LLM via the specified converter target.

Parameters:

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

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

Returns:

The result containing the converted output and its type.

Return type:

ConverterResult

Raises:

ValueError – If the input type is not supported.

Contents