Merge pull request #276 from Haidra-Org/main

fix: config default root models to allow new API fields
Haidra-Org · Nov 3, 2024 · dd4a5fe · dd4a5fe
2 parents eb20833 + bd64abe
commit dd4a5fe
Show file tree

Hide file tree

Showing 46 changed files with 798 additions and 30 deletions.
diff --git a/docs/horde_sdk/ai_horde_api/apimodels/_styles.md b/docs/horde_sdk/ai_horde_api/apimodels/_styles.md
@@ -0,0 +1,2 @@
+# _styles
+::: horde_sdk.ai_horde_api.apimodels._styles
diff --git a/docs/response_field_names_and_descriptions.json b/docs/response_field_names_and_descriptions.json
@@ -444,6 +444,13 @@
                 "int",
                 "None"
             ]
+        },
+        "styles": {
+            "description": "The styles this user has created.",
+            "types": [
+                "list[horde_sdk.ai_horde_api.apimodels._styles.ResponseModelStylesUser]",
+                "None"
+            ]
         }
     },
     "HordePerformanceResponse": {
@@ -726,6 +733,13 @@
                 "list[str]",
                 "None"
             ]
+        },
+        "ttl": {
+            "description": "The amount of seconds before this job is considered stale and aborted.",
+            "types": [
+                "int",
+                "None"
+            ]
         }
     },
     "JobSubmitResponse": {
@@ -1308,6 +1322,13 @@
                 "str",
                 "None"
             ]
+        },
+        "ttl": {
+            "description": "The amount of seconds before this job is considered stale and aborted.",
+            "types": [
+                "int",
+                "None"
+            ]
         }
     },
     "TextStatsModelResponse": {

diff --git a/horde_sdk/ai_horde_api/apimodels/__init__.py b/horde_sdk/ai_horde_api/apimodels/__init__.py
@@ -44,6 +44,7 @@
     NewsRequest,
     NewsResponse,
 )
