Skip to content

_status

AIHordeHeartbeatResponse

Bases: HordeResponseBaseModel, ContainsMessageResponseMixin

Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
19
20
21
22
23
24
25
26
class AIHordeHeartbeatResponse(HordeResponseBaseModel, ContainsMessageResponseMixin):
    version: str
    """The version of the AI Horde API that this node is running."""

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

version instance-attribute 

version: str

The version of the AI Horde API that this node is running.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
23
24
25
26
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return None

AIHordeHeartbeatRequest

Bases: BaseAIHordeRequest

Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
class AIHordeHeartbeatRequest(BaseAIHordeRequest):
    @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_status_heartbeat

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

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
30
31
32
33
@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/_status.py 
35
36
37
38
@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/_status.py 
40
41
42
43
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_status_heartbeat

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[AIHordeHeartbeatResponse]
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
45
46
47
48
@override
@classmethod
def get_default_success_response_type(cls) -> type[AIHordeHeartbeatResponse]:
    return AIHordeHeartbeatResponse

HordePerformanceResponse

Bases: HordeResponseBaseModel

Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
 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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
class HordePerformanceResponse(HordeResponseBaseModel):
    interrogator_count: int | None = Field(
        default=None,
        description=(
            "How many workers are actively processing image interrogations in this {horde_noun} in the past 5 minutes."
        ),
    )
    """How many workers are actively processing image interrogations in this {horde_noun} in the past 5 minutes."""
    interrogator_thread_count: int | None = Field(
        default=None,
        description=(
            "How many worker threads are actively processing image interrogation in this {horde_noun} in the past 5"
            " minutes."
        ),
    )
    """How many worker threads are actively processing image interrogation in this {horde_noun} in the past 5
    minutes."""
    past_minute_megapixelsteps: float | None = Field(
        default=None,
    )
    """How many megapixelsteps this horde generated in the last minute."""
    past_minute_tokens: float | None = Field(
        default=None,
    )
    """How many tokens this horde generated in the last minute."""
    queued_forms: float | None = Field(
        default=None,
    )
    """The amount of image interrogations waiting and processing currently in this horde."""
    queued_megapixelsteps: float | None = Field(
        default=None,
    )
    """The amount of megapixelsteps in waiting and processing requests currently in this horde."""
    queued_requests: int | None = Field(
        default=None,
    )
    """The amount of waiting and processing image requests currently in this horde."""
    queued_text_requests: int | None = Field(
        default=None,
    )
    """The amount of waiting and processing text requests currently in this horde."""
    queued_tokens: float | None = Field(
        default=None,
    )
    """The amount of tokens in waiting and processing requests currently in this horde."""
    text_thread_count: int | None = Field(
        default=None,
        description=(
            "How many worker threads are actively processing prompt generations in this {horde_noun} in the past 5"
            " minutes."
        ),
    )
    """How many worker threads are actively processing prompt generations in this {horde_noun} in the past 5
    minutes."""
    text_worker_count: int | None = Field(
        default=None,
    )
    """How many workers are actively processing prompt generations in this horde in the past 5 minutes."""
    thread_count: int | None = Field(
        default=None,
        description=(
            "How many worker threads are actively processing prompt generations in this {horde_noun} in the past 5"
            " minutes."
        ),
    )
    """How many worker threads are actively processing prompt generations in this {horde_noun} in the past 5
    minutes."""
    worker_count: int | None = Field(
        default=None,
    )
    """How many workers are actively processing prompt generations in this horde in the past 5 minutes."""

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

interrogator_count class-attribute instance-attribute 

interrogator_count: int | None = Field(default=None, description='How many workers are actively processing image interrogations in this {horde_noun} in the past 5 minutes.')

How many workers are actively processing image interrogations in this {horde_noun} in the past 5 minutes.

interrogator_thread_count class-attribute instance-attribute 

interrogator_thread_count: int | None = Field(default=None, description='How many worker threads are actively processing image interrogation in this {horde_noun} in the past 5 minutes.')

How many worker threads are actively processing image interrogation in this {horde_noun} in the past 5 minutes.

past_minute_megapixelsteps class-attribute instance-attribute 

past_minute_megapixelsteps: float | None = Field(default=None)

How many megapixelsteps this horde generated in the last minute.

past_minute_tokens class-attribute instance-attribute 

past_minute_tokens: float | None = Field(default=None)

How many tokens this horde generated in the last minute.

queued_forms class-attribute instance-attribute 

queued_forms: float | None = Field(default=None)

The amount of image interrogations waiting and processing currently in this horde.

