Skip to content

_async

AlchemyAsyncResponse

Bases: HordeResponseBaseModel, JobResponseMixin, ResponseRequiringFollowUpMixin, ContainsMessageResponseMixin

Represents the data returned from the /v2/alchemy/async endpoint.

v2 API Model: RequestInterrogationResponse

Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_async.py 
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
class AlchemyAsyncResponse(
    HordeResponseBaseModel,
    JobResponseMixin,
    ResponseRequiringFollowUpMixin,
    ContainsMessageResponseMixin,
):
    """Represents the data returned from the `/v2/alchemy/async` endpoint.

    v2 API Model: `RequestInterrogationResponse`
    """

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

    @override
    def get_follow_up_returned_params(self, *, as_python_field_name: bool = False) -> list[dict[str, object]]:
        if as_python_field_name:
            return [{"id_": self.id_}]
        return [{AIHordePathData.id_: self.id_}]

    @override
    @classmethod
    def get_follow_up_default_request_type(cls) -> type[AlchemyStatusRequest]:
        return AlchemyStatusRequest

    @override
    @classmethod
    def get_follow_up_request_types(  # type: ignore[override]
        cls,
    ) -> list[type[AlchemyStatusRequest]]:
        return [AlchemyStatusRequest]

    @override
    @classmethod
    def get_follow_up_failure_cleanup_request_type(cls) -> type[AlchemyDeleteRequest]:
        return AlchemyDeleteRequest

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_async.py 
38
39
40
41
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "RequestInterrogationResponse"

get_follow_up_returned_params 

get_follow_up_returned_params(*, as_python_field_name: bool = False) -> list[dict[str, object]]
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_async.py 
43
44
45
46
47
@override
def get_follow_up_returned_params(self, *, as_python_field_name: bool = False) -> list[dict[str, object]]:
    if as_python_field_name:
        return [{"id_": self.id_}]
    return [{AIHordePathData.id_: self.id_}]

get_follow_up_default_request_type classmethod 

get_follow_up_default_request_type() -> type[AlchemyStatusRequest]
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_async.py 
49
50
51
52
@override
@classmethod
def get_follow_up_default_request_type(cls) -> type[AlchemyStatusRequest]:
    return AlchemyStatusRequest

get_follow_up_request_types classmethod 

get_follow_up_request_types() -> list[type[AlchemyStatusRequest]]
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_async.py 
54
55
56
57
58
59
@override
@classmethod
def get_follow_up_request_types(  # type: ignore[override]
    cls,
) -> list[type[AlchemyStatusRequest]]:
    return [AlchemyStatusRequest]

get_follow_up_failure_cleanup_request_type classmethod 

get_follow_up_failure_cleanup_request_type() -> type[AlchemyDeleteRequest]
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_async.py 
61
62
63
64
@override
@classmethod
def get_follow_up_failure_cleanup_request_type(cls) -> type[AlchemyDeleteRequest]:
    return AlchemyDeleteRequest

AlchemyAsyncRequestFormItem

Bases: HordeAPIData

Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_async.py 
67
68
69
70
71
72
73
74
75
76
77
class AlchemyAsyncRequestFormItem(HordeAPIData):
    name: KNOWN_ALCHEMY_TYPES | str
    """The name of the form to request."""

    @field_validator("name")
    def check_name(cls, v: KNOWN_ALCHEMY_TYPES | str) -> 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 alchemy form name {v}. Is your SDK out of date or did the API change?")
        return v

name instance-attribute 

name: KNOWN_ALCHEMY_TYPES | str

The name of the form to request.

check_name 

check_name(v: KNOWN_ALCHEMY_TYPES | str) -> KNOWN_ALCHEMY_TYPES | str
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_async.py 
71
72
73
74
75
76
77
@field_validator("name")
def check_name(cls, v: KNOWN_ALCHEMY_TYPES | str) -> 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 alchemy form name {v}. Is your SDK out of date or did the API change?")
    return v

AlchemyAsyncRequest

Bases: BaseAIHordeRequest, APIKeyAllowedInRequestMixin

Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_async.py 
 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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
