pyrit.score.SubStringScorer

class SubStringScorer(*, substring: str, category: str = None)

Bases: Scorer

Scorer that checks if a given substring is present in the text.

__init__(*, substring: str, category: str = None) → None

Methods

__init__(*, substring[, category])
get_identifier()	Returns an identifier dictionary for the scorer.
scale_value_float(value, min_value, max_value)	Scales a value from 0 to 1 based on the given min and max values.
score_async(request_response, *[, task])	Score the request_response, add the results to the database and return a list of Score objects.
score_image_async(image_path, *[, task])	Scores the given image using the chat target.
score_prompts_batch_async(*, request_responses)
score_text_async(text, *[, task])	Scores the given text based on the task using the chat target.
validate(request_response, *[, task])	Validates the request_response piece to score.

Attributes

scorer_type

async score_async(request_response: PromptRequestPiece, *, task: str | None = None) → list[Score]

Score the request_response, add the results to the database and return a list of Score objects.

Parameters:

• request_response (PromptRequestPiece) – The request response to be scored.

• task (str) – The task based on which the text should be scored (the original attacker model’s objective).

Returns:

A list of Score objects representing the results.

Return type:

list[Score]

validate(request_response: PromptRequestPiece, *, task: str | None = None)

Validates the request_response piece to score. Because some scorers may require specific PromptRequestPiece types or values.

Parameters:

• request_response (PromptRequestPiece) – The request response to be validated.

• task (str) – The task based on which the text should be scored (the original attacker model’s objective).