queued_megapixelsteps class-attribute instance-attribute 

queued_megapixelsteps: float | None = Field(default=None)

The amount of megapixelsteps in waiting and processing requests currently in this horde.

queued_requests class-attribute instance-attribute 

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

The amount of waiting and processing image requests currently in this horde.

queued_text_requests class-attribute instance-attribute 

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

The amount of waiting and processing text requests currently in this horde.

queued_tokens class-attribute instance-attribute 

queued_tokens: float | None = Field(default=None)

The amount of tokens in waiting and processing requests currently in this horde.

text_thread_count class-attribute instance-attribute 

text_thread_count: int | None = Field(default=None, description='How many worker threads are actively processing prompt generations in this {horde_noun} in the past 5 minutes.')

How many worker threads are actively processing prompt generations in this {horde_noun} in the past 5 minutes.

text_worker_count class-attribute instance-attribute 

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

How many workers are actively processing prompt generations in this horde in the past 5 minutes.

thread_count class-attribute instance-attribute 

thread_count: int | None = Field(default=None, description='How many worker threads are actively processing prompt generations in this {horde_noun} in the past 5 minutes.')

How many worker threads are actively processing prompt generations in this {horde_noun} in the past 5 minutes.

worker_count class-attribute instance-attribute 

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

How many workers are actively processing prompt generations in this horde in the past 5 minutes.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
123
124
125
126
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "HordePerformance"

HordePerformanceRequest

Bases: BaseAIHordeRequest

Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
class HordePerformanceRequest(BaseAIHordeRequest):
    @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_status_performance

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

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
130
131
132
133
@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/_status.py 
135
136
137
138
@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/_status.py 
140
141
142
143
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_status_performance

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[HordePerformanceResponse]
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
145
146
147
148
@override
@classmethod
def get_default_success_response_type(cls) -> type[HordePerformanceResponse]:
    return HordePerformanceResponse

Newspiece

Bases: HordeAPIObjectBaseModel

Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
class Newspiece(HordeAPIObjectBaseModel):
    date_published: str | None = Field(
        default=None,
    )
    """The date this newspiece was published."""
    importance: str | None = Field(default=None, examples=["Information"])
    """How critical this piece of news is."""
    newspiece: str | None = Field(
        default=None,
    )
    """The actual piece of news."""
    tags: list[str] | None = Field(
        default=None,
    )
    """The tags associated with this newspiece."""
    title: str | None = Field(
        default=None,
    )
    """The title of this newspiece."""
    more_info_urls: list[str] | None = Field(
        default=None,
    )
    """The URLs for more information about this newspiece."""

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

date_published class-attribute instance-attribute 

date_published: str | None = Field(default=None)

The date this newspiece was published.

importance class-attribute instance-attribute 

importance: str | None = Field(default=None, examples=['Information'])

How critical this piece of news is.

newspiece class-attribute instance-attribute 

newspiece: str | None = Field(default=None)

The actual piece of news.

tags class-attribute instance-attribute 

tags: list[str] | None = Field(default=None)

The tags associated with this newspiece.

title class-attribute instance-attribute 

title: str | None = Field(default=None)

The title of this newspiece.

more_info_urls class-attribute instance-attribute 

more_info_urls: list[str] | None = Field(default=None)

The URLs for more information about this newspiece.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
175
176
177
178
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "Newspiece"

NewsResponse

Bases: HordeResponseRootModel[list[Newspiece]]

Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
@Unhashable
class NewsResponse(HordeResponseRootModel[list[Newspiece]]):
    root: list[Newspiece]
    """The underlying list of newspieces."""

    def __iter__(self) -> Iterator[Newspiece]:  # type: ignore
        return iter(self.root)

    def __getitem__(self, index: int) -> Newspiece:
        return self.root[index]

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

    def __eq__(self, other: object) -> bool:
        if not isinstance(other, NewsResponse):
            return False
        return all(newspiece in other.root for newspiece in self.root)

root instance-attribute 

root: list[Newspiece]

The underlying list of newspieces.

__iter__ 

__iter__() -> Iterator[Newspiece]
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
186
187
def __iter__(self) -> Iterator[Newspiece]:  # type: ignore
    return iter(self.root)

__getitem__ 

__getitem__(index: int) -> Newspiece
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
189
190
def __getitem__(self, index: int) -> Newspiece:
    return self.root[index]

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
192
193
194
195
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return None  # FIXME

__eq__ 

__eq__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
197
198
199
200
def __eq__(self, other: object) -> bool:
    if not isinstance(other, NewsResponse):
        return False
    return all(newspiece in other.root for newspiece in self.root)

