Skip to content

rate

AestheticRating

Bases: HordeAPIObjectBaseModel

Represents an aesthetic rating for an image.

v2 API Model: AestheticRating

Source code in horde_sdk/ai_horde_api/apimodels/generate/rate.py 
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
class AestheticRating(HordeAPIObjectBaseModel):
    """Represents an aesthetic rating for an image.

    v2 API Model: `AestheticRating`
    """

    id_: str = Field(
        alias="id",
        description="The UUID of image being rated.",
    )
    """The UUID of image being rated."""

    rating: int
    """The aesthetic rating 1-10 for this image."""

    artifacts: int
    """The artifacts rating for this image.
    0 for flawless generation that perfectly fits to the prompt.
    1 for small, hardly recognizable flaws. 2 small flaws that can easily be spotted, but don not harm the aesthetic
    experience.
    3 for flaws that look obviously wrong, but only mildly harm the aesthetic experience.
    4 for flaws that look obviously wrong & significantly harm the aesthetic experience.
    5 for flaws that make the image look like total garbage."""

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

id_ class-attribute instance-attribute 

id_: str = Field(
    alias="id", description="The UUID of image being rated."
)

The UUID of image being rated.

rating instance-attribute 

rating: int

The aesthetic rating 1-10 for this image.

artifacts instance-attribute 

artifacts: int

The artifacts rating for this image. 0 for flawless generation that perfectly fits to the prompt. 1 for small, hardly recognizable flaws. 2 small flaws that can easily be spotted, but don not harm the aesthetic experience. 3 for flaws that look obviously wrong, but only mildly harm the aesthetic experience. 4 for flaws that look obviously wrong & significantly harm the aesthetic experience. 5 for flaws that make the image look like total garbage.

model_config class-attribute instance-attribute 

model_config = get_default_frozen_model_config_dict()

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/generate/rate.py 
39
40
41
42
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "AestheticRating"

get_sensitive_fields classmethod 

get_sensitive_fields() -> set[str]

Return a set of fields which should be redacted from logs.

Source code in horde_sdk/generic_api/apimodels.py 
53
54
55
56
@classmethod
def get_sensitive_fields(cls) -> set[str]:
    """Return a set of fields which should be redacted from logs."""
    return {"apikey"}

get_extra_fields_to_exclude_from_log 

get_extra_fields_to_exclude_from_log() -> set[str]

Return an additional set of fields to exclude from the log_safe_model_dump method.

Source code in horde_sdk/generic_api/apimodels.py 
58
59
60
def get_extra_fields_to_exclude_from_log(self) -> set[str]:
    """Return an additional set of fields to exclude from the log_safe_model_dump method."""
    return set()

log_safe_model_dump 

log_safe_model_dump(
    extra_exclude: set[str] | None = None,
) -> dict[Any, Any]

Return a dict of the model's fields, with any sensitive fields redacted.

Source code in horde_sdk/generic_api/apimodels.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def log_safe_model_dump(self, extra_exclude: set[str] | None = None) -> dict[Any, Any]:
    """Return a dict of the model's fields, with any sensitive fields redacted."""
    if extra_exclude is None:
        extra_exclude = set()

    if hasattr(self, "model_dump"):
        return self.model_dump(  # type: ignore
            exclude=self.get_sensitive_fields() | self.get_extra_fields_to_exclude_from_log() | extra_exclude,
        )

    logger.warning("Model does not have a model_dump method. Using python native class compatible method.")
    logger.debug(
        "Generally this should not be relied upon. If you're seeing this and you're a developer for the SDK, "
        "consider using pydantic models instead.",
    )
    # Its not a pydantic model, use python native class compatible method
    return {
        key: getattr(self, key)
        for key in self.__dict__
        if key not in self.get_sensitive_fields() | self.get_extra_fields_to_exclude_from_log() | extra_exclude
    }

AestheticsPayload

Bases: HordeAPIObjectBaseModel

Represents the payload for rating images.

v2 API Model: AestheticsPayload

Source code in horde_sdk/ai_horde_api/apimodels/generate/rate.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
class AestheticsPayload(HordeAPIObjectBaseModel):
    """Represents the payload for rating images.

    v2 API Model: `AestheticsPayload`
    """

    best: str | None = None
    """The UUID of the best image in this generation batch (only used when 2+ images generated).
    If 2+ aesthetic ratings are also provided, then they take precedence if they're not tied."""

    ratings: list[AestheticRating]
    """The aesthetic ratings for each image in the batch."""

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