+from horde_sdk.ai_horde_api.apimodels._styles import ResponseModelStylesUser
 from horde_sdk.ai_horde_api.apimodels._users import (
     ActiveGenerations,
     ContributionsDetails,
@@ -210,6 +211,7 @@
     "Newspiece",
     "NewsRequest",
     "NewsResponse",
+    "ResponseModelStylesUser",
     "ListUsersDetailsRequest",
     "ListUsersDetailsResponse",
     "ModifyUser",

diff --git a/horde_sdk/ai_horde_api/apimodels/_styles.py b/horde_sdk/ai_horde_api/apimodels/_styles.py
@@ -0,0 +1,19 @@
+from enum import auto
+
+from pydantic import Field
+from strenum import StrEnum
+
+from horde_sdk.generic_api.apimodels import HordeAPIDataObject
+
+
+class StyleType(StrEnum):
+    """An enum representing the different types of styles."""
+
+    image = auto()
+    text = auto()
+
+
+class ResponseModelStylesUser(HordeAPIDataObject):
+    name: str
+    id_: str = Field(alias="id")
+    type_: StyleType = Field(alias="type")
diff --git a/horde_sdk/ai_horde_api/apimodels/_users.py b/horde_sdk/ai_horde_api/apimodels/_users.py
@@ -3,6 +3,7 @@
 from pydantic import Field, RootModel
 from typing_extensions import override
 
+from horde_sdk.ai_horde_api.apimodels._styles import ResponseModelStylesUser
 from horde_sdk.ai_horde_api.apimodels.base import BaseAIHordeRequest
 from horde_sdk.ai_horde_api.endpoints import AI_HORDE_API_ENDPOINT_SUBPATH
 from horde_sdk.ai_horde_api.fields import UUID_Identifier
@@ -52,6 +53,9 @@ class UserKudosDetails(HordeAPIDataObject):
     recurring: float | None = Field(0)
     """The amount of Kudos this user has received from recurring rewards."""
 
+    styled: float | None = Field(0)
+    """The amount of Kudos this user has received from styling images."""
+
 
 class MonthlyKudos(HordeAPIDataObject):
     amount: int | None = Field(default=None)
@@ -85,6 +89,7 @@ class UserRecords(HordeAPIDataObject):
     fulfillment: UserAmountRecords | None = None
     request: UserAmountRecords | None = None
     usage: UserThingRecords | None = None
+    style: UserAmountRecords | None = None
 
 
 class UsageDetails(HordeAPIDataObject):
@@ -264,6 +269,9 @@ def get_api_model_name(cls) -> str | None:
     """Whether this user has been invited to join a worker to the horde and how many of them.
     When 0, this user cannot add (new) workers to the horde."""
 
+    styles: list[ResponseModelStylesUser] | None = None
+    """The styles this user has created."""
+
 
 @Unhashable
 @Unequatable

diff --git a/horde_sdk/ai_horde_api/apimodels/base.py b/horde_sdk/ai_horde_api/apimodels/base.py
@@ -199,7 +199,9 @@ class ImageGenerateParamMixin(HordeAPIDataObject):
     """
 
     model_config = (
-        ConfigDict(frozen=True) if not os.getenv("TESTS_ONGOING") else ConfigDict(frozen=True, extra="forbid")
+        ConfigDict(frozen=True, extra="allow")
+        if not os.getenv("TESTS_ONGOING")
+        else ConfigDict(frozen=True, extra="forbid")
     )
 
     sampler_name: KNOWN_SAMPLERS | str = KNOWN_SAMPLERS.k_lms

diff --git a/horde_sdk/ai_horde_api/apimodels/generate/_pop.py b/horde_sdk/ai_horde_api/apimodels/generate/_pop.py
@@ -232,6 +232,8 @@ class ImageGenerateJobPopResponse(
     """(Obsolete) The r2 upload link to use to upload this image."""
     r2_uploads: list[str] | None = None
     """The r2 upload links for each this image. Each index matches the ID in self.ids"""
+    ttl: int | None = None
+    """The amount of seconds before this job is considered stale and aborted."""
 
     @field_validator("source_processing")
     def source_processing_must_be_known(cls, v: str | KNOWN_SOURCE_PROCESSING) -> str | KNOWN_SOURCE_PROCESSING:

diff --git a/horde_sdk/ai_horde_api/apimodels/generate/text/_pop.py b/horde_sdk/ai_horde_api/apimodels/generate/text/_pop.py
@@ -60,6 +60,8 @@ class TextGenerateJobPopResponse(
     """The soft prompt requested for this generation."""
     model: str | None = Field(default=None)
     """The model requested for this generation."""
+    ttl: int | None = None
+    """The amount of seconds before this job is considered stale and aborted."""
 
     @field_validator("id_", mode="before")
     def validate_id(cls, v: str | JobID) -> JobID | str:

diff --git a/horde_sdk/generic_api/apimodels.py b/horde_sdk/generic_api/apimodels.py
@@ -58,6 +58,7 @@ class HordeAPIDataObject(BaseModel):
         ConfigDict(
             frozen=True,
             use_attribute_docstrings=True,
+            extra="allow",
         )
         if not os.getenv("TESTS_ONGOING")
         else ConfigDict(
@@ -98,7 +99,9 @@ class HordeResponseBaseModel(HordeResponse, BaseModel):
     """Base class for all Horde API response data models (leveraging pydantic)."""
 
     model_config = (
-        ConfigDict(frozen=True) if not os.getenv("TESTS_ONGOING") else ConfigDict(frozen=True, extra="forbid")
+        ConfigDict(frozen=True, extra="allow")
+        if not os.getenv("TESTS_ONGOING")
+        else ConfigDict(frozen=True, extra="forbid")
     )
 
 

diff --git a/horde_sdk/generic_api/utils/swagger.py b/horde_sdk/generic_api/utils/swagger.py
@@ -449,7 +449,12 @@ def get_endpoint_method_examples(
         # Iterate through each defined response for the HTTP method.
         for http_status_code_str, response_definition in endpoint_method_definition.responses.items():
             # Convert the HTTP status code string to an HTTPStatusCode object.
-            http_status_code_object = HTTPStatusCode(int(http_status_code_str))
+            try:
+                http_status_code_object = HTTPStatusCode(int(http_status_code_str))
+            except ValueError as e:
+                logger.error(f"Failed to convert {http_status_code_str} to an HTTPStatusCode object: {e}")
+                logger.error(f"response_definition: {response_definition}")
+                raise
 
             # Get the response example for this HTTP status code.
             example_response = self.get_response_example(response_definition)

diff --git a/tests/test_data/ai_horde_api/example_payloads/_v2_collections_collection_id_patch.json b/tests/test_data/ai_horde_api/example_payloads/_v2_collections_collection_id_patch.json
@@ -0,0 +1,8 @@
+{
+    "name": "My Awesome Collection",
+    "info": "Collection of optimistic styles",
+    "public": true,
+    "styles": [
+        "a"
+    ]
+}
diff --git a/tests/test_data/ai_horde_api/example_payloads/_v2_collections_post.json b/tests/test_data/ai_horde_api/example_payloads/_v2_collections_post.json
@@ -0,0 +1,8 @@
+{
+    "name": "My Awesome Collection",
+    "info": "Collection of optimistic styles",
+    "public": true,
+    "styles": [
+        "a"
+    ]
+}
diff --git a/tests/test_data/ai_horde_api/example_payloads/_v2_generate_async_post.json b/tests/test_data/ai_horde_api/example_payloads/_v2_generate_async_post.json
@@ -1,24 +1,19 @@
 {
     "prompt": "a",
     "params": {
-        "sampler_name": "dpmsolver",
+        "sampler_name": "k_euler",
         "cfg_scale": 7.5,
         "denoising_strength": 0.75,
         "hires_fix_denoising_strength": 0.75,
-        "seed": "The little seed that could",
         "height": 512,
         "width": 512,
-        "seed_variation": 1,
         "post_processing": [
             "GFPGAN"
         ],
         "karras": false,
         "tiling": false,
         "hires_fix": false,
         "clip_skip": 1,
-        "control_type": "canny",
-        "image_is_control": false,
-        "return_control_map": false,
         "facefixer_strength": 0.75,
         "loras": [
             {
@@ -41,14 +36,19 @@
             "additionalProp2": {},
             "additionalProp3": {}
         },
+        "workflow": "qr_code",
+        "transparent": false,
+        "seed": "The little seed that could",
+        "seed_variation": 1,
+        "control_type": "canny",
+        "image_is_control": false,
+        "return_control_map": false,
         "extra_texts": [
             {
                 "text": "a",
                 "reference": "aaa"
             }
         ],
-        "workflow": "qr_code",
-        "transparent": false,
         "steps": 30,
         "n": 1
     },
@@ -81,5 +81,6 @@
     "proxied_account": "",
     "disable_batching": false,
     "allow_downgrade": false,
-    "webhook": "https://haidra.net/00000000-0000-0000-0000-000000000000"
+    "webhook": "https://haidra.net/00000000-0000-0000-0000-000000000000",
+    "style": "00000000-0000-0000-0000-000000000000"
 }
diff --git a/tests/test_data/ai_horde_api/example_payloads/_v2_generate_text_async_post.json b/tests/test_data/ai_horde_api/example_payloads/_v2_generate_text_async_post.json
@@ -1,13 +1,10 @@
 {
     "prompt": "",
     "params": {
-        "n": 1,
         "frmtadsnsp": false,
         "frmtrmblln": false,
         "frmtrmspch": false,
         "frmttriminc": false,
-        "max_context_length": 1024,
-        "max_length": 80,
         "rep_pen": 1.0,
         "rep_pen_range": 0.0,
         "rep_pen_slope": 0.0,
@@ -28,7 +25,10 @@
         "min_p": 0.0,
         "smoothing_factor": 0.0,
         "dynatemp_range": 0.0,
-        "dynatemp_exponent": 1.0
+        "dynatemp_exponent": 1.0,
+        "n": 1,
+        "max_context_length": 1024,
+        "max_length": 80
     },
     "softprompt": "a",
     "trusted_workers": false,
@@ -52,5 +52,6 @@
     "disable_batching": false,
     "allow_downgrade": false,
     "webhook": "",
+    "style": "00000000-0000-0000-0000-000000000000",
     "extra_slow_workers": false
 }
diff --git a/tests/test_data/ai_horde_api/example_payloads/_v2_styles_image_post.json b/tests/test_data/ai_horde_api/example_payloads/_v2_styles_image_post.json
@@ -0,0 +1,53 @@
+{
+    "name": "My Awesome Image Style",
+    "info": "photorealism excellence.",
+    "prompt": "{p}{np}",
+    "params": {
+        "sampler_name": "k_euler",
+        "cfg_scale": 7.5,
+        "denoising_strength": 0.75,
+        "hires_fix_denoising_strength": 0.75,
+        "height": 512,
+        "width": 512,
+        "post_processing": [
+            "GFPGAN"
+        ],
+        "karras": false,
+        "tiling": false,
+        "hires_fix": false,
+        "clip_skip": 1,
+        "facefixer_strength": 0.75,
+        "loras": [
+            {
+                "name": "Magnagothica",
+                "model": 1.0,
+                "clip": 1.0,
+                "inject_trigger": "a",
+                "is_version": false
+            }
+        ],
+        "tis": [
+            {
+                "name": "7808",
+                "inject_ti": "prompt",
+                "strength": 1.0
+            }
+        ],
+        "special": {
+            "additionalProp1": {},
+            "additionalProp2": {},
+            "additionalProp3": {}
+        },
+        "workflow": "qr_code",
+        "transparent": false,
+        "steps": 30
+    },
+    "public": true,
+    "nsfw": false,
+    "tags": [
+        "photorealistic"
+    ],
+    "models": [
+        "stable_diffusion"
+    ]
+}
diff --git a/...ata/ai_horde_api/example_payloads/_v2_styles_image_style_id_example_example_id_patch.json b/...ata/ai_horde_api/example_payloads/_v2_styles_image_style_id_example_example_id_patch.json
@@ -0,0 +1,4 @@
+{
+    "url": "https://lemmy.dbzer0.com/pictrs/image/c9915186-ca30-4f5a-873c-a91287fb4419.webp",
+    "primary": false
+}
diff --git a/tests/test_data/ai_horde_api/example_payloads/_v2_styles_image_style_id_example_post.json b/tests/test_data/ai_horde_api/example_payloads/_v2_styles_image_style_id_example_post.json
@@ -0,0 +1,4 @@
+{
+    "url": "https://lemmy.dbzer0.com/pictrs/image/c9915186-ca30-4f5a-873c-a91287fb4419.webp",
+    "primary": false
+}