pyrit.score.SubStringScorer

pyrit.score.SubStringScorer#

class SubStringScorer(*, substring: str, category: str = '')[source]#

Bases: Scorer

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

This scorer performs simple substring matching to determine if specific text patterns are present in the response. It’s useful for detecting specific phrases, keywords, or patterns in generated content.

__init__(*, substring: str, category: str = '') → None[source]#

Initialize the SubStringScorer.

Parameters:

  • substring – The substring to search for in the text.

  • category – Optional category for the score. Defaults to empty string.

Methods

__init__(*, substring[, category])

Initialize the SubStringScorer.

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 given request_response based on presence of the substring.

score_image_async(image_path, *[, task])

Scores the given image using the chat target.

score_prompts_with_tasks_batch_async(*, ...)

score_response_async(*, response, scorers[, ...])

Score a response using multiple scorers in parallel.

score_response_select_first_success_async(*, ...)

Score response pieces sequentially until finding a successful score.

score_response_with_objective_async(*, response)

Score a response using both auxiliary and objective scorers.

score_responses_inferring_tasks_batch_async(*, ...)

Scores a batch of responses (ignores non-assistant messages).

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

Score the given request_response based on presence of the substring.

Parameters:

  • request_response – The piece to score.

  • task – The task based on which the text should be scored (unused).

Returns:

A list containing a single Score object with a boolean value indicating whether the substring is present in the text.

scorer_type: ScoreType#
validate(request_response: PromptRequestPiece, *, task: str | None = None)[source]#

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

Contents