Skip to content

Avatars

API models for the avatars endpoint.

CheckAvatarResponse

A model response from ravyapi.api.endpoints.avatars.Avatars.check_avatar.

Attributes

data: dict[str, Any] The raw data returned from the Ravy API. matched: bool Whether the avatar was matched. key: str The avatar key that matched. similarity: float Similarity of the avatar to the key, represented as a float between 0 and 1.

Source code in ravyapi/api/models/avatars.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
class CheckAvatarResponse:
    """A model response from `ravyapi.api.endpoints.avatars.Avatars.check_avatar`.

    Attributes
    ----------
    data: dict[str, Any]
        The raw data returned from the Ravy API.
    matched: bool
        Whether the avatar was matched.
    key: str
        The avatar key that matched.
    similarity: float
        Similarity of the avatar to the key, represented as a float between 0 and 1.
    """

    __slots__: tuple[str, ...] = ("_data", "_matched", "_key", "_similarity")

    def __init__(self, data: dict[str, Any]) -> None:
        self._data: dict[str, Any] = data
        self._matched: bool = data["matched"]
        self._key: str | None = data.get("key")
        self._similarity: float | None = data.get("similarity")

    def __repr__(self) -> str:
        return (
            f"{self.__class__.__module__}.{self.__class__.__qualname__}"
            f"(matched={self.matched!r}, key={self.key!r}, similarity={self.similarity!r})"
        )

    @property
    def data(self) -> dict[str, Any]:
        """The raw data returned from the Ravy API."""
        return self._data

    @property
    def matched(self) -> bool:
        """Whether the avatar was matched."""
        return self._matched

    @property
    def key(self) -> str | None:
        """The avatar key that matched."""
        return self._key

    @property
    def similarity(self) -> float | None:
        """Similarity of the avatar to the key, represented as a float between 0 and 1."""
        return self._similarity

data property

The raw data returned from the Ravy API.

key property

The avatar key that matched.

matched property

Whether the avatar was matched.

similarity property

Similarity of the avatar to the key, represented as a float between 0 and 1.