class AlchemyAsyncRequest(
    BaseAIHordeRequest,
    APIKeyAllowedInRequestMixin,
):
    forms: list[AlchemyAsyncRequestFormItem]
    """The list of forms (types of post-processing/interrogation/captioning/etc) to request."""
    source_image: str
    """The public URL of the source image or a base64 string to use."""
    slow_workers: bool = True
    """Whether to use the slower workers. Costs additional kudos if `False`."""
    extra_slow_workers: bool = False
    """Whether to use the super slow workers."""

    @field_validator("forms")
    def check_at_least_one_form(cls, v: list[AlchemyAsyncRequestFormItem]) -> list[AlchemyAsyncRequestFormItem]:
        if not v:
            raise ValueError("At least one form must be provided.")
        return v

    @field_validator("source_image")
    def check_source_image(cls, v: str) -> str:
        if "http" in v:
            parsed_url = urllib.parse.urlparse(v)
            if parsed_url.scheme not in ["http", "https"]:
                raise ValueError("Source image must be a public URL.")
        else:
            try:
                base64.b64decode(v)
            except Exception as e:
                raise ValueError("Source image must be a base64 string.") from e

        return v

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

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

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

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

    @override
    @classmethod
    def get_success_status_response_pairs(cls) -> dict[HTTPStatusCode, type[HordeResponseTypes]]:
        return {
            HTTPStatusCode.ACCEPTED: cls.get_default_success_response_type(),
        }

    @override
    def get_number_of_results_expected(self) -> int:
        return len(self.forms)

    @override
    def get_extra_fields_to_exclude_from_log(self) -> set[str]:
        return {"source_image"}

forms instance-attribute 

forms: list[AlchemyAsyncRequestFormItem]

The list of forms (types of post-processing/interrogation/captioning/etc) to request.

source_image instance-attribute 

source_image: str

The public URL of the source image or a base64 string to use.

slow_workers class-attribute instance-attribute 

slow_workers: bool = True

Whether to use the slower workers. Costs additional kudos if False.

extra_slow_workers class-attribute instance-attribute 

extra_slow_workers: bool = False

Whether to use the super slow workers.

check_at_least_one_form 

check_at_least_one_form(v: list[AlchemyAsyncRequestFormItem]) -> list[AlchemyAsyncRequestFormItem]
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_async.py 
93
94
95
96
97
@field_validator("forms")
def check_at_least_one_form(cls, v: list[AlchemyAsyncRequestFormItem]) -> list[AlchemyAsyncRequestFormItem]:
    if not v:
        raise ValueError("At least one form must be provided.")
    return v

check_source_image 

check_source_image(v: str) -> str
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_async.py 
 99
100
101
102
103
104
105
106
107
108
109
110
111
@field_validator("source_image")
def check_source_image(cls, v: str) -> str:
    if "http" in v:
        parsed_url = urllib.parse.urlparse(v)
        if parsed_url.scheme not in ["http", "https"]:
            raise ValueError("Source image must be a public URL.")
    else:
        try:
            base64.b64decode(v)
        except Exception as e:
            raise ValueError("Source image must be a base64 string.") from e

    return v

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_async.py 
113
114
115
116
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "ModelInterrogationInputStable"

get_http_method classmethod 

get_http_method() -> HTTPMethod
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_async.py 
118
119
120
121
@override
@classmethod
def get_http_method(cls) -> HTTPMethod:
    return HTTPMethod.POST

get_api_endpoint_subpath classmethod 

get_api_endpoint_subpath() -> AI_HORDE_API_ENDPOINT_SUBPATH
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_async.py 
123
124
125
126
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_interrogate_async

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[AlchemyAsyncResponse]
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_async.py 
128
129
130
131
@override
@classmethod
def get_default_success_response_type(cls) -> type[AlchemyAsyncResponse]:
    return AlchemyAsyncResponse

get_success_status_response_pairs classmethod 

get_success_status_response_pairs() -> dict[HTTPStatusCode, type[HordeResponseTypes]]
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_async.py 
133
134
135
136
137
138
@override
@classmethod
def get_success_status_response_pairs(cls) -> dict[HTTPStatusCode, type[HordeResponseTypes]]:
    return {
        HTTPStatusCode.ACCEPTED: cls.get_default_success_response_type(),
    }

get_number_of_results_expected 

get_number_of_results_expected() -> int
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_async.py 
140
141
142
@override
def get_number_of_results_expected(self) -> int:
    return len(self.forms)

get_extra_fields_to_exclude_from_log 

get_extra_fields_to_exclude_from_log() -> set[str]
Source code in horde_sdk/ai_horde_api/apimodels/alchemy/_async.py 
144
145
146
@override
def get_extra_fields_to_exclude_from_log(self) -> set[str]:
    return {"source_image"}