Skip to content

_stats

StatsModelsTimeframe

Bases: StrEnum

Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
16
17
18
19
class StatsModelsTimeframe(StrEnum):
    day = auto()
    month = auto()
    total = auto()

day class-attribute instance-attribute 

day = auto()

month class-attribute instance-attribute 

month = auto()

total class-attribute instance-attribute 

total = auto()

ImageStatsModelsResponse

Bases: HordeResponseBaseModel

Represents the data returned from the /v2/stats/img/models endpoint.

v2 API Model: ImgModelStats

Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
22
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
@Unequatable
@Unhashable
class ImageStatsModelsResponse(HordeResponseBaseModel):
    """Represents the data returned from the `/v2/stats/img/models` endpoint.

    v2 API Model: `ImgModelStats`
    """

    day: dict[str, int]
    """The stats for the past day."""
    month: dict[str, int]
    """The stats for the past month."""
    total: dict[str, int]
    """The total stats for all time."""

    @field_validator("day", "month", "total", mode="before")
    @classmethod
    def validate_timeframe_data(cls, v: dict[str, int | None]) -> dict[str, int]:
        """Validate the data for a timeframe.

        Args:
            v (dict[str, int | None]): The data for a timeframe.

        Raises:
            ValueError: If the data is invalid.

        Returns:
            dict[str, int]: The data for a timeframe.
        """
        if v is None:
            return {}

        if "additionalProp1" in v:
            logger.warning("Found `additionalProp` in stats data, this is a dummy result. Ignoring.")
            return {}

        return_v = {}
        # Replace all `None` values with 0
        for key, value in v.items():
            if value is None:
                return_v[key] = 0
            else:
                return_v[key] = value

        return return_v

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return "ImgModelStats"

    def get_timeframe(self, timeframe: StatsModelsTimeframe) -> dict[str, int]:
        """Return the data for the given timeframe.

        Args:
            timeframe (StatsModelsTimeframe): The timeframe to get the data for.

        Returns:
            dict[str, int]: The data for the given timeframe.
        """
        if timeframe == StatsModelsTimeframe.day:
            return self.day
        if timeframe == StatsModelsTimeframe.month:
            return self.month
        if timeframe == StatsModelsTimeframe.total:
            return self.total

        raise ValueError(f"Invalid timeframe: {timeframe}")

day instance-attribute 

day: dict[str, int]

The stats for the past day.

month instance-attribute 

month: dict[str, int]

The stats for the past month.

total instance-attribute 

total: dict[str, int]

The total stats for all time.

validate_timeframe_data classmethod 

validate_timeframe_data(v: dict[str, int | None]) -> dict[str, int]

Validate the data for a timeframe.

Parameters:

  • v (dict[str, int | None]) –

    The data for a timeframe.

Raises:

  • ValueError –

    If the data is invalid.

Returns:

  • dict[str, int] –

    dict[str, int]: The data for a timeframe.

Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
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
@field_validator("day", "month", "total", mode="before")
@classmethod
def validate_timeframe_data(cls, v: dict[str, int | None]) -> dict[str, int]:
    """Validate the data for a timeframe.

    Args:
        v (dict[str, int | None]): The data for a timeframe.

    Raises:
        ValueError: If the data is invalid.

    Returns:
        dict[str, int]: The data for a timeframe.
    """
    if v is None:
        return {}

    if "additionalProp1" in v:
        logger.warning("Found `additionalProp` in stats data, this is a dummy result. Ignoring.")
        return {}

    return_v = {}
    # Replace all `None` values with 0
    for key, value in v.items():
        if value is None:
            return_v[key] = 0
        else:
            return_v[key] = value

    return return_v

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
68
69
70
71
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "ImgModelStats"

get_timeframe 

get_timeframe(timeframe: StatsModelsTimeframe) -> dict[str, int]

Return the data for the given timeframe.

Parameters:

Returns:

  • dict[str, int] –

    dict[str, int]: The data for the given timeframe.

Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
def get_timeframe(self, timeframe: StatsModelsTimeframe) -> dict[str, int]:
    """Return the data for the given timeframe.

    Args:
        timeframe (StatsModelsTimeframe): The timeframe to get the data for.

    Returns:
        dict[str, int]: The data for the given timeframe.
    """
    if timeframe == StatsModelsTimeframe.day:
        return self.day
    if timeframe == StatsModelsTimeframe.month:
        return self.month
    if timeframe == StatsModelsTimeframe.total:
        return self.total

    raise ValueError(f"Invalid timeframe: {timeframe}")

