Skip to content

_status

AlchemyUpscaleResult

Bases: HordeAPIData

Represents the result of an upscale job.

Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
19
20
21
22
23
24
25
class AlchemyUpscaleResult(HordeAPIData):
    """Represents the result of an upscale job."""

    upscaler_used: KNOWN_UPSCALERS | str
    """The upscaler used."""
    url: str
    """The URL of the upscaled image."""

upscaler_used instance-attribute 

upscaler_used: KNOWN_UPSCALERS | str

The upscaler used.

url instance-attribute 

url: str

The URL of the upscaled image.

AlchemyCaptionResult

Bases: HordeAPIData

Represents the result of a caption job.

Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
28
29
30
31
32
class AlchemyCaptionResult(HordeAPIData):
    """Represents the result of a caption job."""

    caption: str
    """The resulting caption of the image."""

caption instance-attribute 

caption: str

The resulting caption of the image.

AlchemyNSFWResult

Bases: HordeAPIData

Represents the result of an NSFW evaluation.

Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
35
36
37
38
39
class AlchemyNSFWResult(HordeAPIData):
    """Represents the result of an NSFW evaluation."""

    nsfw: bool
    """Whether the image is likely to be NSFW."""

nsfw instance-attribute 

nsfw: bool

Whether the image is likely to be NSFW.

AlchemyInterrogationResultItem

Bases: HordeAPIData

Represents an item in the result of an interrogation job.

Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
42
43
44
45
46
47
48
class AlchemyInterrogationResultItem(HordeAPIData):
    """Represents an item in the result of an interrogation job."""

    text: str
    """The text of the item."""
    confidence: float
    """The confidence of the item."""

text instance-attribute 

text: str

The text of the item.

confidence instance-attribute 

confidence: float

The confidence of the item.

AlchemyInterrogationDetails

Bases: HordeAPIData

The details of an interrogation job.

Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
class AlchemyInterrogationDetails(HordeAPIData):
    """The details of an interrogation job."""

    tags: list[AlchemyInterrogationResultItem]
    """The resulting similar tags of the image."""
    sites: list[AlchemyInterrogationResultItem]
    """The resulting similar sites of the image."""
    artists: list[AlchemyInterrogationResultItem]
    """The resulting similar artists of the image."""
    flavors: list[AlchemyInterrogationResultItem]
    """The resulting similar flavors of the image."""
    mediums: list[AlchemyInterrogationResultItem]
    """The resulting similar mediums of the image."""
    movements: list[AlchemyInterrogationResultItem]
    """The resulting similar movements of the image."""
    techniques: list[AlchemyInterrogationResultItem]
    """The resulting similar techniques of the image."""

tags instance-attribute 

tags: list[AlchemyInterrogationResultItem]

The resulting similar tags of the image.

sites instance-attribute 

sites: list[AlchemyInterrogationResultItem]

The resulting similar sites of the image.

artists instance-attribute 

artists: list[AlchemyInterrogationResultItem]

The resulting similar artists of the image.

flavors instance-attribute 

flavors: list[AlchemyInterrogationResultItem]

The resulting similar flavors of the image.

mediums instance-attribute 

mediums: list[AlchemyInterrogationResultItem]

The resulting similar mediums of the image.

movements instance-attribute 

movements: list[AlchemyInterrogationResultItem]

The resulting similar movements of the image.

techniques instance-attribute 

techniques: list[AlchemyInterrogationResultItem]

The resulting similar techniques of the image.

AlchemyInterrogationResult

Bases: HordeAPIData

Represents the result of an interrogation job. Use the interrogation field for the details.

Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
70
71
72
73
74
class AlchemyInterrogationResult(HordeAPIData):
    """Represents the result of an interrogation job. Use the `interrogation` field for the details."""

    interrogation: AlchemyInterrogationDetails
    """The details of the interrogation."""

interrogation instance-attribute 

interrogation: AlchemyInterrogationDetails

The details of the interrogation.

AlchemyFormStatus

Bases: HordeAPIData

Represents the status of a form in an interrogation job.

Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
 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