best class-attribute instance-attribute 

best: str | None = None

The UUID of the best image in this generation batch (only used when 2+ images generated). If 2+ aesthetic ratings are also provided, then they take precedence if they're not tied.

ratings instance-attribute 

ratings: list[AestheticRating]

The aesthetic ratings for each image in the batch.

model_config class-attribute instance-attribute 

model_config = get_default_frozen_model_config_dict()

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/generate/rate.py 
58
59
60
61
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "AestheticsPayload"

get_sensitive_fields classmethod 

get_sensitive_fields() -> set[str]

Return a set of fields which should be redacted from logs.

Source code in horde_sdk/generic_api/apimodels.py 
53
54
55
56
@classmethod
def get_sensitive_fields(cls) -> set[str]:
    """Return a set of fields which should be redacted from logs."""
    return {"apikey"}

get_extra_fields_to_exclude_from_log 

get_extra_fields_to_exclude_from_log() -> set[str]

Return an additional set of fields to exclude from the log_safe_model_dump method.

Source code in horde_sdk/generic_api/apimodels.py 
58
59
60
def get_extra_fields_to_exclude_from_log(self) -> set[str]:
    """Return an additional set of fields to exclude from the log_safe_model_dump method."""
    return set()

log_safe_model_dump 

log_safe_model_dump(
    extra_exclude: set[str] | None = None,
) -> dict[Any, Any]

Return a dict of the model's fields, with any sensitive fields redacted.

Source code in horde_sdk/generic_api/apimodels.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def log_safe_model_dump(self, extra_exclude: set[str] | None = None) -> dict[Any, Any]:
    """Return a dict of the model's fields, with any sensitive fields redacted."""
    if extra_exclude is None:
        extra_exclude = set()

    if hasattr(self, "model_dump"):
        return self.model_dump(  # type: ignore
            exclude=self.get_sensitive_fields() | self.get_extra_fields_to_exclude_from_log() | extra_exclude,
        )

    logger.warning("Model does not have a model_dump method. Using python native class compatible method.")
    logger.debug(
        "Generally this should not be relied upon. If you're seeing this and you're a developer for the SDK, "
        "consider using pydantic models instead.",
    )
    # Its not a pydantic model, use python native class compatible method
    return {
        key: getattr(self, key)
        for key in self.__dict__
        if key not in self.get_sensitive_fields() | self.get_extra_fields_to_exclude_from_log() | extra_exclude
    }

RateResponse

Bases: HordeResponseBaseModel

The response to a rating submission, including the reward amount.

Represents the data returned from the /v2/generate/rate/{id} endpoint with http status code 200.

v2 API Model: GenerationSubmitted

Source code in horde_sdk/ai_horde_api/apimodels/generate/rate.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
class RateResponse(HordeResponseBaseModel):
    """The response to a rating submission, including the reward amount.

    Represents the data returned from the /v2/generate/rate/{id} endpoint with http status code 200.

    v2 API Model: `GenerationSubmitted`
    """

    reward: float
    """The reward for the rating."""

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

reward instance-attribute 

reward: float

The reward for the rating.

time_constructed property 

time_constructed: float

The time the model was constructed (in epoch time).

model_config class-attribute instance-attribute 

model_config = get_default_frozen_model_config_dict()

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/generate/rate.py 
75
76
77
78
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "GenerationSubmitted"

get_sensitive_fields classmethod 

get_sensitive_fields() -> set[str]

Return a set of fields which should be redacted from logs.

Source code in horde_sdk/generic_api/apimodels.py 
53
54
55
56
@classmethod
def get_sensitive_fields(cls) -> set[str]:
    """Return a set of fields which should be redacted from logs."""
    return {"apikey"}

get_extra_fields_to_exclude_from_log 

get_extra_fields_to_exclude_from_log() -> set[str]

Return an additional set of fields to exclude from the log_safe_model_dump method.

Source code in horde_sdk/generic_api/apimodels.py 
58
59
60
def get_extra_fields_to_exclude_from_log(self) -> set[str]:
    """Return an additional set of fields to exclude from the log_safe_model_dump method."""
    return set()

log_safe_model_dump 

log_safe_model_dump(
    extra_exclude: set[str] | None = None,
) -> dict[Any, Any]

Return a dict of the model's fields, with any sensitive fields redacted.