ImageStatsModelsRequest

Bases: BaseAIHordeRequest

Represents the data needed to make a request to the /v2/stats/img/models endpoint.

Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
class ImageStatsModelsRequest(BaseAIHordeRequest):
    """Represents the data needed to make a request to the `/v2/stats/img/models` endpoint."""

    model_config = ConfigDict(
        protected_namespaces=(),  # Allows the "model_" prefix on attrs
    )

    model_state: MODEL_STATE = Field(
        default=MODEL_STATE.all,
    )
    """The state of the models to get stats for. Known models are models that are known to the system."""

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return None

    @override
    @classmethod
    def get_http_method(cls) -> HTTPMethod:
        return HTTPMethod.GET

    @override
    @classmethod
    def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
        return AI_HORDE_API_ENDPOINT_SUBPATH.v2_stats_img_models

    @override
    @classmethod
    def get_default_success_response_type(cls) -> type[ImageStatsModelsResponse]:
        return ImageStatsModelsResponse

model_config class-attribute instance-attribute 

model_config = ConfigDict(protected_namespaces=())

model_state class-attribute instance-attribute 

model_state: MODEL_STATE = Field(default=all)

The state of the models to get stats for. Known models are models that are known to the system.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
104
105
106
107
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return None

get_http_method classmethod 

get_http_method() -> HTTPMethod
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
109
110
111
112
@override
@classmethod
def get_http_method(cls) -> HTTPMethod:
    return HTTPMethod.GET

get_api_endpoint_subpath classmethod 

get_api_endpoint_subpath() -> AI_HORDE_API_ENDPOINT_SUBPATH
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
114
115
116
117
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_stats_img_models

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[ImageStatsModelsResponse]
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
119
120
121
122
@override
@classmethod
def get_default_success_response_type(cls) -> type[ImageStatsModelsResponse]:
    return ImageStatsModelsResponse

SinglePeriodImgStat

Bases: HordeAPIObjectBaseModel

Represents the stats for a single period of image generation.

v2 API Model: SinglePeriodImgStat

Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
class SinglePeriodImgStat(HordeAPIObjectBaseModel):
    """Represents the stats for a single period of image generation.

    v2 API Model: `SinglePeriodImgStat`
    """

    images: int | None = Field(
        default=None,
    )
    """The amount of images generated during this period."""
    ps: int | None = Field(
        default=None,
    )
    """The amount of pixelsteps generated during this period."""

    @property
    def mps(self) -> int | None:
        """The amount of megapixelsteps generated during this period."""
        if self.ps is None:
            return None

        return self.ps // 1_000_000

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return "SinglePeriodImgStat"

images class-attribute instance-attribute 

images: int | None = Field(default=None)

The amount of images generated during this period.

ps class-attribute instance-attribute 

ps: int | None = Field(default=None)

The amount of pixelsteps generated during this period.

mps property 

mps: int | None

The amount of megapixelsteps generated during this period.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
148
149
150
151
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "SinglePeriodImgStat"

ImageStatsModelsTotalResponse

Bases: HordeResponseBaseModel

Represents the data returned from the /v2/stats/img/totals endpoint.

Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
class ImageStatsModelsTotalResponse(HordeResponseBaseModel):
    """Represents the data returned from the `/v2/stats/img/totals` endpoint."""

    day: SinglePeriodImgStat | None = None
    """The total stats for the past day."""
    hour: SinglePeriodImgStat | None = None
    """The total stats for the past hour."""
    minute: SinglePeriodImgStat | None = None
    """The total stats for the past minute."""
    month: SinglePeriodImgStat | None = None
    """The total stats for the past month."""
    total: SinglePeriodImgStat | None = None
    """The total stats for all time."""

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return "StatsImgTotals"

day class-attribute instance-attribute 

day: SinglePeriodImgStat | None = None

The total stats for the past day.

hour class-attribute instance-attribute 

hour: SinglePeriodImgStat | None = None

The total stats for the past hour.

minute class-attribute instance-attribute 

minute: SinglePeriodImgStat | None = None

The total stats for the past minute.

month class-attribute instance-attribute 

month: SinglePeriodImgStat | None = None

