Skip to content

_check

ImageGenerateCheckResponse

Bases: HordeResponseBaseModel, ResponseWithProgressMixin, ResponseGenerationProgressInfoMixin

Represents the data returned from the /v2/generate/check/{id} endpoint.

v2 API Model: RequestStatusCheck

Source code in horde_sdk/ai_horde_api/apimodels/generate/_check.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class ImageGenerateCheckResponse(
    HordeResponseBaseModel,
    ResponseWithProgressMixin,
    ResponseGenerationProgressInfoMixin,
):
    """Represents the data returned from the `/v2/generate/check/{id}` endpoint.

    v2 API Model: `RequestStatusCheck`
    """

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

    @override
    def is_job_complete(self, number_of_result_expected: int) -> bool:
        if self.done and self.finished != number_of_result_expected:
            logger.error(
                "There is a mismatch between the number of results expected and the number of results "
                "finished. This should not happen - tell the developers about this error.",
            )
        return self.done

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

    @override
    @classmethod
    def get_finalize_success_request_type(cls) -> type[ImageGenerateStatusRequest]:
        return ImageGenerateStatusRequest

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/generate/_check.py 
22
23
24
25
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "RequestStatusCheck"

is_job_complete 

is_job_complete(number_of_result_expected: int) -> bool
Source code in horde_sdk/ai_horde_api/apimodels/generate/_check.py 
27
28
29
30
31
32
33
34
@override
def is_job_complete(self, number_of_result_expected: int) -> bool:
    if self.done and self.finished != number_of_result_expected:
        logger.error(
            "There is a mismatch between the number of results expected and the number of results "
            "finished. This should not happen - tell the developers about this error.",
        )
    return self.done

is_job_possible 

is_job_possible() -> bool
Source code in horde_sdk/ai_horde_api/apimodels/generate/_check.py 
36
37
38
@override
def is_job_possible(self) -> bool:
    return self.is_possible

get_finalize_success_request_type classmethod 

get_finalize_success_request_type() -> type[ImageGenerateStatusRequest]
Source code in horde_sdk/ai_horde_api/apimodels/generate/_check.py 
40
41
42
43
@override
@classmethod
def get_finalize_success_request_type(cls) -> type[ImageGenerateStatusRequest]:
    return ImageGenerateStatusRequest

ImageGenerateCheckRequest

Bases: BaseAIHordeRequest, JobRequestMixin

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

Source code in horde_sdk/ai_horde_api/apimodels/generate/_check.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
class ImageGenerateCheckRequest(BaseAIHordeRequest, JobRequestMixin):
    """Represents a GET request to the `/v2/generate/check/{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_check

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

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/generate/_check.py 
49
50
51
52
@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/_check.py 
54
55
56
57
@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/_check.py 
59
60
61
62
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_generate_check

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[ImageGenerateCheckResponse]
Source code in horde_sdk/ai_horde_api/apimodels/generate/_check.py 
64
65
66
67
@override
@classmethod
def get_default_success_response_type(cls) -> type[ImageGenerateCheckResponse]:
    return ImageGenerateCheckResponse