stackit-modelserving 0.0.1a0__py3-none-any.whl

stackit/modelserving/configuration.py

@@ -0,0 +1,138 @@
+# coding: utf-8
+
+"""
+    STACKIT Model Serving API
+
+    This API provides endpoints for the model serving api
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: model-serving@mail.schwarz
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+import os
+
+
+class HostConfiguration:
+    def __init__(
+        self,
+        region=None,
+        server_index=None,
+        server_variables=None,
+        server_operation_index=None,
+        server_operation_variables=None,
+        ignore_operation_servers=False,
+    ) -> None:
+        print(
+            "WARNING: STACKIT will move to a new way of specifying regions, where the region is provided\n",
+            "as a function argument instead of being set in the client configuration.\n"
+            "Once all services have migrated, the methods to specify the region in the client configuration "
+            "will be removed.",
+        )
+        """Constructor
+        """
+        self._base_path = "https://model-serving.api.stackit.cloud"
+        """Default Base url
+        """
+        self.server_index = 0 if server_index is None else server_index
+        self.server_operation_index = server_operation_index or {}
+        """Default server index
+        """
+        self.server_variables = server_variables or {}
+        if region:
+            self.server_variables["region"] = "{}.".format(region)
+        self.server_operation_variables = server_operation_variables or {}
+        """Default server variables
+        """
+        self.ignore_operation_servers = ignore_operation_servers
+        """Ignore operation servers
+        """
+
+    def get_host_settings(self):
+        """Gets an array of host settings
+
+        :return: An array of host settings
+        """
+        return [
+            {
+                "url": "https://model-serving.api.stackit.cloud",
+                "description": "No description provided",
+                "variables": {
+                    "region": {
+                        "description": "No description provided",
+                        "default_value": "global",
+                    }
+                },
+            }
+        ]
+
+    def get_host_from_settings(self, index, variables=None, servers=None):
+        """Gets host URL based on the index and variables
+        :param index: array index of the host settings
+        :param variables: hash of variable and the corresponding value
+        :param servers: an array of host settings or None
+        :error: if a region is given for a global url
+        :return: URL based on host settings
+        """
+        if index is None:
+            return self._base_path
+
+        variables = {} if variables is None else variables
+        servers = self.get_host_settings() if servers is None else servers
+
+        try:
+            server = servers[index]
+        except IndexError:
+            raise ValueError(
+                "Invalid index {0} when selecting the host settings. "
+                "Must be less than {1}".format(index, len(servers))
+            )
+
+        url = server["url"]
+
+        # check if environment variable was provided for region
+        # if nothing was set this is None
+        region_env = os.environ.get("STACKIT_REGION")
+
+        # go through variables and replace placeholders
+        for variable_name, variable in server.get("variables", {}).items():
+            # If a region is provided by the user for a global url
+            # return an error (except for providing via environment variable).
+            # The region is provided as a function argument instead of being set in the client configuration.
+            if (
+                variable_name == "region"
+                and (variable["default_value"] == "global" or variable["default_value"] == "")
+                and region_env is None
+                and variables.get(variable_name) is not None
+            ):
+                raise ValueError(
+                    "this API does not support setting a region in the the client configuration, "
+                    "please check if the region can be specified as a function parameter"
+                )
+            used_value = variables.get(variable_name, variable["default_value"])
+
+            if "enum_values" in variable and used_value not in variable["enum_values"]:
+                given_value = variables[variable_name].replace(".", "")
+                valid_values = [v.replace(".", "") for v in variable["enum_values"]]
+                raise ValueError(
+                    "The variable `{0}` in the host URL has invalid value '{1}'. Must be '{2}'.".format(
+                        variable_name, given_value, valid_values
+                    )
+                )
+
+            url = url.replace("{" + variable_name + "}", used_value)
+
+        return url
+
+    @property
+    def host(self):
+        """Return generated host."""
+        return self.get_host_from_settings(self.server_index, variables=self.server_variables)
+
+    @host.setter
+    def host(self, value):
+        """Fix base path."""
+        self._base_path = value
+        self.server_index = None

stackit/modelserving/exceptions.py

@@ -0,0 +1,199 @@
+# coding: utf-8
+
+"""
+    STACKIT Model Serving API
+
+    This API provides endpoints for the model serving api
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: model-serving@mail.schwarz
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from typing import Any, Optional
+
+from typing_extensions import Self
+
+
+class OpenApiException(Exception):
+    """The base exception class for all OpenAPIExceptions"""
+
+
+class ApiTypeError(OpenApiException, TypeError):
+    def __init__(self, msg, path_to_item=None, valid_classes=None, key_type=None) -> None:
+        """Raises an exception for TypeErrors
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list): a list of keys an indices to get to the
+                                 current_item
+                                 None if unset
+            valid_classes (tuple): the primitive classes that current item
+                                   should be an instance of
+                                   None if unset
+            key_type (bool): False if our value is a value in a dict
+                             True if it is a key in a dict
+                             False if our item is an item in a list
+                             None if unset
+        """
+        self.path_to_item = path_to_item
+        self.valid_classes = valid_classes
+        self.key_type = key_type
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiTypeError, self).__init__(full_msg)
+
+
+class ApiValueError(OpenApiException, ValueError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list) the path to the exception in the
+                received_data dict. None if unset
+        """
+
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiValueError, self).__init__(full_msg)
+
+
+class ApiAttributeError(OpenApiException, AttributeError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Raised when an attribute reference or assignment fails.
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiAttributeError, self).__init__(full_msg)
+
+
+class ApiKeyError(OpenApiException, KeyError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiKeyError, self).__init__(full_msg)
+
+
+class ApiException(OpenApiException):
+
+    def __init__(
+        self,
+        status=None,
+        reason=None,
+        http_resp=None,
+        *,
+        body: Optional[str] = None,
+        data: Optional[Any] = None,
+    ) -> None:
+        self.status = status
+        self.reason = reason
+        self.body = body
+        self.data = data
+        self.headers = None
+
+        if http_resp:
+            if self.status is None:
+                self.status = http_resp.status
+            if self.reason is None:
+                self.reason = http_resp.reason
+            if self.body is None:
+                try:
+                    self.body = http_resp.data.decode("utf-8")
+                except Exception:  # noqa: S110
+                    pass
+            self.headers = http_resp.getheaders()
+
+    @classmethod
+    def from_response(
+        cls,
+        *,
+        http_resp,
+        body: Optional[str],
+        data: Optional[Any],
+    ) -> Self:
+        if http_resp.status == 400:
+            raise BadRequestException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 401:
+            raise UnauthorizedException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 403:
+            raise ForbiddenException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 404:
+            raise NotFoundException(http_resp=http_resp, body=body, data=data)
+
+        if 500 <= http_resp.status <= 599:
+            raise ServiceException(http_resp=http_resp, body=body, data=data)
+        raise ApiException(http_resp=http_resp, body=body, data=data)
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        error_message = "({0})\n" "Reason: {1}\n".format(self.status, self.reason)
+        if self.headers:
+            error_message += "HTTP response headers: {0}\n".format(self.headers)
+
+        if self.data or self.body:
+            error_message += "HTTP response body: {0}\n".format(self.data or self.body)
+
+        return error_message
+
+
+class BadRequestException(ApiException):
+    pass
+
+
+class NotFoundException(ApiException):
+    pass
+
+
+class UnauthorizedException(ApiException):
+    pass
+
+
+class ForbiddenException(ApiException):
+    pass
+
+
+class ServiceException(ApiException):
+    pass
+
+
+def render_path(path_to_item):
+    """Returns a string representation of a path"""
+    result = ""
+    for pth in path_to_item:
+        if isinstance(pth, int):
+            result += "[{0}]".format(pth)
+        else:
+            result += "['{0}']".format(pth)
+    return result

stackit/modelserving/models/__init__.py

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    STACKIT Model Serving API
+
+    This API provides endpoints for the model serving api
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: model-serving@mail.schwarz
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+
+# import models into model package
+from stackit.modelserving.models.chat_model_details import ChatModelDetails
+from stackit.modelserving.models.create_token_payload import CreateTokenPayload
+from stackit.modelserving.models.create_token_response import CreateTokenResponse
+from stackit.modelserving.models.embedding_model_details import EmbeddingModelDetails
+from stackit.modelserving.models.error_message_response import ErrorMessageResponse
+from stackit.modelserving.models.get_chat_model_response import GetChatModelResponse
+from stackit.modelserving.models.get_embeddings_model_resp import GetEmbeddingsModelResp
+from stackit.modelserving.models.get_token_response import GetTokenResponse
+from stackit.modelserving.models.list_models_response import ListModelsResponse
+from stackit.modelserving.models.list_token_resp import ListTokenResp
+from stackit.modelserving.models.message_response import MessageResponse
+from stackit.modelserving.models.model import Model
+from stackit.modelserving.models.partial_update_token_payload import (
+    PartialUpdateTokenPayload,
+)
+from stackit.modelserving.models.sku import SKU
+from stackit.modelserving.models.token import Token
+from stackit.modelserving.models.token_created import TokenCreated
+from stackit.modelserving.models.update_token_response import UpdateTokenResponse

stackit/modelserving/models/chat_model_details.py

@@ -0,0 +1,189 @@
+# coding: utf-8
+
+"""
+    STACKIT Model Serving API
+
+    This API provides endpoints for the model serving api
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: model-serving@mail.schwarz
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+import re
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from typing_extensions import Annotated, Self
+
+from stackit.modelserving.models.sku import SKU
+
+
+class ChatModelDetails(BaseModel):
+    """
+    ChatModelDetails
+    """
+
+    bits: Optional[StrictInt] = None
+    category: StrictStr
+    context_length: StrictInt = Field(alias="contextLength")
+    description: Annotated[str, Field(strict=True, max_length=2000)]
+    displayed_name: Annotated[str, Field(min_length=1, strict=True, max_length=200)] = Field(alias="displayedName")
+    id: StrictStr = Field(description="generated uuid to identify a model")
+    name: Annotated[str, Field(min_length=1, strict=True, max_length=200)] = Field(description="huggingface name")
+    quantization_method: Optional[StrictStr] = Field(default=None, alias="quantizationMethod")
+    region: StrictStr
+    size: StrictInt = Field(description="model size in bytes")
+    skus: List[SKU]
+    tags: List[StrictStr]
+    url: Annotated[str, Field(min_length=1, strict=True, max_length=200)] = Field(description="url of the model")
+    __properties: ClassVar[List[str]] = [
+        "bits",
+        "category",
+        "contextLength",
+        "description",
+        "displayedName",
+        "id",
+        "name",
+        "quantizationMethod",
+        "region",
+        "size",
+        "skus",
+        "tags",
+        "url",
+    ]
+
+    @field_validator("bits")
+    def bits_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set([1, 2, 4, 8, 16]):
+            raise ValueError("must be one of enum values (1, 2, 4, 8, 16)")
+        return value
+
+    @field_validator("category")
+    def category_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["standard", "plus", "premium"]):
+            raise ValueError("must be one of enum values ('standard', 'plus', 'premium')")
+        return value
+
+    @field_validator("description")
+    def description_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[0-9a-zA-Z\s.:\/\-]+$", value):
+            raise ValueError(r"must validate the regular expression /^[0-9a-zA-Z\s.:\/\-]+$/")
+        return value
+
+    @field_validator("displayed_name")
+    def displayed_name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[0-9a-zA-Z\s_-]+$", value):
+            raise ValueError(r"must validate the regular expression /^[0-9a-zA-Z\s_-]+$/")
+        return value
+
+    @field_validator("name")
+    def name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[0-9a-zA-Z\s.:\/\-]+$", value):
+            raise ValueError(r"must validate the regular expression /^[0-9a-zA-Z\s.:\/\-]+$/")
+        return value
+
+    @field_validator("quantization_method")
+    def quantization_method_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(["PTQ", "QAT"]):
+            raise ValueError("must be one of enum values ('PTQ', 'QAT')")
+        return value
+
+    @field_validator("url")
+    def url_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[0-9a-zA-Z\s.:\/\-]+$", value):
+            raise ValueError(r"must validate the regular expression /^[0-9a-zA-Z\s.:\/\-]+$/")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ChatModelDetails from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in skus (list)
+        _items = []
+        if self.skus:
+            for _item in self.skus:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["skus"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ChatModelDetails from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "bits": obj.get("bits"),
+                "category": obj.get("category"),
+                "contextLength": obj.get("contextLength"),
+                "description": obj.get("description"),
+                "displayedName": obj.get("displayedName"),
+                "id": obj.get("id"),
+                "name": obj.get("name"),
+                "quantizationMethod": obj.get("quantizationMethod"),
+                "region": obj.get("region"),
+                "size": obj.get("size"),
+                "skus": [SKU.from_dict(_item) for _item in obj["skus"]] if obj.get("skus") is not None else None,
+                "tags": obj.get("tags"),
+                "url": obj.get("url"),
+            }
+        )
+        return _obj

