pyrit.score.AudioTrueFalseScorer

pyrit.score.AudioTrueFalseScorer#

class AudioTrueFalseScorer(*, text_capable_scorer: TrueFalseScorer, validator: ScorerPromptValidator | None = None)[source]#

Bases: TrueFalseScorer

A scorer that processes audio files by transcribing them and scoring the transcript.

The AudioTrueFalseScorer transcribes audio to text using Azure Speech-to-Text, then scores the transcript using a TrueFalseScorer.

__init__(*, text_capable_scorer: TrueFalseScorer, validator: ScorerPromptValidator | None = None) → None[source]#

Initialize the AudioTrueFalseScorer.

Parameters:

  • text_capable_scorer – A TrueFalseScorer capable of processing text. This scorer will be used to evaluate the transcribed audio content.

  • validator – Validator for the scorer. Defaults to audio_path data type validator.

Raises:

ValueError – If text_capable_scorer does not support text data type.

Methods

__init__(*, text_capable_scorer[, validator])

Initialize the AudioTrueFalseScorer.

evaluate_async([file_mapping, ...])

Evaluate this scorer against human-labeled datasets.

get_identifier()

Get the typed identifier for this object.

get_scorer_metrics()

Get evaluation metrics for this scorer from the configured evaluation result file.

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 the scores returned by the scorer.

Attributes

evaluation_file_mapping

scorer_type

Get the scorer type based on class hierarchy.
Contents