Source code for gptcache.similarity_evaluation.similarity_evaluation

from abc import ABCMeta, abstractmethod
from typing import Tuple, Dict, Any

[docs]class SimilarityEvaluation(metaclass=ABCMeta): """Similarity Evaluation interface, determine the similarity between the input request and the requests from the Vector Store. Based on this similarity, it determines whether a request matches the cache. Example: .. code-block:: python from gptcache import cache from gptcache.similarity_evaluation import SearchDistanceEvaluation cache.init( similarity_evaluation=SearchDistanceEvaluation() ) """
[docs] @abstractmethod def evaluation( self, src_dict: Dict[str, Any], cache_dict: Dict[str, Any], **kwargs ) -> float: """Evaluate the similarity score of the user and cache requests pair. :param src_dict: the user request params. :type src_dict: Dict :param cache_dict: the cache request params. :type cache_dict: Dict """ pass
[docs] @abstractmethod def range(self) -> Tuple[float, float]: """Range of similarity score. :return: the range of similarity score, which is the min and max values :rtype: Tuple[float, float] """ pass