Skip to content

_submit

ImageGenerationJobSubmitRequest

Bases: BaseAIHordeRequest, JobRequestMixin, APIKeyAllowedInRequestMixin

Represents the data needed to make a job submit 'request' from a worker to the /v2/generate/submit endpoint.

v2 API Model: SubmitInputStable

Source code in horde_sdk/ai_horde_api/apimodels/generate/_submit.py 
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
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
class ImageGenerationJobSubmitRequest(
    BaseAIHordeRequest,
    JobRequestMixin,
    APIKeyAllowedInRequestMixin,
):
    """Represents the data needed to make a job submit 'request' from a worker to the /v2/generate/submit endpoint.

    v2 API Model: `SubmitInputStable`
    """

    generation: str = ""
    """R2 result was uploaded to R2, else the string of the result."""
    state: GENERATION_STATE
    """The state of this generation."""
    seed: int = 0
    """The seed for this generation."""
    censored: bool = False
    """If True, this resulting image has been censored."""
    gen_metadata: list[GenMetadataEntry] | None = None
    """Extra metadata about faulted or defaulted components of the generation"""

    @model_validator(mode="after")
    def validate_generation(self) -> ImageGenerationJobSubmitRequest:
        if self.generation == "":
            logger.error("Generation cannot be an empty string.")
            logger.error(self.log_safe_model_dump())

        if self.seed == 0:
            logger.debug(f"Seed is 0 for {self.id_}. That might not be intended.")
            logger.debug(self.log_safe_model_dump())

        return self

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

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

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

generation class-attribute instance-attribute 

generation: str = ''

R2 result was uploaded to R2, else the string of the result.

state instance-attribute 

state: GENERATION_STATE

The state of this generation.

seed class-attribute instance-attribute 

seed: int = 0

The seed for this generation.

censored class-attribute instance-attribute 

censored: bool = False

If True, this resulting image has been censored.

gen_metadata class-attribute instance-attribute 

gen_metadata: list[GenMetadataEntry] | None = None

Extra metadata about faulted or defaulted components of the generation

validate_generation 

validate_generation() -> ImageGenerationJobSubmitRequest
Source code in horde_sdk/ai_horde_api/apimodels/generate/_submit.py 
40
41
42
43
44
45
46
47
48
49
50
@model_validator(mode="after")
def validate_generation(self) -> ImageGenerationJobSubmitRequest:
    if self.generation == "":
        logger.error("Generation cannot be an empty string.")
        logger.error(self.log_safe_model_dump())

    if self.seed == 0:
        logger.debug(f"Seed is 0 for {self.id_}. That might not be intended.")
        logger.debug(self.log_safe_model_dump())

    return self

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/generate/_submit.py 
52
53
54
55
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "SubmitInputStable"

get_http_method classmethod 

get_http_method() -> HTTPMethod
Source code in horde_sdk/ai_horde_api/apimodels/generate/_submit.py 
57
58
59
60
@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/generate/_submit.py 
62
63
64
65
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_generate_submit

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[JobSubmitResponse]
Source code in horde_sdk/ai_horde_api/apimodels/generate/_submit.py 
67
68
69
70
@override
@classmethod
def get_default_success_response_type(cls) -> type[JobSubmitResponse]:
    return JobSubmitResponse