hiddenlayer-sdk 3.0.0__tar.gz → 3.1.0__tar.gz

hiddenlayer_sdk-3.1.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "3.1.0"
+}

{hiddenlayer_sdk-3.0.0 → hiddenlayer_sdk-3.1.0}/CHANGELOG.md

@@ -1,5 +1,45 @@
 # Changelog
 
+## 3.1.0 (2025-10-22)
+
+Full Changelog: [v3.0.1...v3.1.0](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/compare/v3.0.1...v3.1.0)
+
+### Features
+
+* **api:** api update ([f9b04a6](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/f9b04a6f32744afdfafa6bac6dc8e6cc514ad735))
+* **api:** api update ([cac77ff](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/cac77ffde9e844dbaa0089e33d365fb6f01ad060))
+* **api:** api update ([a5f4aa4](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/a5f4aa47ae06afd63a0a5f476023492e23b01d87))
+* **api:** api update ([f8ea9b3](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/f8ea9b34e18900b9955ce810e396a9050a5a3683))
+* **api:** api update ([a09c23c](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/a09c23c700f049b0b20a50bd7b09737981eebe4d))
+* **api:** api update ([144ea2b](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/144ea2b7fb99d892088bc72a725fd8a0fecb0382))
+* **api:** api update ([495bc26](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/495bc26f2f5aee49e6ac239011a1e9666f9c8e58))
+* **api:** api update ([82bcadd](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/82bcaddd193d4ad155eb2651cb190a4a200800e1))
+* **api:** api update ([da69d10](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/da69d104dc5f408a04d46c0266973fe404665cf8))
+* **api:** api update ([75a179e](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/75a179e93a759b83194806b4c561ad4035ae2714))
+* **api:** api update ([56ec98d](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/56ec98d2485b1ebb16a832d4eac125d05a7a1993))
+* **api:** manual updates ([7e16b74](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/7e16b749a22db9414de5faf17067f15cf37ff78a))
+* **api:** manual updates ([4a1d8af](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/4a1d8af69e44413809219221e5a3ff3b102a7637))
+* **api:** restore ScanReport ([5bba48d](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/5bba48def63831679f3f33475b9ed423c9726bbf))
+
+
+### Bug Fixes
+
+* **compat:** compat with `pydantic<2.8.0` when using additional fields ([a055406](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/a055406b415d42d8b99284a200eaf0af694e14c3))
+
+
+### Chores
+
+* bump `httpx-aiohttp` version to 0.1.9 ([01ab00d](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/01ab00ddaf35da51b7c4a546c37f7d092357ffe4))
+* **internal:** detect missing future annotations with ruff ([e087ecc](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/e087ecc97867d858d138af0ebb7dfd7e919c14bb))
+
+## 3.0.1 (2025-09-23)
+
+Full Changelog: [v3.0.0...v3.0.1](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/compare/v3.0.0...v3.0.1)
+
+### Features
+
+* **api:** manual updates ([2be2f2c](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/2be2f2c124d8ac9b9d22c675c165be496c1793ba))
+
 ## 3.0.0 (2025-09-23)
 
 Full Changelog: [v0.1.0-alpha.33...v3.0.0](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/compare/v0.1.0-alpha.33...v3.0.0)

{hiddenlayer_sdk-3.0.0 → hiddenlayer_sdk-3.1.0}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.3
 Name: hiddenlayer-sdk
-Version: 3.0.0
+Version: 3.1.0
 Summary: The official Python library for the hiddenlayer API
 Project-URL: Homepage, https://github.com/hiddenlayerai/hiddenlayer-sdk-python
 Project-URL: Repository, https://github.com/hiddenlayerai/hiddenlayer-sdk-python
-Author-email: HiddenLayer <dev-feedback@hiddenlayer-sdk.com>
+Author-email: HiddenLayer <sdks@hiddenlayer.com>
 License: Apache-2.0
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
@@ -33,7 +33,7 @@ Requires-Dist: types-requests>=2.32.0.20241016
 Requires-Dist: typing-extensions<5,>=4.10
 Provides-Extra: aiohttp
 Requires-Dist: aiohttp; extra == 'aiohttp'
-Requires-Dist: httpx-aiohttp>=0.1.8; extra == 'aiohttp'
+Requires-Dist: httpx-aiohttp>=0.1.9; extra == 'aiohttp'
 Description-Content-Type: text/markdown
 
 # HiddenLayer Python API library
