Skip to content

_status

Generation

Bases: HordeAPIObjectBaseModel

Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class Generation(HordeAPIObjectBaseModel):
    model: str = Field(title="Generation Model")
    """The model which generated this image."""
    state: GENERATION_STATE = Field(
        ...,
        examples=["ok"],
        title="Generation State",
    )
    """OBSOLETE (Use the gen_metadata field). The state of this generation."""
    worker_id: str | WorkerID = Field(
        title="Worker ID",
    )
    """The UUID of the worker which generated this image."""
    worker_name: str = Field(
        title="Worker Name",
    )
    """The name of the worker which generated this image."""

model class-attribute instance-attribute 

model: str = Field(title='Generation Model')

The model which generated this image.

state class-attribute instance-attribute 

state: GENERATION_STATE = Field(..., examples=['ok'], title='Generation State')

OBSOLETE (Use the gen_metadata field). The state of this generation.

worker_id class-attribute instance-attribute 

worker_id: str | WorkerID = Field(title='Worker ID')

The UUID of the worker which generated this image.

worker_name class-attribute instance-attribute 

worker_name: str = Field(title='Worker Name')

The name of the worker which generated this image.

ImageGeneration

Bases: Generation

Represents the individual image generation responses in a ImageGenerateStatusResponse.

v2 API Model: GenerationStable

Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.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
class ImageGeneration(Generation):
    """Represents the individual image generation responses in a ImageGenerateStatusResponse.

    v2 API Model: `GenerationStable`
    """

    id_: JobID = Field(alias="id")
    """The UUID of this generation. Is always returned as a `JobID`, but can initialized from a `str`."""
    # todo: remove `str`?
    img: str
    """The generated image as a Base64-encoded .webp file."""
    seed: str
    """The seed which generated this image."""
    censored: bool
    """When true this image has been censored by the worker's safety filter."""
    gen_metadata: list[GenMetadataEntry] | None = None
    """Extra metadata about faulted or defaulted components of the generation"""

    @override
    @classmethod
    def get_api_model_name(self) -> str | None:
        return "GenerationStable"

    @field_validator("id_", mode="before")
    def validate_id(cls, v: str | JobID) -> JobID | str:
        if isinstance(v, str) and v == "":
            logger.warning("Job ID is empty")
            return JobID(root=uuid.uuid4())

        return v

    def __eq__(self, other: object) -> bool:
        if not isinstance(other, ImageGeneration):
            return False
        return self.id_ == other.id_

    def __hash__(self) -> int:
        return hash(ImageGeneration.__name__) + hash(self.id_)

id_ class-attribute instance-attribute 

id_: JobID = Field(alias='id')

The UUID of this generation. Is always returned as a JobID, but can initialized from a str.

img instance-attribute 

img: str

The generated image as a Base64-encoded .webp file.

seed instance-attribute 

seed: str

The seed which generated this image.

censored instance-attribute 

censored: bool

When true this image has been censored by the worker's safety filter.

gen_metadata class-attribute instance-attribute 

gen_metadata: list[GenMetadataEntry] | None = None

Extra metadata about faulted or defaulted components of the generation

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
53
54
55
56
@override
@classmethod
def get_api_model_name(self) -> str | None:
    return "GenerationStable"

validate_id 

validate_id(v: str | JobID) -> JobID | str
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
58
59
60
61
62
63
64
@field_validator("id_", mode="before")
def validate_id(cls, v: str | JobID) -> JobID | str:
    if isinstance(v, str) and v == "":
        logger.warning("Job ID is empty")
        return JobID(root=uuid.uuid4())

    return v

__eq__ 

__eq__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
66
67
68
69
def __eq__(self, other: object) -> bool:
    if not isinstance(other, ImageGeneration):
        return False
    return self.id_ == other.id_

__hash__ 

__hash__() -> int
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
71
72
def __hash__(self) -> int:
    return hash(ImageGeneration.__name__) + hash(self.id_)

ImageGenerateStatusResponse

Bases: HordeResponseBaseModel, ResponseWithProgressMixin, ResponseGenerationProgressInfoMixin

Represent the response from the AI-Horde API when checking the status of an image generation job.

v2 API Model: RequestStatusStable

Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
 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
class ImageGenerateStatusResponse(
    HordeResponseBaseModel,
    ResponseWithProgressMixin,
    ResponseGenerationProgressInfoMixin,
):
    """Represent the response from the AI-Horde API when checking the status of an image generation job.

    v2 API Model: `RequestStatusStable`
    """

    generations: list[ImageGeneration] = Field(default_factory=list)
    """The individual image generation responses in this request."""
    shared: bool | None = False
    """If True, These images have been shared with LAION."""

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

    @override
    @classmethod
    def get_finalize_success_request_type(cls) -> None:
        return None

    @override
    def is_job_complete(self, number_of_result_expected: int) -> bool:
        return len(self.generations) == number_of_result_expected

    @override
    def is_job_possible(self) -> bool:
        return self.is_possible

    @override
    @classmethod
    def is_final_follow_up(cls) -> bool:
        return True

    def __eq__(self, other: object) -> bool:
        if not isinstance(other, ImageGenerateStatusResponse):
            return False
        return all(gen in other.generations for gen in self.generations)

    def __hash__(self) -> int:
        return hash(tuple(self.generations))