The total stats for the past month.

total class-attribute instance-attribute 

total: SinglePeriodImgStat | None = None

The total stats for all time.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
168
169
170
171
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "StatsImgTotals"

ImageStatsModelsTotalRequest

Bases: BaseAIHordeRequest

Represents the data needed to make a request to the /v2/stats/img/totals endpoint.

Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
class ImageStatsModelsTotalRequest(BaseAIHordeRequest):
    """Represents the data needed to make a request to the `/v2/stats/img/totals` endpoint."""

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return None

    @override
    @classmethod
    def get_http_method(cls) -> HTTPMethod:
        return HTTPMethod.GET

    @override
    @classmethod
    def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
        return AI_HORDE_API_ENDPOINT_SUBPATH.v2_stats_img_totals

    @override
    @classmethod
    def get_default_success_response_type(cls) -> type[ImageStatsModelsTotalResponse]:
        return ImageStatsModelsTotalResponse

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
177
178
179
180
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return None

get_http_method classmethod 

get_http_method() -> HTTPMethod
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
182
183
184
185
@override
@classmethod
def get_http_method(cls) -> HTTPMethod:
    return HTTPMethod.GET

get_api_endpoint_subpath classmethod 

get_api_endpoint_subpath() -> AI_HORDE_API_ENDPOINT_SUBPATH
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
187
188
189
190
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_stats_img_totals

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[ImageStatsModelsTotalResponse]
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
192
193
194
195
@override
@classmethod
def get_default_success_response_type(cls) -> type[ImageStatsModelsTotalResponse]:
    return ImageStatsModelsTotalResponse

TextStatsModelResponse

Bases: HordeResponseBaseModel

Represents the data returned from the /v2/stats/text/models endpoint.

Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
@Unhashable
class TextStatsModelResponse(HordeResponseBaseModel):
    """Represents the data returned from the `/v2/stats/text/models` endpoint."""

    day: dict[str, int]
    """The stats for the past day."""
    month: dict[str, int]
    """The stats for the past month."""
    total: dict[str, int]
    """The total stats for all time."""

    @field_validator("day", "month", "total", mode="before")
    @classmethod
    def validate_timeframe_data(cls, v: dict[str, int | None]) -> dict[str, int]:
        """Validate the data for a timeframe.

        Args:
            v (dict[str, int | None]): The data for a timeframe.

        Raises:
            ValueError: If the data is invalid.

        Returns:
            dict[str, int]: The data for a timeframe.
        """
        if v is None:
            return {}

        return_v = {}
        # Replace all `None` values with 0
        for key, value in v.items():
            if value is None:
                return_v[key] = 0
            else:
                return_v[key] = value

        return return_v

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return "TxtModelStats"

day instance-attribute 

day: dict[str, int]

The stats for the past day.

month instance-attribute 

month: dict[str, int]

The stats for the past month.

total instance-attribute 

total: dict[str, int]

The total stats for all time.

validate_timeframe_data classmethod 

validate_timeframe_data(v: dict[str, int | None]) -> dict[str, int]

Validate the data for a timeframe.

Parameters:

  • v (dict[str, int | None]) –

    The data for a timeframe.

Raises:

  • ValueError –

    If the data is invalid.

Returns:

  • dict[str, int] –

    dict[str, int]: The data for a timeframe.

Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
@field_validator("day", "month", "total", mode="before")
@classmethod
def validate_timeframe_data(cls, v: dict[str, int | None]) -> dict[str, int]:
    """Validate the data for a timeframe.

    Args:
        v (dict[str, int | None]): The data for a timeframe.

    Raises:
        ValueError: If the data is invalid.

    Returns:
        dict[str, int]: The data for a timeframe.
    """
    if v is None:
        return {}

    return_v = {}
    # Replace all `None` values with 0
    for key, value in v.items():
        if value is None:
            return_v[key] = 0
        else:
            return_v[key] = value

    return return_v

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
236
237
238
239
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "TxtModelStats"

TextStatsModelsRequest

Bases: BaseAIHordeRequest

