hiddenlayer-sdk 0.1.1__py3-none-any.whl → 1.0.0__py3-none-any.whl

hiddenlayer/sdk/rest/models/web_request.py

@@ -0,0 +1,112 @@
+# coding: utf-8
+
+"""
+    HiddenLayer ModelScan V2
+
+    HiddenLayer ModelScan API for scanning of models
+
+    The version of the OpenAPI document: 1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from hiddenlayer.sdk.rest.models.artifact_content import ArtifactContent
+from hiddenlayer.sdk.rest.models.property_bag import PropertyBag
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WebRequest(BaseModel):
+    """
+    Describes an HTTP request.
+    """ # noqa: E501
+    index: Optional[Annotated[int, Field(strict=True, ge=-1)]] = Field(default=-1, description="The index within the run.webRequests array of the request object associated with this result.")
+    protocol: Optional[StrictStr] = Field(default=None, description="The request protocol. Example: 'http'.")
+    version: Optional[StrictStr] = Field(default=None, description="The request version. Example: '1.1'.")
+    target: Optional[StrictStr] = Field(default=None, description="The target of the request.")
+    method: Optional[StrictStr] = Field(default=None, description="The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.")
+    headers: Optional[Dict[str, StrictStr]] = Field(default=None, description="The request headers.")
+    parameters: Optional[Dict[str, StrictStr]] = Field(default=None, description="The request parameters.")
+    body: Optional[ArtifactContent] = None
+    properties: Optional[PropertyBag] = None
+    __properties: ClassVar[List[str]] = ["index", "protocol", "version", "target", "method", "headers", "parameters", "body", "properties"]
+
+    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 WebRequest 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 body
+        if self.body:
+            _dict['body'] = self.body.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of properties
+        if self.properties:
+            _dict['properties'] = self.properties.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WebRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "index": obj.get("index") if obj.get("index") is not None else -1,
+            "protocol": obj.get("protocol"),
+            "version": obj.get("version"),
+            "target": obj.get("target"),
+            "method": obj.get("method"),
+            "headers": obj.get("headers"),
+            "parameters": obj.get("parameters"),
+            "body": ArtifactContent.from_dict(obj["body"]) if obj.get("body") is not None else None,
+            "properties": PropertyBag.from_dict(obj["properties"]) if obj.get("properties") is not None else None
+        })
+        return _obj
+
+

hiddenlayer/sdk/rest/models/web_response.py

@@ -0,0 +1,112 @@
+# coding: utf-8
+
+"""
+    HiddenLayer ModelScan V2
+
+    HiddenLayer ModelScan API for scanning of models
+
+    The version of the OpenAPI document: 1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from hiddenlayer.sdk.rest.models.artifact_content import ArtifactContent
+from hiddenlayer.sdk.rest.models.property_bag import PropertyBag
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WebResponse(BaseModel):
+    """
+    Describes the response to an HTTP request.
+    """ # noqa: E501
+    index: Optional[Annotated[int, Field(strict=True, ge=-1)]] = Field(default=-1, description="The index within the run.webResponses array of the response object associated with this result.")
+    protocol: Optional[StrictStr] = Field(default=None, description="The response protocol. Example: 'http'.")
+    version: Optional[StrictStr] = Field(default=None, description="The response version. Example: '1.1'.")
+    status_code: Optional[StrictInt] = Field(default=None, description="The response status code. Example: 451.", alias="statusCode")
+    reason_phrase: Optional[StrictStr] = Field(default=None, description="The response reason. Example: 'Not found'.", alias="reasonPhrase")
+    headers: Optional[Dict[str, StrictStr]] = Field(default=None, description="The response headers.")
+    body: Optional[ArtifactContent] = None
+    no_response_received: Optional[StrictBool] = Field(default=False, description="Specifies whether a response was received from the server.", alias="noResponseReceived")
+    properties: Optional[PropertyBag] = None
+    __properties: ClassVar[List[str]] = ["index", "protocol", "version", "statusCode", "reasonPhrase", "headers", "body", "noResponseReceived", "properties"]
+
+    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 WebResponse 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 body
+        if self.body:
+            _dict['body'] = self.body.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of properties
+        if self.properties:
+            _dict['properties'] = self.properties.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WebResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "index": obj.get("index") if obj.get("index") is not None else -1,
+            "protocol": obj.get("protocol"),
+            "version": obj.get("version"),
+            "statusCode": obj.get("statusCode"),
+            "reasonPhrase": obj.get("reasonPhrase"),
+            "headers": obj.get("headers"),
+            "body": ArtifactContent.from_dict(obj["body"]) if obj.get("body") is not None else None,
+            "noResponseReceived": obj.get("noResponseReceived") if obj.get("noResponseReceived") is not None else False,
+            "properties": PropertyBag.from_dict(obj["properties"]) if obj.get("properties") is not None else None
+        })
+        return _obj
+
+

hiddenlayer/sdk/rest/rest.py

@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    HiddenLayer ModelScan
+    HiddenLayer ModelScan V2
 
     HiddenLayer ModelScan API for scanning of models
 

hiddenlayer/sdk/services/model.py

@@ -22,16 +22,19 @@ class ModelAPI:
     def __init__(self, api_client: ApiClient) -> None:
         self._sensor_api = SensorApi(api_client=api_client)
 
-    def create(self, *, model_name: str) -> Model:
+    def create(self, *, model_name: str, model_version: Optional[int]) -> Model:
         """
         Creates a model in the HiddenLayer Platform.
 
         :params model_name: Name of the model
+        :params model_version: Version of the model
 
         :returns: HiddenLayer ModelID
         """
         return self._sensor_api.create_sensor(
-            CreateSensorRequest(plaintext_name=model_name, adhoc=True)
+            CreateSensorRequest(
+                plaintext_name=model_name, version=model_version, adhoc=True
+            )
         )
 
     def get(self, *, model_name: str, version: Optional[int] = None) -> Model: