pyrit.models.Score

class Score(*, score_value: str, score_value_description: str, score_type: ScoreType, score_rationale: str, message_piece_id: str | uuid.UUID, id: uuid.UUID | str | None = None, score_category: List[str] | None = None, score_metadata: Dict[str, str | int | float] | None = None, scorer_class_identifier: 'ScorerIdentifier' | Dict[str, Any], timestamp: datetime | None = None, objective: str | None = None)

Bases: object

__init__(*, score_value: str, score_value_description: str, score_type: ScoreType, score_rationale: str, message_piece_id: str | uuid.UUID, id: uuid.UUID | str | None = None, score_category: List[str] | None = None, score_metadata: Dict[str, str | int | float] | None = None, scorer_class_identifier: 'ScorerIdentifier' | Dict[str, Any], timestamp: datetime | None = None, objective: str | None = None)

Methods

__init__(*, score_value, ...[, id, ...])
get_value()	Returns the value of the score based on its type.
to_dict()
validate(scorer_type, score_value)

Attributes

id
score_value
score_value_description
score_type
score_category
score_rationale
score_metadata
scorer_class_identifier
message_piece_id
timestamp
task

get_value() → bool | float

Returns the value of the score based on its type.

If the score type is “true_false”, it returns True if the score value is “true” (case-insensitive), otherwise it returns False.

If the score type is “float_scale”, it returns the score value as a float.

Raises:

ValueError – If the score type is unknown.

Returns:

The value of the score based on its type.

id: uuid.UUID | str

message_piece_id: uuid.UUID | str

score_category: List[str] | None

score_metadata: Dict[str, str | int | float] | None

score_rationale: str

score_type: ScoreType

score_value: str

score_value_description: str

scorer_class_identifier: ScorerIdentifier

task: str

timestamp: datetime

to_dict() → Dict[str, Any]

validate(scorer_type: str, score_value: str) → None