Skip to content

Avatars

Implementations for the avatars endpoint.

Avatars

Bases: HTTPAwareEndpoint

A class with implementations for the avatars endpoint.

Source code in ravyapi/api/endpoints/avatars.py 
 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
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
class Avatars(HTTPAwareEndpoint):
    """A class with implementations for the `avatars` endpoint."""

    __slots__: tuple[str, ...] = ()

    @with_permission_check("avatars")
    async def check_avatar(
        self: HTTPAwareEndpoint,
        avatar: str | bytes,
        threshold: float = 0.97,
        method: Literal["ssim", "phash"] = "phash",
    ) -> CheckAvatarResponse:
        """Check if avatar is fraudulent.

        Parameters
        ----------
        avatar : str | bytes
            Link to the avatar, should start with "cdn.discordapp.com" or the avatar to query, as an octet stream.
        threshold : float = 0.97
            How similar the avatar needs to be for it to match (0-1, default 0.97).
        method : Literal["ssim", "phash"]
            Which method to use for matching the avatars ("ssim" or "phash", default is "phash").

        Raises
        ------
        TypeError
            If any parameters are of invalid types.
        ValueError
            If any parameters are invalid values.

        Returns
        -------
        CheckAvatarResponse
            A model response from `ravyapi.api.endpoints.avatars.Avatars.check_avatar`.
            Located as `ravyapi.api.models.avatars.CheckAvatarResponse`.
        """
        if not isinstance(avatar, (str, bytes)):
            raise TypeError('Parameter "avatar" must be of type "str" or "bytes"')

        if not avatar:
            raise ValueError('Parameter "avatar" must not be empty')

        if not 0 <= threshold <= 1:
            raise ValueError(
                'Parameter "threshold" must be of type "float" between 0 and 1'
            )

        if method not in ("ssim", "phash"):
            raise ValueError('Parameter "method" must be either "ssim" or "phash"')

        if isinstance(avatar, str):
            if urllib.parse.urlparse(avatar).hostname != "cdn.discordapp.com":
                raise ValueError(
                    'Parameter "avatar_url" must start with "https://cdn.discordapp.com"'
                )

            return CheckAvatarResponse(
                await self._http.get(
                    self._http.paths.avatars.route,
                    params={
                        "avatar": avatar,
                        "threshold": threshold,
                        "method": method,
                    },
                )
            )

        data = aiohttp.FormData()
        data.add_field("avatar", avatar, content_type="application/octet-stream")

        return CheckAvatarResponse(
            await self._http.post(
                self._http.paths.avatars.route,
                params={
                    "threshold": threshold,
                    "method": method,
                },
                data=data,
            )
        )

check_avatar(avatar, threshold=0.97, method='phash') async

Check if avatar is fraudulent.

Parameters

avatar : str | bytes Link to the avatar, should start with "cdn.discordapp.com" or the avatar to query, as an octet stream. threshold : float = 0.97 How similar the avatar needs to be for it to match (0-1, default 0.97). method : Literal["ssim", "phash"] Which method to use for matching the avatars ("ssim" or "phash", default is "phash").

Raises

TypeError If any parameters are of invalid types. ValueError If any parameters are invalid values.

Returns

CheckAvatarResponse A model response from ravyapi.api.endpoints.avatars.Avatars.check_avatar. Located as ravyapi.api.models.avatars.CheckAvatarResponse.

Source code in ravyapi/api/endpoints/avatars.py 
 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
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
@with_permission_check("avatars")
async def check_avatar(
    self: HTTPAwareEndpoint,
    avatar: str | bytes,
    threshold: float = 0.97,
    method: Literal["ssim", "phash"] = "phash",
) -> CheckAvatarResponse:
    """Check if avatar is fraudulent.

    Parameters
    ----------
    avatar : str | bytes
        Link to the avatar, should start with "cdn.discordapp.com" or the avatar to query, as an octet stream.
    threshold : float = 0.97
        How similar the avatar needs to be for it to match (0-1, default 0.97).
    method : Literal["ssim", "phash"]
        Which method to use for matching the avatars ("ssim" or "phash", default is "phash").

    Raises
    ------
    TypeError
        If any parameters are of invalid types.
    ValueError
        If any parameters are invalid values.

    Returns
    -------
    CheckAvatarResponse
        A model response from `ravyapi.api.endpoints.avatars.Avatars.check_avatar`.
        Located as `ravyapi.api.models.avatars.CheckAvatarResponse`.
    """
    if not isinstance(avatar, (str, bytes)):
        raise TypeError('Parameter "avatar" must be of type "str" or "bytes"')

    if not avatar:
        raise ValueError('Parameter "avatar" must not be empty')

    if not 0 <= threshold <= 1:
        raise ValueError(
            'Parameter "threshold" must be of type "float" between 0 and 1'
        )

    if method not in ("ssim", "phash"):
        raise ValueError('Parameter "method" must be either "ssim" or "phash"')

    if isinstance(avatar, str):
        if urllib.parse.urlparse(avatar).hostname != "cdn.discordapp.com":
            raise ValueError(
                'Parameter "avatar_url" must start with "https://cdn.discordapp.com"'
            )

        return CheckAvatarResponse(
            await self._http.get(
                self._http.paths.avatars.route,
                params={
                    "avatar": avatar,
                    "threshold": threshold,
                    "method": method,
                },
            )
        )

    data = aiohttp.FormData()
    data.add_field("avatar", avatar, content_type="application/octet-stream")

    return CheckAvatarResponse(
        await self._http.post(
            self._http.paths.avatars.route,
            params={
                "threshold": threshold,
                "method": method,
            },
            data=data,
        )
    )