Source code in horde_sdk/generic_api/apimodels.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def log_safe_model_dump(self, extra_exclude: set[str] | None = None) -> dict[Any, Any]:
    """Return a dict of the model's fields, with any sensitive fields redacted."""
    if extra_exclude is None:
        extra_exclude = set()

    if hasattr(self, "model_dump"):
        return self.model_dump(  # type: ignore
            exclude=self.get_sensitive_fields() | self.get_extra_fields_to_exclude_from_log() | extra_exclude,
        )

    logger.warning("Model does not have a model_dump method. Using python native class compatible method.")
    logger.debug(
        "Generally this should not be relied upon. If you're seeing this and you're a developer for the SDK, "
        "consider using pydantic models instead.",
    )
    # Its not a pydantic model, use python native class compatible method
    return {
        key: getattr(self, key)
        for key in self.__dict__
        if key not in self.get_sensitive_fields() | self.get_extra_fields_to_exclude_from_log() | extra_exclude
    }

RateRequest

Bases: AestheticsPayload, BaseAIHordeRequest

Submit ratings for a batch of images.

Represents a POST request to the /v2/generate/rate/{id} endpoint.

v2 API Model: AestheticsPayload

Source code in horde_sdk/ai_horde_api/apimodels/generate/rate.py 
 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
@Unhashable
@Unequatable
class RateRequest(AestheticsPayload, BaseAIHordeRequest):
    """Submit ratings for a batch of images.

    Represents a POST request to the /v2/generate/rate/{id} endpoint.

    v2 API Model: `AestheticsPayload`
    """

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

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

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

model_config class-attribute instance-attribute 

model_config = get_default_frozen_model_config_dict()

accept class-attribute instance-attribute 

accept: GenericAcceptTypes = json

The 'accept' header field.

client_agent class-attribute instance-attribute 

client_agent: str = Field(
    default=default_bridge_agent_string,
    alias="Client-Agent",
)

The requesting client's agent. You should set this to reflect the name, version and contact information for your client.

best class-attribute instance-attribute 

best: str | None = None

The UUID of the best image in this generation batch (only used when 2+ images generated). If 2+ aesthetic ratings are also provided, then they take precedence if they're not tied.

ratings instance-attribute 

ratings: list[AestheticRating]

The aesthetic ratings for each image in the batch.

get_api_model_name classmethod 

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

get_http_method classmethod 

get_http_method() -> HTTPMethod
Source code in horde_sdk/ai_horde_api/apimodels/generate/rate.py 
96
97
98
99
@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/rate.py 
101
102
103
104
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_generate_rate_id

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[RateResponse]
Source code in horde_sdk/ai_horde_api/apimodels/generate/rate.py 
106
107
108
109
@override
@classmethod
def get_default_success_response_type(cls) -> type[RateResponse]:
    return RateResponse

get_sensitive_fields classmethod 

get_sensitive_fields() -> set[str]
Source code in horde_sdk/generic_api/apimodels.py 
477
478
479
480
@override
@classmethod
def get_sensitive_fields(cls) -> set[str]:
    return {"apikey"}

get_extra_fields_to_exclude_from_log 

get_extra_fields_to_exclude_from_log() -> set[str]

Return an additional set of fields to exclude from the log_safe_model_dump method.

Source code in horde_sdk/generic_api/apimodels.py 
58
59
60
def get_extra_fields_to_exclude_from_log(self) -> set[str]:
    """Return an additional set of fields to exclude from the log_safe_model_dump method."""
    return set()

log_safe_model_dump 

log_safe_model_dump(
    extra_exclude: set[str] | None = None,
) -> dict[Any, Any]

Return a dict of the model's fields, with any sensitive fields redacted.

Source code in horde_sdk/generic_api/apimodels.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def log_safe_model_dump(self, extra_exclude: set[str] | None = None) -> dict[Any, Any]:
    """Return a dict of the model's fields, with any sensitive fields redacted."""
    if extra_exclude is None:
        extra_exclude = set()

    if hasattr(self, "model_dump"):
        return self.model_dump(  # type: ignore
            exclude=self.get_sensitive_fields() | self.get_extra_fields_to_exclude_from_log() | extra_exclude,
        )

    logger.warning("Model does not have a model_dump method. Using python native class compatible method.")
    logger.debug(
        "Generally this should not be relied upon. If you're seeing this and you're a developer for the SDK, "
        "consider using pydantic models instead.",
    )
    # Its not a pydantic model, use python native class compatible method
    return {
        key: getattr(self, key)
        for key in self.__dict__
        if key not in self.get_sensitive_fields() | self.get_extra_fields_to_exclude_from_log() | extra_exclude
    }