stackit/modelserving/models/create_token_payload.py

@@ -0,0 +1,108 @@
+# coding: utf-8
+
+"""
+    STACKIT Model Serving API
+
+    This API provides endpoints for the model serving api
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: model-serving@mail.schwarz
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+import re
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing_extensions import Annotated, Self
+
+
+class CreateTokenPayload(BaseModel):
+    """
+    CreateTokenPayload
+    """
+
+    description: Optional[Annotated[str, Field(strict=True, max_length=2000)]] = None
+    name: Annotated[str, Field(min_length=1, strict=True, max_length=200)]
+    ttl_duration: Optional[StrictStr] = Field(
+        default=None,
+        description="time to live duration. Must be valid duration string. If not set the token will never expire.",
+        alias="ttlDuration",
+    )
+    __properties: ClassVar[List[str]] = ["description", "name", "ttlDuration"]
+
+    @field_validator("description")
+    def description_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[0-9a-zA-Z\s.:\/\-]+$", value):
+            raise ValueError(r"must validate the regular expression /^[0-9a-zA-Z\s.:\/\-]+$/")
+        return value
+
+    @field_validator("name")
+    def name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[0-9a-zA-Z\s_-]+$", value):
+            raise ValueError(r"must validate the regular expression /^[0-9a-zA-Z\s_-]+$/")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CreateTokenPayload from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateTokenPayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"description": obj.get("description"), "name": obj.get("name"), "ttlDuration": obj.get("ttlDuration")}
+        )
+        return _obj