horde_sdk.consts¶

class HTTPMethod(StrEnum):
    """An enum representing all HTTP methods."""

    GET = "GET"
    POST = "POST"
    PUT = "PUT"
    DELETE = "DELETE"
    PATCH = "PATCH"
    OPTIONS = "OPTIONS"
    HEAD = "HEAD"
    TRACE = "TRACE"
    CONNECT = "CONNECT"

class HTTPStatusCode(IntEnum):
    """An enum representing all HTTP status codes."""

    OK = 200
    CREATED = 201
    ACCEPTED = 202
    NO_CONTENT = 204

    BAD_REQUEST = 400
    UNAUTHORIZED = 401
    FORBIDDEN = 403
    NOT_FOUND = 404
    METHOD_NOT_ALLOWED = 405
    NOT_ACCEPTABLE = 406
    REQUEST_TIMEOUT = 408
    CONFLICT = 409
    GONE = 410
    UNPROCESSABLE_ENTITY = 422
    TOO_MANY_REQUESTS = 429

    INTERNAL_SERVER_ERROR = 500
    NOT_IMPLEMENTED = 501
    SERVICE_UNAVAILABLE = 503
    GATEWAY_TIMEOUT = 504

class KNOWN_DISPATCH_SOURCE(StrEnum):
    """The known sources of a dispatch."""

    UNKNOWN = auto()
    """The source of the dispatch is unknown."""

    LOCAL_CUSTOM_3RD_PARTY = auto()
    """The source of the dispatch is a local custom 3rd party API."""

    AI_HORDE_API_OFFICIAL = auto()
    """The source of the dispatch is the official AI Horde API."""

    AI_HORDE_API_FORK = auto()
    """The source of the dispatch is a fork of the official AI Horde API."""

class KNOWN_NSFW_DETECTOR(StrEnum):
    """The NSFW detectors that are known to the API."""

    BACKEND_DEFAULT = auto()
    """The default model for the worker backend."""

    HORDE_SAFETY = auto()
    """The AI-Horde horde_safety package."""

    COMPVIS_SAFETY_CHECKER = auto()
    """The compvis safety checker model released with stable diffusion."""

class WORKER_TYPE(StrEnum):
    """The worker types that are known.

    (alchemy, image, text, etc...)
    """

    image = auto()
    """Image generation worker."""
    text = auto()
    """Text generation worker."""
    interrogation = auto()
    """Alchemy/Interrogation worker."""
    alchemist = "interrogation"
    """Alchemy/Interrogation worker."""
    video = auto()
    """Video generation worker."""
    audio = auto()
    """Audio generation worker."""

class KNOWN_INFERENCE_BACKEND(StrEnum):
    """The known generative inference backends."""

    UNKNOWN = auto()
    """The inference backend is unknown."""

    IN_MODEL_NAME = auto()
    """The model name is prepended with the backend name."""

    CUSTOM_UNPUBLISHED = auto()
    """The inference backend is a custom, unpublished backend."""

    COMFYUI = auto()
    """The inference backend is ComfyUI."""

    A1111 = auto()
    """The inference backend is A1111."""

    HORDE_ALCHEMIST = auto()
    """The inference backend is the Horde Alchemist."""

    KOBOLD_CPP = auto()
    """The inference backend is Kobold CPP."""

    APHRODITE = auto()
    """The inference backend is Aphrodite."""

class KNOWN_ALCHEMY_BACKEND(StrEnum):
    """The known alchemy backends."""

    UNKNOWN = auto()
    """The alchemy backend is unknown."""

    CUSTOM_UNPUBLISHED = auto()
    """The alchemy backend is a custom, unpublished backend."""

    HORDE_ALCHEMIST = auto()
    """The alchemy backend is the Horde Alchemist."""

class KNOWN_SERVICE(StrEnum):
    """The known services that can be used for generation."""

    UNKNOWN = auto()
    """The service is unknown."""

    CUSTOM_UNPUBLISHED = auto()
    """The service is a custom, unpublished service."""

    AI_HORDE = auto()
    """The AI Horde service."""

    CIVITAI = auto()
    """The CivitAI service."""

class ServiceInfo(BaseModel):
    """Represents information about a service."""

    model_config = ConfigDict(
        use_attribute_docstrings=True,
    )

    known_identifier: KNOWN_SERVICE = KNOWN_SERVICE.UNKNOWN
    """The known identifier for the service, if any."""

    display_name: str = Field(..., min_length=1)
    """The name of the service."""

    description: str | None = None
    """A description of the service."""

    url: str | None = None
    """The URL of the service."""