class AlchemyFormStatus(HordeAPIData):
    """Represents the status of a form in an interrogation job."""

    form: KNOWN_ALCHEMY_TYPES | str
    """The form type."""
    state: GENERATION_STATE
    """The state of the form."""
    result: AlchemyInterrogationDetails | AlchemyNSFWResult | AlchemyCaptionResult | AlchemyUpscaleResult | None = None
    """The result of the form."""

    @field_validator("form", mode="before")
    def validate_form(cls, v: str | KNOWN_ALCHEMY_TYPES) -> KNOWN_ALCHEMY_TYPES | str:
        if isinstance(v, KNOWN_ALCHEMY_TYPES):
            return v
        if str(v) not in KNOWN_ALCHEMY_TYPES.__members__:
            logger.warning(f"Unknown form type {v}. Is your SDK out of date or did the API change?")
        return v

    @property
    def done(self) -> bool:
        """Return whether the form is done."""
        return self.state == "done"

    @field_validator("result", mode="before")
    def validate_result(
        cls,
        v: dict[str, object],
    ) -> dict[str, object] | None:
        if "additionalProp1" in v:
            logger.debug("Found additionalProp1 in result, this is a dummy result. Ignoring.")
            return None

        for key in list(v.keys()):
            if key in KNOWN_UPSCALERS.__members__:
                v["upscaler_used"] = KNOWN_UPSCALERS(key)
                v["url"] = v[key]
                del v[key]

        return v

form instance-attribute 

form: KNOWN_ALCHEMY_TYPES | str

The form type.

state instance-attribute 

state: GENERATION_STATE

The state of the form.

result class-attribute instance-attribute 

result: AlchemyInterrogationDetails | AlchemyNSFWResult | AlchemyCaptionResult | AlchemyUpscaleResult | None = None

The result of the form.

done property 

done: bool

Return whether the form is done.

validate_form 

validate_form(v: str | KNOWN_ALCHEMY_TYPES) -> KNOWN_ALCHEMY_TYPES | str
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
87
88
89
90
91
92
93
@field_validator("form", mode="before")
def validate_form(cls, v: str | KNOWN_ALCHEMY_TYPES) -> KNOWN_ALCHEMY_TYPES | str:
    if isinstance(v, KNOWN_ALCHEMY_TYPES):
        return v
    if str(v) not in KNOWN_ALCHEMY_TYPES.__members__:
        logger.warning(f"Unknown form type {v}. Is your SDK out of date or did the API change?")
    return v

validate_result 

validate_result(v: dict[str, object]) -> dict[str, object] | None
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
@field_validator("result", mode="before")
def validate_result(
    cls,
    v: dict[str, object],
) -> dict[str, object] | None:
    if "additionalProp1" in v:
        logger.debug("Found additionalProp1 in result, this is a dummy result. Ignoring.")
        return None

    for key in list(v.keys()):
        if key in KNOWN_UPSCALERS.__members__:
            v["upscaler_used"] = KNOWN_UPSCALERS(key)
            v["url"] = v[key]
            del v[key]

    return v

AlchemyStatusResponse

Bases: HordeResponseBaseModel, ResponseWithProgressMixin

The response from the /v2/interrogate/status/{id} endpoint.

You will find the results of the alchemy here.

v2 API Model: InterrogationStatus

Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
118
119
120
121
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
158
159
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
class AlchemyStatusResponse(HordeResponseBaseModel, ResponseWithProgressMixin):
    """The response from the `/v2/interrogate/status/{id}` endpoint.

    You will find the results of the alchemy here.

    v2 API Model: `InterrogationStatus`
    """

    state: GENERATION_STATE
    """The state of the job. See `GENERATION_STATE` for possible values."""
    forms: list[AlchemyFormStatus]
    """The status of each form in the job."""

    @property
    def all_interrogation_results(self) -> list[AlchemyInterrogationDetails]:
        """Return all completed interrogation results."""
        return [
            form.result for form in self.forms if form.done and isinstance(form.result, AlchemyInterrogationDetails)
        ]

    @property
    def all_nsfw_results(self) -> list[AlchemyNSFWResult]:
        """Return all completed nsfw results."""
        return [form.result for form in self.forms if form.done and isinstance(form.result, AlchemyNSFWResult)]

    @property
    def all_caption_results(self) -> list[AlchemyCaptionResult]:
        """Return all completed caption results."""
        return [form.result for form in self.forms if form.done and isinstance(form.result, AlchemyCaptionResult)]

    @property
    def all_upscale_results(self) -> list[AlchemyUpscaleResult]:
        """Return all completed upscale results."""
        return [form.result for form in self.forms if form.done and isinstance(form.result, AlchemyUpscaleResult)]

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

    @override
    def is_job_complete(self, number_of_result_expected: int) -> bool:
        found_results = 0
        if not self.forms:
            return False
        for form in self.forms:
            if form.state != "done":
                return False
            found_results += 1
        return found_results == number_of_result_expected

    @override
    def is_job_possible(self) -> bool:
        return True  # FIXME

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

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

    def __eq__(self, other: object) -> bool:
        if not isinstance(other, AlchemyStatusResponse):
            return False
        return self.state == other.state and all(form in other.forms for form in self.forms)

    def __hash__(self) -> int:
        return hash((self.state, tuple(self.forms)))