NewsRequest

Bases: BaseAIHordeRequest

Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
class NewsRequest(BaseAIHordeRequest):
    @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_status_news

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

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
204
205
206
207
@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/_status.py 
209
210
211
212
@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/_status.py 
214
215
216
217
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_status_news

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[NewsResponse]
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
219
220
221
222
@override
@classmethod
def get_default_success_response_type(cls) -> type[NewsResponse]:
    return NewsResponse

ActiveModelLite

Bases: HordeAPIObjectBaseModel

Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
225
226
227
228
229
230
231
232
233
234
235
236
237
238
class ActiveModelLite(HordeAPIObjectBaseModel):
    count: int | None = Field(
        default=None,
    )
    """How many of workers in this horde are running this model."""
    name: str | None = Field(
        default=None,
    )
    """The Name of a model available by workers in this horde."""

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

count class-attribute instance-attribute 

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

How many of workers in this horde are running this model.

name class-attribute instance-attribute 

name: str | None = Field(default=None)

The Name of a model available by workers in this horde.

get_api_model_name classmethod 

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

ActiveModel

Bases: ActiveModelLite

Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
class ActiveModel(ActiveModelLite):
    eta: int | None = Field(
        default=None,
    )
    """Estimated time in seconds for this model's queue to be cleared."""
    jobs: float | None = Field(
        default=None,
    )
    """The job count waiting to be generated by this model."""
    performance: float | None = Field(
        default=None,
    )
    """The average speed of generation for this model."""
    queued: float | None = Field(
        default=None,
    )
    """The amount waiting to be generated by this model."""
    type_: MODEL_TYPE | None = Field(
        examples=[MODEL_TYPE.image, MODEL_TYPE.text],
        alias="type",
    )
    """The model type (text or image)."""

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

eta class-attribute instance-attribute 

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

Estimated time in seconds for this model's queue to be cleared.

jobs class-attribute instance-attribute 

jobs: float | None = Field(default=None)

The job count waiting to be generated by this model.

performance class-attribute instance-attribute 

performance: float | None = Field(default=None)

The average speed of generation for this model.

queued class-attribute instance-attribute 

queued: float | None = Field(default=None)

The amount waiting to be generated by this model.

type_ class-attribute instance-attribute 

type_: MODEL_TYPE | None = Field(examples=[image, text], alias='type')

The model type (text or image).

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
264
265
266
267
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "ActiveModel"

HordeStatusModelsAllResponse

Bases: HordeResponseRootModel[list[ActiveModel]]

Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
@Unhashable
class HordeStatusModelsAllResponse(HordeResponseRootModel[list[ActiveModel]]):
    root: list[ActiveModel]
    """The underlying list of models."""

    def __iter__(self) -> Iterator[ActiveModel]:  # type: ignore
        return iter(self.root)

    def __getitem__(self, index: int) -> ActiveModel:
        return self.root[index]

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

    def __eq__(self, other: object) -> bool:
        if not isinstance(other, HordeStatusModelsAllResponse):
            return False
        return all(model in other.root for model in self.root)

root instance-attribute 

root: list[ActiveModel]

The underlying list of models.

__iter__ 

__iter__() -> Iterator[ActiveModel]
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
275
276
def __iter__(self) -> Iterator[ActiveModel]:  # type: ignore
    return iter(self.root)

__getitem__ 

__getitem__(index: int) -> ActiveModel
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
278
279
def __getitem__(self, index: int) -> ActiveModel:
    return self.root[index]

get_api_model_name classmethod 

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

__eq__ 

__eq__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
286
287
288
289
def __eq__(self, other: object) -> bool:
    if not isinstance(other, HordeStatusModelsAllResponse):
        return False
    return all(model in other.root for model in self.root)

HordeStatusModelsAllRequest

Bases: BaseAIHordeRequest

Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
class HordeStatusModelsAllRequest(BaseAIHordeRequest):
    model_config = ConfigDict(
        protected_namespaces=(),  # Allows the "model_" prefix on attrs
    )

    type_: MODEL_TYPE = Field(
        default=MODEL_TYPE.image,
        examples=[MODEL_TYPE.image, MODEL_TYPE.text],
        alias="type",
    )
    """The type of model to filter by."""

    min_count: int | None = None
    """Filter only models that have at least this amount of threads serving."""
    max_count: int | None = None
    """Filter only models that have at most this amount of threads serving."""

    model_state: MODEL_STATE = MODEL_STATE.all
    """If 'known', only show stats for known models in the model reference. If 'custom' only show stats for custom
    models. If 'all' shows stats for all models."""

    @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_status_models_all

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

    @override
    @classmethod
    def get_query_fields(cls) -> list[str]:
        return ["type_", "min_count", "max_count"]