get_api_endpoint_url classmethod 

get_api_endpoint_url() -> str

Return the endpoint URL, including the path to the specific API action defined by this object.

Source code in horde_sdk/generic_api/apimodels.py 
407
408
409
410
@classmethod
def get_api_endpoint_url(cls) -> str:
    """Return the endpoint URL, including the path to the specific API action defined by this object."""
    return url_with_path(base_url=cls.get_api_url(), path=cls.get_api_endpoint_subpath())

get_api_url classmethod 

get_api_url() -> str
Source code in horde_sdk/ai_horde_api/apimodels/base.py 
44
45
46
47
@override
@classmethod
def get_api_url(cls) -> str:
    return AI_HORDE_BASE_URL

get_success_status_response_pairs classmethod 

get_success_status_response_pairs() -> (
    dict[HTTPStatusCode, type[HordeResponseTypes]]
)

Return a dict of HTTP status codes and the expected HordeResponse.

Defaults to {HTTPStatusCode.OK: cls.get_expected_response_type()}, but may be overridden to support other status codes.

Source code in horde_sdk/generic_api/apimodels.py 
427
428
429
430
431
432
433
434
435
436
@classmethod
def get_success_status_response_pairs(
    cls,
) -> dict[HTTPStatusCode, type[HordeResponseTypes]]:
    """Return a dict of HTTP status codes and the expected `HordeResponse`.

    Defaults to `{HTTPStatusCode.OK: cls.get_expected_response_type()}`, but may be overridden to support other
    status codes.
    """
    return {HTTPStatusCode.OK: cls.get_default_success_response_type()}

get_header_fields classmethod 

get_header_fields() -> list[str]

Return a list of field names from this request object that should be sent as header fields.

This is in addition to GenericHeaderFields's values, and possibly the API specific class which inherits from GenericHeaderFields, typically found in the horde_sdk.<api_name>_api.metadata module.

Source code in horde_sdk/generic_api/apimodels.py 
438
439
440
441
442
443
444
445
@classmethod
def get_header_fields(cls) -> list[str]:
    """Return a list of field names from this request object that should be sent as header fields.

    This is in addition to `GenericHeaderFields`'s values, and possibly the API specific class
    which inherits from `GenericHeaderFields`, typically found in the `horde_sdk.<api_name>_api.metadata` module.
    """
    return []

get_query_fields classmethod 

get_query_fields() -> list[str]

Return a list of field names from this request object that should be sent as query parameters.

This is in addition to GenericQueryFields's values, and possibly the API specific class which inherits from GenericQueryFields, typically found in the horde_sdk.<api_name>_api.metadata module.

Source code in horde_sdk/generic_api/apimodels.py 
447
448
449
450
451
452
453
454
@classmethod
def get_query_fields(cls) -> list[str]:
    """Return a list of field names from this request object that should be sent as query parameters.

    This is in addition to `GenericQueryFields`'s values, and possibly the API specific class
    which inherits from `GenericQueryFields`, typically found in the `horde_sdk.<api_name>_api.metadata` module.
    """
    return []

get_number_of_results_expected 

get_number_of_results_expected() -> int

Return the number of (job) results expected from this request.

Defaults to 1, but may be overridden to dynamically change the number of results expected.

This is factored into context management; if the number of results expected is not met, the job is considered unhandled on an exception and followed up on to attempt to close it.

Source code in horde_sdk/generic_api/apimodels.py 
456
457
458
459
460
461
462
463
464
def get_number_of_results_expected(self) -> int:
    """Return the number of (job) results expected from this request.

    Defaults to `1`, but may be overridden to dynamically change the number of results expected.

    This is factored into context management; if the number of results expected is not met, the job is considered
    unhandled on an exception and followed up on to attempt to close it.
    """
    return 1

get_requires_follow_up 

get_requires_follow_up() -> bool

Return whether this request requires a follow up request(s).

Returns:

  • bool ( bool ) –

    Whether this request requires a follow up request to close the job on the server.

Source code in horde_sdk/generic_api/apimodels.py 
466
467
468
469
470
471
472
473
474
475
def get_requires_follow_up(self) -> bool:
    """Return whether this request requires a follow up request(s).

    Returns:
        bool: Whether this request requires a follow up request to close the job on the server.
    """
    for response_type in self.get_success_status_response_pairs().values():
        if issubclass(response_type, ResponseRequiringFollowUpMixin):
            return True
    return False