pyrit.score.SubStringScorer

pyrit.score.SubStringScorer#

class SubStringScorer(*, substring: str, text_matcher: ~pyrit.analytics.text_matching.TextMatching | None = None, categories: list[str] | None = None, aggregator: ~typing.Callable[[~typing.Iterable[~pyrit.models.score.Score]], ~pyrit.score.score_aggregator_result.ScoreAggregatorResult] = <function _create_aggregator.<locals>.aggregator>, validator: ~pyrit.score.scorer_prompt_validator.ScorerPromptValidator | None = None)[source]#

Bases: TrueFalseScorer

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

This scorer performs substring matching using a configurable text matching strategy. Supports both exact substring matching and approximate matching.

__init__(*, substring: str, text_matcher: ~pyrit.analytics.text_matching.TextMatching | None = None, categories: list[str] | None = None, aggregator: ~typing.Callable[[~typing.Iterable[~pyrit.models.score.Score]], ~pyrit.score.score_aggregator_result.ScoreAggregatorResult] = <function _create_aggregator.<locals>.aggregator>, validator: ~pyrit.score.scorer_prompt_validator.ScorerPromptValidator | None = None) → None[source]#

Initialize the SubStringScorer.

Parameters:

  • substring (str) – The substring to search for in the text.

  • text_matcher (Optional[TextMatching]) – The text matching strategy to use. Defaults to ExactTextMatching with case_sensitive=False.

  • categories (Optional[list[str]]) – Optional list of categories for the score. Defaults to None.

  • aggregator (TrueFalseAggregatorFunc) – The aggregator function to use. Defaults to TrueFalseScoreAggregator.OR.

  • validator (Optional[ScorerPromptValidator]) – Custom validator. Defaults to None.

Methods

__init__(*, substring[, text_matcher, ...])

Initialize the SubStringScorer.

get_identifier()

Returns an identifier dictionary for the scorer.

get_scorer_metrics(dataset_name[, metrics_type])

Returns evaluation statistics for the scorer using the dataset_name of the human labeled dataset that this scorer was run against.

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(message, *[, objective, ...])

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

score_image_async(image_path, *[, objective])

Scores the given image using the chat target.

score_image_batch_async(*, image_paths[, ...])

score_prompts_batch_async(*, messages[, ...])

Score multiple prompts in batches using the provided objectives.

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

Score a response using an objective scorer and optional auxiliary scorers.

score_response_multiple_scorers_async(*, ...)

Score a response using multiple scorers in parallel.

score_text_async(text, *[, objective])

Scores the given text based on the task using the chat target.

validate_return_scores(scores)

Validates the scores returned by the scorer.

Attributes

scorer_type

Contents