model_config class-attribute instance-attribute 

model_config = ConfigDict(protected_namespaces=())

type_ class-attribute instance-attribute 

type_: MODEL_TYPE = Field(default=image, examples=[image, text], alias='type')

The type of model to filter by.

min_count class-attribute instance-attribute 

min_count: int | None = None

Filter only models that have at least this amount of threads serving.

max_count class-attribute instance-attribute 

max_count: int | None = None

Filter only models that have at most this amount of threads serving.

model_state class-attribute instance-attribute 

model_state: MODEL_STATE = all

If 'known', only show stats for known models in the model reference. If 'custom' only show stats for custom models. If 'all' shows stats for all models.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
313
314
315
316
@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/_status.py 
318
319
320
321
@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/_status.py 
323
324
325
326
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_status_models_all

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[HordeStatusModelsAllResponse]
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
328
329
330
331
@override
@classmethod
def get_default_success_response_type(cls) -> type[HordeStatusModelsAllResponse]:
    return HordeStatusModelsAllResponse

get_query_fields classmethod 

get_query_fields() -> list[str]
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
333
334
335
336
@override
@classmethod
def get_query_fields(cls) -> list[str]:
    return ["type_", "min_count", "max_count"]

HordeStatusModelsSingleResponse

Bases: HordeResponseRootModel[list[ActiveModel]]

Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
@Unhashable
class HordeStatusModelsSingleResponse(HordeResponseRootModel[list[ActiveModel]]):
    # This is a list because of an oversight in the structure of the API response. # FIXME

    root: list[ActiveModel]
    """The underlying list of models."""

    def __iter__(self) -> Iterator[ActiveModel]:  # type: ignore
        return iter(self.root)

    def __getitem__(self, index: int) -> ActiveModel:
        return self.root[index]

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

    def __eq__(self, other: object) -> bool:
        if not isinstance(other, HordeStatusModelsSingleResponse):
            return False
        return all(model in other.root for model in self.root)

root instance-attribute 

root: list[ActiveModel]

The underlying list of models.

__iter__ 

__iter__() -> Iterator[ActiveModel]
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
346
347
def __iter__(self) -> Iterator[ActiveModel]:  # type: ignore
    return iter(self.root)

__getitem__ 

__getitem__(index: int) -> ActiveModel
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
349
350
def __getitem__(self, index: int) -> ActiveModel:
    return self.root[index]

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
352
353
354
355
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return None

__eq__ 

__eq__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
357
358
359
360
def __eq__(self, other: object) -> bool:
    if not isinstance(other, HordeStatusModelsSingleResponse):
        return False
    return all(model in other.root for model in self.root)

HordeStatusModelsSingleRequest

Bases: BaseAIHordeRequest

Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
class HordeStatusModelsSingleRequest(BaseAIHordeRequest):
    model_config = ConfigDict(
        protected_namespaces=(),  # Allows the "model_" prefix on attrs
    )

    model_name: str
    """The name of the model to request."""

    @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_status_models_single

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

model_config class-attribute instance-attribute 

model_config = ConfigDict(protected_namespaces=())

model_name instance-attribute 

model_name: str

The name of the model to request.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
371
372
373
374
@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/_status.py 
376
377
378
379
@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/_status.py 
381
382
383
384
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_status_models_single

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[HordeStatusModelsSingleResponse]
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
386
387
388
389
@override
@classmethod
def get_default_success_response_type(cls) -> type[HordeStatusModelsSingleResponse]:
    return HordeStatusModelsSingleResponse

HordeModes

Bases: HordeAPIObjectBaseModel

Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
class HordeModes(HordeAPIObjectBaseModel):
    maintenance_mode: bool = Field(
        default=False,
    )
    """Whether the horde is in maintenance mode."""

    invite_only_mode: bool = Field(
        default=False,
    )
    """Whether the horde is in invite-only mode."""

    raid_mode: bool = Field(
        default=False,
    )
    """Whether the horde is in raid mode."""

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

maintenance_mode class-attribute instance-attribute 

maintenance_mode: bool = Field(default=False)

Whether the horde is in maintenance mode.

invite_only_mode class-attribute instance-attribute 

invite_only_mode: bool = Field(default=False)

Whether the horde is in invite-only mode.

raid_mode class-attribute instance-attribute 

raid_mode: bool = Field(default=False)

Whether the horde is in raid mode.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_status.py 
408
409
410
411
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "HordeModes"