ScorerBase

class council.scorers.ScorerBase

Bases: ABC

Base class for implementing a Scorer

abstract _score(message: ChatMessage) → float

To be implemented with in derived classes with actual scoring logic

score(message: ChatMessage) → float

Score the given message

Parameters:

message (ChatMessage) – the message to be scored

Returns:

similarity score. The greater the value to higher the similarity

Raises:

SimilarityScorerException – an unexpected error occurs

to_dict() → Dict[str, Any]

Serialize the instance into a dictionary. May need to be overriden in derived classes