state instance-attribute 

state: GENERATION_STATE

The state of the job. See GENERATION_STATE for possible values.

forms instance-attribute 

forms: list[AlchemyFormStatus]

The status of each form in the job.

all_interrogation_results property 

all_interrogation_results: list[AlchemyInterrogationDetails]

Return all completed interrogation results.

all_nsfw_results property 

all_nsfw_results: list[AlchemyNSFWResult]

Return all completed nsfw results.

all_caption_results property 

all_caption_results: list[AlchemyCaptionResult]

Return all completed caption results.

all_upscale_results property 

all_upscale_results: list[AlchemyUpscaleResult]

Return all completed upscale results.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
153
154
155
@classmethod
def get_api_model_name(cls) -> str | None:
    return "InterrogationStatus"

is_job_complete 

is_job_complete(number_of_result_expected: int) -> bool
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
157
158
159
160
161
162
163
164
165
166
@override
def is_job_complete(self, number_of_result_expected: int) -> bool:
    found_results = 0
    if not self.forms:
        return False
    for form in self.forms:
        if form.state != "done":
            return False
        found_results += 1
    return found_results == number_of_result_expected

is_job_possible 

is_job_possible() -> bool
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
168
169
170
@override
def is_job_possible(self) -> bool:
    return True  # FIXME

is_final_follow_up classmethod 

is_final_follow_up() -> bool
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
172
173
174
175
@override
@classmethod
def is_final_follow_up(cls) -> bool:
    return True

get_finalize_success_request_type classmethod 

get_finalize_success_request_type() -> None
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
177
178
179
180
@override
@classmethod
def get_finalize_success_request_type(cls) -> None:
    return None

__eq__ 

__eq__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
182
183
184
185
def __eq__(self, other: object) -> bool:
    if not isinstance(other, AlchemyStatusResponse):
        return False
    return self.state == other.state and all(form in other.forms for form in self.forms)

__hash__ 

__hash__() -> int
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
187
188
def __hash__(self) -> int:
    return hash((self.state, tuple(self.forms)))

AlchemyStatusRequest

Bases: BaseAIHordeRequest, JobRequestMixin, APIKeyAllowedInRequestMixin

Represents the data needed to make a request to the /v2/interrogate/status/{id} endpoint.

Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
class AlchemyStatusRequest(
    BaseAIHordeRequest,
    JobRequestMixin,
    APIKeyAllowedInRequestMixin,
):
    """Represents the data needed to make a request to the `/v2/interrogate/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_interrogate_status

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

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
198
199
200
201
@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/alchemy/_status.py 
203
204
205
206
@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/alchemy/_status.py 
208
209
210
211
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_interrogate_status

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[AlchemyStatusResponse]
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
213
214
215
216
@override
@classmethod
def get_default_success_response_type(cls) -> type[AlchemyStatusResponse]:
    return AlchemyStatusResponse

AlchemyDeleteRequest

Bases: BaseAIHordeRequest, JobRequestMixin

Represents the data needed to make a request to the /v2/interrogate/status/{id} endpoint.

Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
class AlchemyDeleteRequest(
    BaseAIHordeRequest,
    JobRequestMixin,
):
    """Represents the data needed to make a request to the `/v2/interrogate/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_interrogate_status

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

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
225
226
227
228
@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/alchemy/_status.py 
230
231
232
233
@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/alchemy/_status.py 
235
236
237
238
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_interrogate_status

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[AlchemyStatusResponse]
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_status.py 
240
241
242
243
@override
@classmethod
def get_default_success_response_type(cls) -> type[AlchemyStatusResponse]:
    return AlchemyStatusResponse