generations class-attribute instance-attribute 

generations: list[ImageGeneration] = Field(default_factory=list)

The individual image generation responses in this request.

shared class-attribute instance-attribute 

shared: bool | None = False

If True, These images have been shared with LAION.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
90
91
92
93
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "RequestStatusStable"

get_finalize_success_request_type classmethod 

get_finalize_success_request_type() -> None
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
95
96
97
98
@override
@classmethod
def get_finalize_success_request_type(cls) -> None:
    return None

is_job_complete 

is_job_complete(number_of_result_expected: int) -> bool
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
100
101
102
@override
def is_job_complete(self, number_of_result_expected: int) -> bool:
    return len(self.generations) == number_of_result_expected

is_job_possible 

is_job_possible() -> bool
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
104
105
106
@override
def is_job_possible(self) -> bool:
    return self.is_possible

is_final_follow_up classmethod 

is_final_follow_up() -> bool
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
108
109
110
111
@override
@classmethod
def is_final_follow_up(cls) -> bool:
    return True

__eq__ 

__eq__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
113
114
115
116
def __eq__(self, other: object) -> bool:
    if not isinstance(other, ImageGenerateStatusResponse):
        return False
    return all(gen in other.generations for gen in self.generations)

__hash__ 

__hash__() -> int
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
118
119
def __hash__(self) -> int:
    return hash(tuple(self.generations))

DeleteImageGenerateRequest

Bases: BaseAIHordeRequest, JobRequestMixin

Represents a DELETE request to the /v2/generate/status/{id} endpoint.

Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
122
123
124
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
152
153
154
155
156
157
class DeleteImageGenerateRequest(
    BaseAIHordeRequest,
    JobRequestMixin,
):
    """Represents a DELETE request to the `/v2/generate/status/{id}` endpoint."""

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

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

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

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

    @override
    def __eq__(self, value: object) -> bool:
        if not isinstance(value, DeleteImageGenerateRequest):
            return False

        return self.id_ == value.id_

    @override
    def __hash__(self) -> int:
        return hash(DeleteImageGenerateRequest.__name__) + hash(self.id_)

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
128
129
130
131
@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/generate/_status.py 
133
134
135
136
@override
@classmethod
def get_http_method(cls) -> HTTPMethod:
    return HTTPMethod.DELETE

get_api_endpoint_subpath classmethod 

get_api_endpoint_subpath() -> AI_HORDE_API_ENDPOINT_SUBPATH
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
138
139
140
141
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_generate_status

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[ImageGenerateStatusResponse]
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
143
144
145
146
@override
@classmethod
def get_default_success_response_type(cls) -> type[ImageGenerateStatusResponse]:
    return ImageGenerateStatusResponse

__eq__ 

__eq__(value: object) -> bool
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
148
149
150
151
152
153
@override
def __eq__(self, value: object) -> bool:
    if not isinstance(value, DeleteImageGenerateRequest):
        return False

    return self.id_ == value.id_

__hash__ 

__hash__() -> int
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
155
156
157
@override
def __hash__(self) -> int:
    return hash(DeleteImageGenerateRequest.__name__) + hash(self.id_)

ImageGenerateStatusRequest

Bases: BaseAIHordeRequest, JobRequestMixin

Represents a GET request to the /v2/generate/status/{id} endpoint.

Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
class ImageGenerateStatusRequest(BaseAIHordeRequest, JobRequestMixin):
    """Represents a GET request to the `/v2/generate/status/{id}` 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_generate_status

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

    @override
    def __eq__(self, value: object) -> bool:
        if not isinstance(value, ImageGenerateStatusRequest):
            return False

        return self.id_ == value.id_

    @override
    def __hash__(self) -> int:
        return hash(ImageGenerateStatusRequest.__name__) + hash(self.id_)

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
163
164
165
166
@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/generate/_status.py 
168
169
170
171
@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/generate/_status.py 
173
174
175
176
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_generate_status

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[ImageGenerateStatusResponse]
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
178
179
180
181
@override
@classmethod
def get_default_success_response_type(cls) -> type[ImageGenerateStatusResponse]:
    return ImageGenerateStatusResponse

__eq__ 

__eq__(value: object) -> bool
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
183
184
185
186
187
188
@override
def __eq__(self, value: object) -> bool:
    if not isinstance(value, ImageGenerateStatusRequest):
        return False

    return self.id_ == value.id_

__hash__ 

__hash__() -> int
Source code in horde_sdk/ai_horde_api/apimodels/generate/_status.py 
190
191
192
@override
def __hash__(self) -> int:
    return hash(ImageGenerateStatusRequest.__name__) + hash(self.id_)