@@ -70,10 +70,21 @@ client = HiddenLayer(
     environment="prod-eu",
 )
 
-sensor = client.sensors.create(
-    plaintext_name="REPLACE_ME",
+response = client.interactions.analyze(
+    metadata={
+        "model": "REPLACE_ME",
+        "requester_id": "REPLACE_ME",
+    },
+    input={
+        "messages": [
+            {
+                "role": "user",
+                "content": "REPLACE_ME",
+            }
+        ]
+    },
 )
-print(sensor.model_id)
+print(response.analysis)
 ```
 
 While you can provide a `bearer_token` keyword argument,
@@ -96,10 +107,21 @@ client = AsyncHiddenLayer(
 
 
 async def main() -> None:
-    sensor = await client.sensors.create(
-        plaintext_name="REPLACE_ME",
+    response = await client.interactions.analyze(
+        metadata={
+            "model": "REPLACE_ME",
+            "requester_id": "REPLACE_ME",
+        },
+        input={
+            "messages": [
+                {
+                    "role": "user",
+                    "content": "REPLACE_ME",
+                }
+            ]
+        },
     )
-    print(sensor.model_id)
+    print(response.analysis)
 
 
 asyncio.run(main())
@@ -130,10 +152,21 @@ async def main() -> None:
     async with AsyncHiddenLayer(
         http_client=DefaultAioHttpClient(),
     ) as client:
-        sensor = await client.sensors.create(
-            plaintext_name="REPLACE_ME",
+        response = await client.interactions.analyze(
+            metadata={
+                "model": "REPLACE_ME",
+                "requester_id": "REPLACE_ME",
+            },
+            input={
+                "messages": [
+                    {
+                        "role": "user",
+                        "content": "REPLACE_ME",
+                    }
+                ]
+            },
         )
-        print(sensor.model_id)
+        print(response.analysis)
 
 
 asyncio.run(main())
@@ -157,10 +190,14 @@ from hiddenlayer import HiddenLayer
 
 client = HiddenLayer()
 
-page = client.models.cards.list(
-    model_created={},
+response = client.interactions.analyze(
+    metadata={
+        "model": "gpt-5",
+        "requester_id": "user-1234",
+        "provider": "openai",
+    },
 )
-print(page.results)
+print(response.metadata)
 ```
 
 ## Handling errors
@@ -179,8 +216,19 @@ from hiddenlayer import HiddenLayer
 client = HiddenLayer()
 
 try:
-    client.sensors.create(
-        plaintext_name="REPLACE_ME",
+    client.interactions.analyze(
+        metadata={
+            "model": "REPLACE_ME",
+            "requester_id": "REPLACE_ME",
+        },
+        input={
+            "messages": [
+                {
+                    "role": "user",
+                    "content": "REPLACE_ME",
+                }
+            ]
+        },
     )
 except hiddenlayer.APIConnectionError as e:
     print("The server could not be reached")
@@ -224,8 +272,19 @@ client = HiddenLayer(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).sensors.create(
-    plaintext_name="REPLACE_ME",
+client.with_options(max_retries=5).interactions.analyze(
+    metadata={
+        "model": "REPLACE_ME",
+        "requester_id": "REPLACE_ME",
+    },
+    input={
+        "messages": [
+            {
+                "role": "user",
+                "content": "REPLACE_ME",
+            }
+        ]
+    },
 )
 ```
 
@@ -249,8 +308,19 @@ client = HiddenLayer(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).sensors.create(
-    plaintext_name="REPLACE_ME",
+client.with_options(timeout=5.0).interactions.analyze(
+    metadata={
+        "model": "REPLACE_ME",
+        "requester_id": "REPLACE_ME",
+    },
+    input={
+        "messages": [
+            {
+                "role": "user",
+                "content": "REPLACE_ME",
+            }
+        ]
+    },
 )
 ```
 
@@ -292,13 +362,22 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from hiddenlayer import HiddenLayer
 
 client = HiddenLayer()
-response = client.sensors.with_raw_response.create(
-    plaintext_name="REPLACE_ME",
+response = client.interactions.with_raw_response.analyze(
+    metadata={
+        "model": "REPLACE_ME",
+        "requester_id": "REPLACE_ME",
+    },
+    input={
+        "messages": [{
+            "role": "user",
+            "content": "REPLACE_ME",
+        }]
+    },
 )
 print(response.headers.get('X-My-Header'))
 
-sensor = response.parse()  # get the object that `sensors.create()` would have returned
-print(sensor.model_id)
+interaction = response.parse()  # get the object that `interactions.analyze()` would have returned
+print(interaction.analysis)
 ```
 
 These methods return an [`APIResponse`](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/tree/main/src/hiddenlayer/_response.py) object.
@@ -312,8 +391,19 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.sensors.with_streaming_response.create(
-    plaintext_name="REPLACE_ME",
+with client.interactions.with_streaming_response.analyze(
+    metadata={
+        "model": "REPLACE_ME",
+        "requester_id": "REPLACE_ME",
+    },
+    input={
+        "messages": [
+            {
+                "role": "user",
+                "content": "REPLACE_ME",
+            }
+        ]
+    },
 ) as response:
     print(response.headers.get("X-My-Header"))
 

{hiddenlayer_sdk-3.0.0 → hiddenlayer_sdk-3.1.0}/README.md

@@ -32,10 +32,21 @@ client = HiddenLayer(
     environment="prod-eu",
 )
 
-sensor = client.sensors.create(
-    plaintext_name="REPLACE_ME",
+response = client.interactions.analyze(
+    metadata={
+        "model": "REPLACE_ME",
+        "requester_id": "REPLACE_ME",
+    },
+    input={
+        "messages": [
+            {
+                "role": "user",
+                "content": "REPLACE_ME",
+            }
+        ]
+    },
 )
-print(sensor.model_id)
+print(response.analysis)
 ```
 
 While you can provide a `bearer_token` keyword argument,
@@ -58,10 +69,21 @@ client = AsyncHiddenLayer(
 
 
 async def main() -> None:
-    sensor = await client.sensors.create(
-        plaintext_name="REPLACE_ME",
+    response = await client.interactions.analyze(
+        metadata={
+            "model": "REPLACE_ME",
+            "requester_id": "REPLACE_ME",
+        },
+        input={
+            "messages": [
+                {
+                    "role": "user",
+                    "content": "REPLACE_ME",
+                }
+            ]
+        },
     )
-    print(sensor.model_id)
+    print(response.analysis)
 
 
 asyncio.run(main())
@@ -92,10 +114,21 @@ async def main() -> None:
     async with AsyncHiddenLayer(
         http_client=DefaultAioHttpClient(),
     ) as client:
-        sensor = await client.sensors.create(
-            plaintext_name="REPLACE_ME",
+        response = await client.interactions.analyze(
+            metadata={
+                "model": "REPLACE_ME",
+                "requester_id": "REPLACE_ME",
+            },
+            input={
+                "messages": [
+                    {
+                        "role": "user",
+                        "content": "REPLACE_ME",
+                    }
+                ]
+            },
         )
-        print(sensor.model_id)
+        print(response.analysis)
 
 
 asyncio.run(main())
@@ -119,10 +152,14 @@ from hiddenlayer import HiddenLayer
 
 client = HiddenLayer()
 
-page = client.models.cards.list(
-    model_created={},
+response = client.interactions.analyze(
+    metadata={
+        "model": "gpt-5",
+        "requester_id": "user-1234",
+        "provider": "openai",
+    },
 )
-print(page.results)
+print(response.metadata)
 ```
 
 ## Handling errors
@@ -141,8 +178,19 @@ from hiddenlayer import HiddenLayer
 client = HiddenLayer()
 
 try:
-    client.sensors.create(
-        plaintext_name="REPLACE_ME",
+    client.interactions.analyze(
+        metadata={
+            "model": "REPLACE_ME",
+            "requester_id": "REPLACE_ME",
+        },
+        input={
+            "messages": [
+                {
+                    "role": "user",
+                    "content": "REPLACE_ME",
+                }
+            ]
+        },
     )
 except hiddenlayer.APIConnectionError as e:
     print("The server could not be reached")
@@ -186,8 +234,19 @@ client = HiddenLayer(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).sensors.create(
-    plaintext_name="REPLACE_ME",
+client.with_options(max_retries=5).interactions.analyze(
+    metadata={
+        "model": "REPLACE_ME",
+        "requester_id": "REPLACE_ME",
+    },
+    input={
+        "messages": [
+            {
+                "role": "user",
+                "content": "REPLACE_ME",
+            }
+        ]
+    },
 )
 ```
 
@@ -211,8 +270,19 @@ client = HiddenLayer(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).sensors.create(
-    plaintext_name="REPLACE_ME",
+client.with_options(timeout=5.0).interactions.analyze(
+    metadata={
+        "model": "REPLACE_ME",
+        "requester_id": "REPLACE_ME",
+    },
+    input={
+        "messages": [
+            {
+                "role": "user",
+                "content": "REPLACE_ME",
+            }
+        ]
+    },
 )
 ```
 
@@ -254,13 +324,22 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from hiddenlayer import HiddenLayer
 
 client = HiddenLayer()
-response = client.sensors.with_raw_response.create(
-    plaintext_name="REPLACE_ME",
+response = client.interactions.with_raw_response.analyze(
+    metadata={
+        "model": "REPLACE_ME",
+        "requester_id": "REPLACE_ME",
+    },
+    input={
+        "messages": [{
+            "role": "user",
+            "content": "REPLACE_ME",
+        }]
+    },
 )
 print(response.headers.get('X-My-Header'))
 
-sensor = response.parse()  # get the object that `sensors.create()` would have returned
-print(sensor.model_id)
+interaction = response.parse()  # get the object that `interactions.analyze()` would have returned
+print(interaction.analysis)
 ```
 
 These methods return an [`APIResponse`](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/tree/main/src/hiddenlayer/_response.py) object.
@@ -274,8 +353,19 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.sensors.with_streaming_response.create(
-    plaintext_name="REPLACE_ME",
+with client.interactions.with_streaming_response.analyze(
+    metadata={
+        "model": "REPLACE_ME",
+        "requester_id": "REPLACE_ME",
+    },
+    input={
+        "messages": [
+            {
+                "role": "user",
+                "content": "REPLACE_ME",
+            }
+        ]
+    },
 ) as response:
     print(response.headers.get("X-My-Header"))
 

{hiddenlayer_sdk-3.0.0 → hiddenlayer_sdk-3.1.0}/api.md

@@ -80,7 +80,7 @@ Methods:
 Types:
 
 ```python
-from hiddenlayer.types.scans import FileScanReport, ScanReport, ResultSarifResponse
+from hiddenlayer.types.scans import ScanReport, ResultSarifResponse
 ```
 
 Methods:
@@ -92,14 +92,7 @@ Methods:
 Types:
 
 ```python
-from hiddenlayer.types.scans import (
-    ScanJob, 
-    ScanReport, 
-    JobListResponse,
-    JobListParams,
-    JobRequestParams,
-    JobRetrieveParams,
-)
+from hiddenlayer.types.scans import JobListResponse, ScanJob, ScanReport
 ```
 
 Methods:

{hiddenlayer_sdk-3.0.0 → hiddenlayer_sdk-3.1.0}/pyproject.toml

@@ -1,11 +1,11 @@
 [project]
 name = "hiddenlayer-sdk"
-version = "3.0.0"
+version = "3.1.0"
 description = "The official Python library for the hiddenlayer API"
 dynamic = ["readme"]
 license = {text = "Apache-2.0"}
 authors = [
-{ name = "HiddenLayer", email = "dev-feedback@hiddenlayer-sdk.com" },
+{ name = "HiddenLayer", email = "sdks@hiddenlayer.com" },
 ]
 dependencies = [
     "httpx>=0.23.0, <1",
@@ -42,7 +42,7 @@ Homepage = "https://github.com/hiddenlayerai/hiddenlayer-sdk-python"
 Repository = "https://github.com/hiddenlayerai/hiddenlayer-sdk-python"
 
 [project.optional-dependencies]
-aiohttp = ["aiohttp", "httpx_aiohttp>=0.1.8"]
+aiohttp = ["aiohttp", "httpx_aiohttp>=0.1.9"]
 
 [tool.rye]
 managed = true
@@ -229,6 +229,8 @@ select = [
   "B",
   # remove unused imports
   "F401",
+  # check for missing future annotations
+  "FA102",
   # bare except statements
   "E722",
   # unused arguments
@@ -251,6 +253,8 @@ unfixable = [
   "T203",
 ]
 
+extend-safe-fixes = ["FA102"]
+
 [tool.ruff.lint.flake8-tidy-imports.banned-api]
 "functools.lru_cache".msg = "This function does not retain type information for the wrapped function's arguments; The `lru_cache` function from `_utils` should be used instead"
 

{hiddenlayer_sdk-3.0.0 → hiddenlayer_sdk-3.1.0}/requirements-dev.lock

@@ -59,7 +59,7 @@ httpx==0.28.1
     # via hiddenlayer-sdk
     # via httpx-aiohttp
     # via respx
-httpx-aiohttp==0.1.8
+httpx-aiohttp==0.1.9
     # via hiddenlayer-sdk
 idna==3.4
     # via anyio

{hiddenlayer_sdk-3.0.0 → hiddenlayer_sdk-3.1.0}/requirements.lock

@@ -46,7 +46,7 @@ httpcore==1.0.9
 httpx==0.28.1
     # via hiddenlayer-sdk
     # via httpx-aiohttp
-httpx-aiohttp==0.1.8
+httpx-aiohttp==0.1.9
     # via hiddenlayer-sdk
 idna==3.4
     # via anyio

{hiddenlayer_sdk-3.0.0 → hiddenlayer_sdk-3.1.0}/src/hiddenlayer/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "hiddenlayer"
-__version__ = "3.0.0"  # x-release-please-version
+__version__ = "3.1.0"  # x-release-please-version

hiddenlayer_sdk-3.1.0/src/hiddenlayer/lib/__init__.py

@@ -0,0 +1,12 @@
+# Custom extensions for HiddenLayer SDK
+
+from .model_scan import ModelScanner, AsyncModelScanner
+from .community_scan import CommunityScanner, CommunityScanSource, AsyncCommunityScanner
+
+__all__ = [
+    "CommunityScanner",
+    "AsyncCommunityScanner",
+    "ModelScanner",
+    "AsyncModelScanner",
+    "CommunityScanSource",
+]

{hiddenlayer_sdk-3.0.0 → hiddenlayer_sdk-3.1.0}/src/hiddenlayer/lib/model_scan.py

@@ -12,8 +12,6 @@ from fnmatch import fnmatch
 from pathlib import Path
 from typing_extensions import TYPE_CHECKING
 
-import httpx
-
 from .scan_utils import get_scan_results, wait_for_scan_results, get_scan_results_async, wait_for_scan_results_async
 
 logger = logging.getLogger(__name__)
@@ -135,8 +133,6 @@ class ModelScanner:
         )
 
         scan_id = upload_response.scan_id
-        if scan_id is None:
-            raise ValueError("scan_id must have a value")
 
         # Upload the file
         self._scan_file(scan_id=scan_id, file_path=file_path)
@@ -189,8 +185,6 @@ class ModelScanner:
         )
 
         scan_id = upload_response.scan_id
-        if scan_id is None:
-            raise ValueError("scan_id must have a value")
 
         # Prepare file patterns
         ignore_file_patterns = EXCLUDE_FILE_TYPES + ignore_file_patterns if ignore_file_patterns else EXCLUDE_FILE_TYPES
@@ -445,7 +439,7 @@ class ModelScanner:
                 if part.upload_url is None:
                     raise Exception("part.upload_url must not be None")
 
-                response = httpx.put(
+                response = self._client._client.put(
                     part.upload_url,
                     content=part_data,
                     headers={"Content-Type": "application/octet-stream"},
@@ -491,8 +485,6 @@ class AsyncModelScanner:
         )
 
         scan_id = upload_response.scan_id
-        if scan_id is None:
-            raise ValueError("scan_id must have a value")
 
         # Upload the file
         await self._scan_file(scan_id=scan_id, file_path=file_path)
@@ -536,8 +528,6 @@ class AsyncModelScanner:
         )
 
         scan_id = upload_response.scan_id
-        if scan_id is None:
-            raise ValueError("scan_id must have a value")
 
         # Prepare file patterns
         ignore_file_patterns = EXCLUDE_FILE_TYPES + ignore_file_patterns if ignore_file_patterns else EXCLUDE_FILE_TYPES
@@ -740,13 +730,12 @@ class AsyncModelScanner:
                 if part.upload_url is None:
                     raise Exception("part.upload_url must not be None")
 
-                async with httpx.AsyncClient() as client:
-                    response = await client.put(
-                        part.upload_url,
-                        content=part_data,
-                        headers={"Content-Type": "application/octet-stream"},
-                    )
-                    response.raise_for_status()
+                response = await self._client._client.put(
+                    part.upload_url,
+                    content=part_data,
+                    headers={"Content-Type": "application/octet-stream"},
+                )
+                response.raise_for_status()
 
         # Complete the file upload
         await self._client.scans.upload.file.complete(file_id=upload.upload_id, scan_id=scan_id)