pyrit.models.PromptRequestResponse

class PromptRequestResponse(request_pieces: Sequence[PromptRequestPiece])

Bases: object

Represents a response to a prompt request.

This is a single request to a target. It can contain multiple prompt request pieces.

Parameters:

request_pieces (Sequence[PromptRequestPiece]) – The list of prompt request pieces.

__init__(request_pieces: Sequence[PromptRequestPiece])

Methods

__init__(request_pieces)
filter_by_role(*, role)	Filters the request pieces by role.
flatten_to_prompt_request_pieces(...)
from_prompt(*, prompt, role)
from_system_prompt(system_prompt)
get_piece([n])	Return the nth request piece.
get_value([n])	Return the converted value of the nth request piece.
get_values()	Return the converted values of all request pieces.
validate()	Validates the request response.

filter_by_role(*, role: Literal['system', 'user', 'assistant']) → Sequence[PromptRequestPiece]

Filters the request pieces by role.

Parameters:

role (ChatMessageRole) – The role to filter by.

Returns:

A sequence of request pieces that match the specified role.

Return type:

Sequence[PromptRequestPiece]

static flatten_to_prompt_request_pieces(request_responses: Sequence[PromptRequestResponse]) → MutableSequence[PromptRequestPiece]

classmethod from_prompt(*, prompt: str, role: Literal['system', 'user', 'assistant']) → PromptRequestResponse

classmethod from_system_prompt(system_prompt: str) → PromptRequestResponse

get_piece(n: int = 0) → PromptRequestPiece

Return the nth request piece.

get_value(n: int = 0) → str

Return the converted value of the nth request piece.

get_values() → list[str]

Return the converted values of all request pieces.

validate()

Validates the request response.