pyrit.score.FloatScaleScorer

class FloatScaleScorer(*, validator)

Bases: Scorer

Base class for scorers that return floating-point scores in the range [0, 1].

This scorer evaluates prompt responses and returns numeric scores indicating the degree to which a response exhibits certain characteristics. Each piece in a request response is scored independently, returning one score per piece.

__init__(*, validator) → None

Methods

__init__(*, validator)
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

scorer_type: ScoreType

validate_return_scores(scores: list[Score])

Validates the scores returned by the scorer. Because some scorers may require specific Score types or values.

Parameters:

scores (list[Score]) – The scores to be validated.