Skip to content

landingai.utils

Module for common utility functions.

load_api_credential(api_key=None)

Load API credential from different sources.

Parameters

api_key: The API key argument to be passed in, by default None. The API key can be provided as arguments or loaded from the environment variables or .env file. The api key loading priority is: arguments > environment variables > .env file.

Returns

APIKey An APIKey (v2 key) instance.

Source code in landingai/utils.py 
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
def load_api_credential(api_key: Optional[str] = None) -> APIKey:
    """Load API credential from different sources.

    Parameters
    ----------
    api_key:
        The API key argument to be passed in, by default None.
        The API key can be provided as arguments or loaded from the environment variables or .env file.
        The api key loading priority is: arguments > environment variables > .env file.

    Returns
    -------
    APIKey
        An APIKey (v2 key) instance.
    """
    if api_key is not None:
        return APIKey(api_key=api_key)
    else:
        # Load from environment variables or .env file
        try:
            return APIKey()
        except ValidationError as e:
            raise InvalidApiKeyError(
                "API key is either not provided or invalid."
            ) from e

serialize_image(image)

Serialize the input image into bytes of an image file.

The image file encoding format is set to "JPEG" for optimal latency. For RGBA images, the encoding format will be PNG to preserve transparency. For palettized image, i.e. mode P or PA, the image will be converted to RGB before encoding. In addition, the image file encoding format can be overwritten by the environment variable DEFAULT_IMAGE_SERIALIZATION_FORMAT. Supported image serialization formats are: JPEG, PNG, BMP.

Source code in landingai/utils.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
@Timer(name="serialize_image", log_fn=_LOGGER.debug)
def serialize_image(image: Union[np.ndarray, PIL.Image.Image]) -> bytes:
    """Serialize the input image into bytes of an image file.

    The image file encoding format is set to "JPEG" for optimal latency.
    For RGBA images, the encoding format will be `PNG` to preserve transparency.
    For palettized image, i.e. mode `P` or `PA`, the image will be converted to RGB before encoding.
    In addition, the image file encoding format can be overwritten by the environment variable `DEFAULT_IMAGE_SERIALIZATION_FORMAT`.
    Supported image serialization formats are: JPEG, PNG, BMP.
    """
    if image is None or (isinstance(image, np.ndarray) and len(image) == 0):
        raise ValueError(f"Input image must be non-emtpy, but got: {image}")
    format = _resolve_serialization_format(image)
    _LOGGER.debug("Use %s as the serialization format.", format)
    if isinstance(image, np.ndarray):
        image = PIL.Image.fromarray(image)
    if image.mode in ["P", "PA"]:
        image = image.convert("RGB")
    img_buffer = io.BytesIO()
    image.save(img_buffer, format=format)
    buffer_bytes = img_buffer.getvalue()
    img_buffer.close()
    return buffer_bytes