Represents the data needed to make a request to the /v2/stats/text/models endpoint.

Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
class TextStatsModelsRequest(BaseAIHordeRequest):
    """Represents the data needed to make a request to the `/v2/stats/text/models` endpoint."""

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return None

    @override
    @classmethod
    def get_http_method(cls) -> HTTPMethod:
        return HTTPMethod.GET

    @override
    @classmethod
    def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
        return AI_HORDE_API_ENDPOINT_SUBPATH.v2_stats_text_models

    @override
    @classmethod
    def get_default_success_response_type(cls) -> type[TextStatsModelResponse]:
        return TextStatsModelResponse

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
245
246
247
248
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return None

get_http_method classmethod 

get_http_method() -> HTTPMethod
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
250
251
252
253
@override
@classmethod
def get_http_method(cls) -> HTTPMethod:
    return HTTPMethod.GET

get_api_endpoint_subpath classmethod 

get_api_endpoint_subpath() -> AI_HORDE_API_ENDPOINT_SUBPATH
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
255
256
257
258
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_stats_text_models

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[TextStatsModelResponse]
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
260
261
262
263
@override
@classmethod
def get_default_success_response_type(cls) -> type[TextStatsModelResponse]:
    return TextStatsModelResponse

SinglePeriodTxtStat

Bases: HordeAPIObjectBaseModel

Represents the stats for a single period.

v2 API Model: SinglePeriodTxtStat

Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
class SinglePeriodTxtStat(HordeAPIObjectBaseModel):
    """Represents the stats for a single period.

    v2 API Model: `SinglePeriodTxtStat`
    """

    requests: int | None = Field(
        default=None,
    )
    """The number of requests made during this period."""
    tokens: int | None = Field(
        default=None,
    )
    """The number of tokens generated during this period."""

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return "SinglePeriodTxtStat"

requests class-attribute instance-attribute 

requests: int | None = Field(default=None)

The number of requests made during this period.

tokens class-attribute instance-attribute 

tokens: int | None = Field(default=None)

The number of tokens generated during this period.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
281
282
283
284
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "SinglePeriodTxtStat"

TextStatsModelsTotalResponse

Bases: HordeResponseBaseModel

Represents the data returned from the /v2/stats/text/totals endpoint.

Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
@Unhashable
class TextStatsModelsTotalResponse(HordeResponseBaseModel):
    """Represents the data returned from the `/v2/stats/text/totals` endpoint."""

    minute: dict[str, int]
    """The total stats for the past minute."""
    hour: dict[str, int]
    """The total stats for the past hour."""
    day: dict[str, int]
    """The total stats for the past day."""
    month: dict[str, int]
    """The total stats for the past month."""
    total: dict[str, int]
    """The total stats for all time."""

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return "StatsTxtTotals"

minute instance-attribute 

minute: dict[str, int]

The total stats for the past minute.

hour instance-attribute 

hour: dict[str, int]

The total stats for the past hour.

day instance-attribute 

day: dict[str, int]

The total stats for the past day.

month instance-attribute 

month: dict[str, int]

The total stats for the past month.

total instance-attribute 

total: dict[str, int]

The total stats for all time.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
302
303
304
305
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "StatsTxtTotals"

TextStatsModelsTotalRequest

Bases: BaseAIHordeRequest

Represents the data needed to make a request to the /v2/stats/text/totals endpoint.

Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
class TextStatsModelsTotalRequest(BaseAIHordeRequest):
    """Represents the data needed to make a request to the `/v2/stats/text/totals` endpoint."""

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return None

    @override
    @classmethod
    def get_http_method(cls) -> HTTPMethod:
        return HTTPMethod.GET

    @override
    @classmethod
    def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
        return AI_HORDE_API_ENDPOINT_SUBPATH.v2_stats_text_totals

    @override
    @classmethod
    def get_default_success_response_type(cls) -> type[TextStatsModelsTotalResponse]:
        return TextStatsModelsTotalResponse

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
311
312
313
314
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return None

get_http_method classmethod 

get_http_method() -> HTTPMethod
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
316
317
318
319
@override
@classmethod
def get_http_method(cls) -> HTTPMethod:
    return HTTPMethod.GET

get_api_endpoint_subpath classmethod 

get_api_endpoint_subpath() -> AI_HORDE_API_ENDPOINT_SUBPATH
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
321
322
323
324
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_stats_text_totals

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[TextStatsModelsTotalResponse]
Source code in horde_sdk/ai_horde_api/apimodels/_stats.py 
326
327
328
329
@override
@classmethod
def get_default_success_response_type(cls) -> type[TextStatsModelsTotalResponse]:
    return TextStatsModelsTotalResponse