pyrit.score.FloatScaleScorer#
- class FloatScaleScorer(*, validator)[source]#
Bases:
ScorerBase 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[source]#
Initialize the FloatScaleScorer.
- Parameters:
validator – A validator object used to validate scores.
Methods
__init__(*, validator)Initialize the FloatScaleScorer.
get_identifier()Get an identifier dictionary for the scorer.
get_scorer_metrics(dataset_name[, metrics_type])Get evaluation statistics for the scorer using the dataset_name of the human labeled dataset.
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])Score the given image using the chat target.
score_image_batch_async(*, image_paths[, ...])Score a batch of images asynchronously.
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)Validate that the returned scores are within the valid range [0, 1].
Attributes
- scorer_type: ScoreType#
- validate_return_scores(scores: list[Score])[source]#
Validate that the returned scores are within the valid range [0, 1].
- Raises:
ValueError – If any score is not between 0 and 1.