Skip to content

errors

StreamError

Bases: BaseStreamError

Error with a specific error code that maps to a localized user-facing error message.

Source code in chatkit/errors.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
class StreamError(BaseStreamError):
    """
    Error with a specific error code that maps to a localized user-facing
    error message.
    """

    code: ErrorCode

    def __init__(
        self,
        code: ErrorCode,
        *,
        allow_retry: bool | None = None,
    ):
        self.code = code
        self.status_code = DEFAULT_STATUS.get(code, 500)
        if allow_retry is None:
            self.allow_retry = DEFAULT_ALLOW_RETRY.get(code, False)
        else:
            self.allow_retry = allow_retry

CustomStreamError

Bases: BaseStreamError

Error with a custom user-facing error message. The message should be localized as needed before raising the error.

Source code in chatkit/errors.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
class CustomStreamError(BaseStreamError):
    """
    Error with a custom user-facing error message. The message should be
    localized as needed before raising the error.
    """

    message: str
    """The user-facing error message to display."""

    def __init__(
        self,
        message: str,
        *,
        allow_retry: bool = False,
    ):
        self.message = message
        self.allow_retry = allow_retry

message instance-attribute 

message: str = message

The user-facing error message to display.