hiddenlayer-sdk 3.5.0__tar.gz → 3.6.0__tar.gz

{hiddenlayer_sdk-3.5.0 → hiddenlayer_sdk-3.6.0}/.gitignore

@@ -1,4 +1,5 @@
 .prism.log
+.stdy.log
 _dev
 
 __pycache__

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

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

{hiddenlayer_sdk-3.5.0 → hiddenlayer_sdk-3.6.0}/CHANGELOG.md

@@ -1,5 +1,62 @@
 # Changelog
 
+## 3.6.0 (2026-04-14)
+
+Full Changelog: [v3.5.0...v3.6.0](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/compare/v3.5.0...v3.6.0)
+
+### Features
+
+* add beta instability warnings for unstable SDK methods ([#186](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/issues/186)) ([e56488a](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/e56488a532201b4f6cc46c5a0be68a45614b1734))
+* **api:** add runtime security evaluations endpoints ([2433787](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/2433787d248b222da7a077b2ef1efd54f5116f7e))
+* **api:** api update ([6b894b8](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/6b894b89ab4cef087e0fc7df4a62913c4b1b1710))
+* **api:** api update ([dd91242](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/dd912420f1d2e8574454cdfa754f4817b7a2423e))
+* **api:** api update ([825a274](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/825a2742d0b674b392e37c99be54c576ff9be34c))
+* **api:** api update ([c43deaa](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/c43deaa74339cc7f3f70cb4b5e26c027fe975896))
+* **api:** api update ([716c68c](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/716c68cef3e9ae8d15631d417335c3f387bedc72))
+* **api:** api update ([98a52fa](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/98a52fad11b3e42b9b576738601743f59ad8752d))
+* **api:** finalize runtime security endpoints ([e83726c](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/e83726c4a62ede87be9222e1f3acbbd0c27e1f99))
+* **internal:** implement indices array format for query and form serialization ([05135c2](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/05135c262a3688319bfd7508452b1c101d9901c4))
+
+
+### Bug Fixes
+
+* **beta:** harden CI tests against codegen churn ([#191](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/issues/191)) ([8f85aec](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/8f85aec226a6a7278aa388d30f74d7735031b9cb))
+* **client:** preserve hardcoded query params when merging with user params ([90ad63a](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/90ad63ae4aea92158416a5e1101a3d0496a20646))
+* correct async method indentation in beta warning patcher ([2af3e63](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/2af3e6358565aaca1a3b3069868f2af090db7f92))
+* **deps:** bump minimum typing-extensions version ([53b0b0e](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/53b0b0edfaf7a7dea0b097333fac0ecdc9a16bcb))
+* ensure file data are only sent as 1 parameter ([1ea7561](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/1ea756124f32f0f49ba9d73bcdc2c4d63931c649))
+* **pydantic:** do not pass `by_alias` unless set ([86f9db3](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/86f9db32c94ff8358bf294f14a54a460d1d7444b))
+* sanitize endpoint path params ([ea53526](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/ea5352653b0708eaa5f495a598cdf19935d26fac))
+* **tests:** correct setup of OAuth 2 Client Credentials tests ([b3887a1](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/b3887a1e39f05e01d5e16c768ef96ac6ca6e98ed))
+
+
+### Chores
+
+* **ci:** skip lint on metadata-only changes ([803a48b](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/803a48bed50ae657bfe8efdbfce86969d57ac96d))
+* **ci:** skip uploading artifacts on stainless-internal branches ([e901a9f](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/e901a9f5a6af3b5650d0002b9dd18b7ba954c38d))
+* **deps:** bump actions/setup-node from 4 to 6 ([5abc090](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/5abc090fa35bc1efd1422cd8455aa369fed72fc4))
+* **deps:** bump github/codeql-action from 4.32.6 to 4.35.1 ([6715471](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/67154712c4497ee3d90fea9aa9632d2ad6fa763d))
+* **deps:** bump step-security/harden-runner from 2.15.1 to 2.16.1 ([58738e5](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/58738e54c1dd7cfe4b710e0cc75a246598c6b9f7))
+* **internal:** codegen related update ([e2b17fd](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/e2b17fd099188441b0d296a1a745a930f9953665))
+* **internal:** tweak CI branches ([535faac](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/535faacf763992576b28266f92e226be1f07fb09))
+* **internal:** update gitignore ([bf2dcbe](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/bf2dcbe99c112ab5869ecff719ae66c93cacfc15))
+* patch beta warnings [skip ci] ([ff2ae92](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/ff2ae92be61ae0838e24d28632e38aa024ad28cb))
+* regenerate beta endpoint registry [skip ci] ([5aded1f](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/5aded1f3c1b0aa3bc4ae76137faf6987a71c0db2))
+* regenerate beta endpoint registry [skip ci] ([126b13e](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/126b13ea66294a7c1a2d31e8edfcd336552b245e))
+* regenerate beta endpoint registry [skip ci] ([24d568e](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/24d568e9fc74b6a0c044ea9a74120e4504fe1b16))
+* remove stale version comments from SHA-pinned actions ([#184](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/issues/184)) ([cf07e32](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/cf07e322e7b4674fe3ef622e491278b0346e5e7e))
+
+
+### Documentation
+
+* **readme:** add Beta APIs section ([#185](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/issues/185)) ([b1381e3](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/b1381e389f6e7ee59ba51ff00ce84b4a43f97c35))
+
+
+### Refactors
+
+* **client:** move beta warnings to _prepare_options interceptor ([#190](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/issues/190)) ([893ee22](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/893ee22fdda949ebab80d66d70b99accb79aded2))
+* **types:** use `extra_items` from PEP 728 ([e5ee89f](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/commit/e5ee89fccbefe680538b8b3b06871dfba90d1474))
+
 ## 3.5.0 (2026-03-03)
 
 Full Changelog: [v3.4.0...v3.5.0](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/compare/v3.4.0...v3.5.0)

{hiddenlayer_sdk-3.5.0 → hiddenlayer_sdk-3.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: hiddenlayer-sdk
-Version: 3.5.0
+Version: 3.6.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
@@ -30,7 +30,7 @@ Requires-Dist: requests-auth>=8.0.0
 Requires-Dist: requests>=2.32.4
 Requires-Dist: sniffio
 Requires-Dist: types-requests>=2.32.0.20241016
-Requires-Dist: typing-extensions<5,>=4.10
+Requires-Dist: typing-extensions<5,>=4.14
 Provides-Extra: aiohttp
 Requires-Dist: aiohttp; extra == 'aiohttp'
 Requires-Dist: httpx-aiohttp>=0.1.9; extra == 'aiohttp'
@@ -51,6 +51,13 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 The REST API documentation can be found on [dev.hiddenlayer.ai](https://dev.hiddenlayer.ai). The full API of this library can be found in [api.md](https://github.com/hiddenlayerai/hiddenlayer-sdk-python/tree/main/api.md).
 
+## Beta APIs
+
+Some HiddenLayer APIs are marked as **Beta**, meaning they are not yet generally available (GA) or production ready. Beta APIs can be used in a production environment, but at your own risk and discretion. For full details, see the [Beta API Guidelines](https://dev.hiddenlayer.ai/docs/beta-api-faq) on the developer portal.
+
+- HiddenLayer does not provide compatibility guarantees for Beta APIs. Breaking changes may occur at any time.
+- SDK functions and types associated with Beta APIs are excluded when determining semver release versions.
+
 ## Installation
 
 ```sh

{hiddenlayer_sdk-3.5.0 → hiddenlayer_sdk-3.6.0}/README.md

@@ -13,6 +13,13 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 The REST API documentation can be found on [dev.hiddenlayer.ai](https://dev.hiddenlayer.ai). The full API of this library can be found in [api.md](api.md).
 
+## Beta APIs
+
+Some HiddenLayer APIs are marked as **Beta**, meaning they are not yet generally available (GA) or production ready. Beta APIs can be used in a production environment, but at your own risk and discretion. For full details, see the [Beta API Guidelines](https://dev.hiddenlayer.ai/docs/beta-api-faq) on the developer portal.
+
+- HiddenLayer does not provide compatibility guarantees for Beta APIs. Breaking changes may occur at any time.
+- SDK functions and types associated with Beta APIs are excluded when determining semver release versions.
+
 ## Installation
 
 ```sh

{hiddenlayer_sdk-3.5.0 → hiddenlayer_sdk-3.6.0}/api.md

@@ -43,19 +43,19 @@ from hiddenlayer.types.evaluations import (
 
 Methods:
 
-- <code title="post /evaluations/v1-beta/red-team">client.evaluations.red_team.<a href="./src/hiddenlayer/resources/evaluations/red_team.py">create</a>(\*\*<a href="src/hiddenlayer/types/evaluations/red_team_create_params.py">params</a>) -> <a href="./src/hiddenlayer/types/evaluations/red_team_create_response.py">RedTeamCreateResponse</a></code>
-- <code title="get /evaluations/v1-beta/red-team/{workflow_id}">client.evaluations.red_team.<a href="./src/hiddenlayer/resources/evaluations/red_team.py">retrieve_evaluation_results</a>(workflow_id) -> <a href="./src/hiddenlayer/types/evaluations/red_team_retrieve_evaluation_results_response.py">RedTeamRetrieveEvaluationResultsResponse</a></code>
-- <code title="get /evaluations/v1-beta/red-team/{workflow_id}/next-action">client.evaluations.red_team.<a href="./src/hiddenlayer/resources/evaluations/red_team.py">retrieve_next_action</a>(workflow_id) -> <a href="./src/hiddenlayer/types/evaluations/red_team_retrieve_next_action_response.py">RedTeamRetrieveNextActionResponse</a></code>
-- <code title="get /evaluations/v1-beta/red-team/{workflow_id}/status">client.evaluations.red_team.<a href="./src/hiddenlayer/resources/evaluations/red_team.py">retrieve_status</a>(workflow_id) -> <a href="./src/hiddenlayer/types/evaluations/red_team_retrieve_status_response.py">RedTeamRetrieveStatusResponse</a></code>
-- <code title="post /evaluations/v1-beta/red-team/{workflow_id}/target-response">client.evaluations.red_team.<a href="./src/hiddenlayer/resources/evaluations/red_team.py">submit_target_response</a>(workflow_id, \*\*<a href="src/hiddenlayer/types/evaluations/red_team_submit_target_response_params.py">params</a>) -> <a href="./src/hiddenlayer/types/evaluations/red_team_submit_target_response_response.py">RedTeamSubmitTargetResponseResponse</a></code>
-- <code title="post /evaluations/v1-beta/red-team/terminations/{workflow_id}">client.evaluations.red_team.<a href="./src/hiddenlayer/resources/evaluations/red_team.py">terminate</a>(workflow_id) -> None</code>
+- <code title="post /evaluations/v1/red-team">client.evaluations.red_team.<a href="./src/hiddenlayer/resources/evaluations/red_team.py">create</a>(\*\*<a href="src/hiddenlayer/types/evaluations/red_team_create_params.py">params</a>) -> <a href="./src/hiddenlayer/types/evaluations/red_team_create_response.py">RedTeamCreateResponse</a></code>
+- <code title="get /evaluations/v1/red-team/{workflow_id}">client.evaluations.red_team.<a href="./src/hiddenlayer/resources/evaluations/red_team.py">retrieve_evaluation_results</a>(workflow_id) -> <a href="./src/hiddenlayer/types/evaluations/red_team_retrieve_evaluation_results_response.py">RedTeamRetrieveEvaluationResultsResponse</a></code>
+- <code title="get /evaluations/v1/red-team/{workflow_id}/next-action">client.evaluations.red_team.<a href="./src/hiddenlayer/resources/evaluations/red_team.py">retrieve_next_action</a>(workflow_id) -> <a href="./src/hiddenlayer/types/evaluations/red_team_retrieve_next_action_response.py">RedTeamRetrieveNextActionResponse</a></code>
+- <code title="get /evaluations/v1/red-team/{workflow_id}/status">client.evaluations.red_team.<a href="./src/hiddenlayer/resources/evaluations/red_team.py">retrieve_status</a>(workflow_id) -> <a href="./src/hiddenlayer/types/evaluations/red_team_retrieve_status_response.py">RedTeamRetrieveStatusResponse</a></code>
+- <code title="post /evaluations/v1/red-team/{workflow_id}/target-response">client.evaluations.red_team.<a href="./src/hiddenlayer/resources/evaluations/red_team.py">submit_target_response</a>(workflow_id, \*\*<a href="src/hiddenlayer/types/evaluations/red_team_submit_target_response_params.py">params</a>) -> <a href="./src/hiddenlayer/types/evaluations/red_team_submit_target_response_response.py">RedTeamSubmitTargetResponseResponse</a></code>
+- <code title="post /evaluations/v1/jobs/{workflow_id}/termination">client.evaluations.red_team.<a href="./src/hiddenlayer/resources/evaluations/red_team.py">terminate</a>(workflow_id) -> None</code>
 
 # PromptAnalyzer
 
 Types:
 
 ```python
-from hiddenlayer.types import PromptAnalyzerCreateResponse, PromptAnalyzerCreateParams
+from hiddenlayer.types import PromptAnalyzerCreateResponse
 ```
 
 Methods:

{hiddenlayer_sdk-3.5.0 → hiddenlayer_sdk-3.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "hiddenlayer-sdk"
-version = "3.5.0"
+version = "3.6.0"
 description = "The official Python library for the hiddenlayer API"
 dynamic = ["readme"]
 license = {text = "Apache-2.0"}
@@ -11,7 +11,7 @@ authors = [
 dependencies = [
   "httpx>=0.23.0, <1",
   "pydantic>=1.9.0, <3",
-  "typing-extensions>=4.10, <5",
+  "typing-extensions>=4.14, <5",
   "anyio>=3.5.0, <5",
   "distro>=1.7.0, <2",
   "sniffio",
@@ -140,6 +140,7 @@ xfail_strict = true
 asyncio_mode = "auto"
 asyncio_default_fixture_loop_scope = "session"
 filterwarnings = [
+  "default::hiddenlayer.lib._beta.BetaWarning",
   "error"
 ]
 

{hiddenlayer_sdk-3.5.0 → hiddenlayer_sdk-3.6.0}/src/hiddenlayer/__init__.py

@@ -3,7 +3,14 @@
 import typing as _t
 
 from . import types
-from .lib import ModelScanner, CommunityScanner, AsyncModelScanner, AsyncCommunityScanner
+from .lib import (
+    BetaWarning,
+    ModelScanner,
+    CommunityScanner,
+    AsyncModelScanner,
+    AsyncCommunityScanner,
+    warn_beta,
+)
 from ._types import NOT_GIVEN, Omit, NoneType, NotGiven, Transport, ProxiesTypes, omit, not_given
 from ._utils import file_from_path
 from ._client import (
@@ -46,6 +53,8 @@ __all__ = [
     "__version__",
     "__title__",
     "NoneType",
+    "BetaWarning",
+    "warn_beta",
     "CommunityScanner",
     "AsyncCommunityScanner",
     "ModelScanner",

{hiddenlayer_sdk-3.5.0 → hiddenlayer_sdk-3.6.0}/src/hiddenlayer/_base_client.py

@@ -540,6 +540,10 @@ class BaseClient(Generic[_HttpxClientT, _DefaultStreamT]):
                 files = cast(HttpxRequestFiles, ForceMultipartDict())
 
         prepared_url = self._prepare_url(options.url)
+        # preserve hard-coded query params from the url
+        if params and prepared_url.query:
+            params = {**dict(prepared_url.params.items()), **params}
+            prepared_url = prepared_url.copy_with(raw_path=prepared_url.raw_path.split(b"?", 1)[0])
         if "_" in prepared_url.host:
             # work around https://github.com/encode/httpx/discussions/2880
             kwargs["extensions"] = {"sni_hostname": prepared_url.host.replace("_", "-")}

{hiddenlayer_sdk-3.5.0 → hiddenlayer_sdk-3.6.0}/src/hiddenlayer/_client.py

@@ -21,6 +21,7 @@ from ._types import (
 )
 from ._utils import is_given, get_async_library
 from ._compat import cached_property
+from ._models import FinalRequestOptions
 from ._oauth2 import OAuth2ClientCredentials, make_oauth2
 from ._version import __version__
 from ._streaming import Stream as Stream, AsyncStream as AsyncStream
@@ -33,16 +34,18 @@ from ._base_client import (
 
 if TYPE_CHECKING:
     from .resources import scans, models, sensors, evaluations, interactions, prompt_analyzer
-    from .lib.model_scan import ModelScanner, AsyncModelScanner
     from .resources.sensors import SensorsResource, AsyncSensorsResource
-    from .lib.community_scan import CommunityScanner, AsyncCommunityScanner
     from .resources.scans.scans import ScansResource, AsyncScansResource
     from .resources.interactions import InteractionsResource, AsyncInteractionsResource
-    from .lib.evaluation_sessions import EvaluationSessionsResource, AsyncEvaluationSessionsResource
     from .resources.models.models import ModelsResource, AsyncModelsResource
     from .resources.prompt_analyzer import PromptAnalyzerResource, AsyncPromptAnalyzerResource
     from .resources.evaluations.evaluations import EvaluationsResource, AsyncEvaluationsResource
 
+if TYPE_CHECKING:
+    from .lib.model_scan import ModelScanner, AsyncModelScanner
+    from .lib.community_scan import CommunityScanner, AsyncCommunityScanner
+    from .lib.evaluation_sessions import EvaluationSessionsResource, AsyncEvaluationSessionsResource
+
 __all__ = [
     "ENVIRONMENTS",
     "Timeout",
@@ -256,6 +259,12 @@ class HiddenLayer(SyncAPIClient):
                 return True
         return super()._should_retry(response)
 
+    @override
+    def _prepare_options(self, options: FinalRequestOptions) -> FinalRequestOptions:
+        from .lib._beta import check_beta_endpoint
+
+        check_beta_endpoint(options.url)
+        return options
 
     def copy(
         self,
@@ -543,6 +552,13 @@ class AsyncHiddenLayer(AsyncAPIClient):
                 return True
         return super()._should_retry(response)
 
+    @override
+    async def _prepare_options(self, options: FinalRequestOptions) -> FinalRequestOptions:
+        from .lib._beta import check_beta_endpoint
+
+        check_beta_endpoint(options.url)
+        return options
+
     def copy(
         self,
         *,

{hiddenlayer_sdk-3.5.0 → hiddenlayer_sdk-3.6.0}/src/hiddenlayer/_compat.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any, Union, Generic, TypeVar, Callable, cast, overload
 from datetime import date, datetime
-from typing_extensions import Self, Literal
+from typing_extensions import Self, Literal, TypedDict
 
 import pydantic
 from pydantic.fields import FieldInfo
@@ -131,6 +131,10 @@ def model_json(model: pydantic.BaseModel, *, indent: int | None = None) -> str:
     return model.model_dump_json(indent=indent)
 
 
+class _ModelDumpKwargs(TypedDict, total=False):
+    by_alias: bool
+
+
 def model_dump(
     model: pydantic.BaseModel,
     *,
@@ -142,6 +146,9 @@ def model_dump(
     by_alias: bool | None = None,
 ) -> dict[str, Any]:
     if (not PYDANTIC_V1) or hasattr(model, "model_dump"):
+        kwargs: _ModelDumpKwargs = {}
+        if by_alias is not None:
+            kwargs["by_alias"] = by_alias
         return model.model_dump(
             mode=mode,
             exclude=exclude,
@@ -149,7 +156,7 @@ def model_dump(
             exclude_defaults=exclude_defaults,
             # warnings are not supported in Pydantic v1
             warnings=True if PYDANTIC_V1 else warnings,
-            by_alias=by_alias,
+            **kwargs,
         )
     return cast(
         "dict[str, Any]",

{hiddenlayer_sdk-3.5.0 → hiddenlayer_sdk-3.6.0}/src/hiddenlayer/_qs.py

@@ -101,7 +101,10 @@ class Querystring:
                     items.extend(self._stringify_item(key, item, opts))
                 return items
             elif array_format == "indices":
-                raise NotImplementedError("The array indices format is not supported yet")
+                items = []
+                for i, item in enumerate(value):
+                    items.extend(self._stringify_item(f"{key}[{i}]", item, opts))
+                return items
             elif array_format == "brackets":
                 items = []
                 key = key + "[]"

{hiddenlayer_sdk-3.5.0 → hiddenlayer_sdk-3.6.0}/src/hiddenlayer/_utils/__init__.py

@@ -1,3 +1,4 @@
+from ._path import path_template as path_template
 from ._sync import asyncify as asyncify
 from ._proxy import LazyProxy as LazyProxy
 from ._utils import (

hiddenlayer_sdk-3.6.0/src/hiddenlayer/_utils/_path.py

@@ -0,0 +1,127 @@
+from __future__ import annotations
+
+import re
+from typing import (
+    Any,
+    Mapping,
+    Callable,
+)
+from urllib.parse import quote
+
+# Matches '.' or '..' where each dot is either literal or percent-encoded (%2e / %2E).
+_DOT_SEGMENT_RE = re.compile(r"^(?:\.|%2[eE]){1,2}$")
+
+_PLACEHOLDER_RE = re.compile(r"\{(\w+)\}")
+
+
+def _quote_path_segment_part(value: str) -> str:
+    """Percent-encode `value` for use in a URI path segment.
+
+    Considers characters not in `pchar` set from RFC 3986 §3.3 to be unsafe.
+    https://datatracker.ietf.org/doc/html/rfc3986#section-3.3
+    """
+    # quote() already treats unreserved characters (letters, digits, and -._~)
+    # as safe, so we only need to add sub-delims, ':', and '@'.
+    # Notably, unlike the default `safe` for quote(), / is unsafe and must be quoted.
+    return quote(value, safe="!$&'()*+,;=:@")
+
+
+def _quote_query_part(value: str) -> str:
+    """Percent-encode `value` for use in a URI query string.
+
+    Considers &, = and characters not in `query` set from RFC 3986 §3.4 to be unsafe.
+    https://datatracker.ietf.org/doc/html/rfc3986#section-3.4
+    """
+    return quote(value, safe="!$'()*+,;:@/?")
+
+
+def _quote_fragment_part(value: str) -> str:
+    """Percent-encode `value` for use in a URI fragment.
+
+    Considers characters not in `fragment` set from RFC 3986 §3.5 to be unsafe.
+    https://datatracker.ietf.org/doc/html/rfc3986#section-3.5
+    """
+    return quote(value, safe="!$&'()*+,;=:@/?")
+
+
+def _interpolate(
+    template: str,
+    values: Mapping[str, Any],
+    quoter: Callable[[str], str],
+) -> str:
+    """Replace {name} placeholders in `template`, quoting each value with `quoter`.
+
+    Placeholder names are looked up in `values`.
+
+    Raises:
+        KeyError: If a placeholder is not found in `values`.
+    """
+    # re.split with a capturing group returns alternating
+    # [text, name, text, name, ..., text] elements.
+    parts = _PLACEHOLDER_RE.split(template)
+
+    for i in range(1, len(parts), 2):
+        name = parts[i]
+        if name not in values:
+            raise KeyError(f"a value for placeholder {{{name}}} was not provided")
+        val = values[name]
+        if val is None:
+            parts[i] = "null"
+        elif isinstance(val, bool):
+            parts[i] = "true" if val else "false"
+        else:
+            parts[i] = quoter(str(values[name]))
+
+    return "".join(parts)
+
+
+def path_template(template: str, /, **kwargs: Any) -> str:
+    """Interpolate {name} placeholders in `template` from keyword arguments.
+
+    Args:
+        template: The template string containing {name} placeholders.
+        **kwargs: Keyword arguments to interpolate into the template.
+
+    Returns:
+        The template with placeholders interpolated and percent-encoded.
+
+        Safe characters for percent-encoding are dependent on the URI component.
+        Placeholders in path and fragment portions are percent-encoded where the `segment`
+        and `fragment` sets from RFC 3986 respectively are considered safe.
+        Placeholders in the query portion are percent-encoded where the `query` set from
+        RFC 3986 §3.3 is considered safe except for = and & characters.
+
+    Raises:
+        KeyError: If a placeholder is not found in `kwargs`.
+        ValueError: If resulting path contains /./ or /../ segments (including percent-encoded dot-segments).
+    """
+    # Split the template into path, query, and fragment portions.
+    fragment_template: str | None = None
+    query_template: str | None = None
+
+    rest = template
+    if "#" in rest:
+        rest, fragment_template = rest.split("#", 1)
+    if "?" in rest:
+        rest, query_template = rest.split("?", 1)
+    path_template = rest
+
+    # Interpolate each portion with the appropriate quoting rules.
+    path_result = _interpolate(path_template, kwargs, _quote_path_segment_part)
+
+    # Reject dot-segments (. and ..) in the final assembled path.  The check
+    # runs after interpolation so that adjacent placeholders or a mix of static
+    # text and placeholders that together form a dot-segment are caught.
+    # Also reject percent-encoded dot-segments to protect against incorrectly
+    # implemented normalization in servers/proxies.
+    for segment in path_result.split("/"):
+        if _DOT_SEGMENT_RE.match(segment):
+            raise ValueError(f"Constructed path {path_result!r} contains dot-segment {segment!r} which is not allowed")
+
+    result = path_result
+    if query_template is not None:
+        result += "?" + _interpolate(query_template, kwargs, _quote_query_part)
+    if fragment_template is not None:
+        result += "#" + _interpolate(fragment_template, kwargs, _quote_fragment_part)
+
+    return result

{hiddenlayer_sdk-3.5.0 → hiddenlayer_sdk-3.6.0}/src/hiddenlayer/_utils/_utils.py

@@ -86,8 +86,9 @@ def _extract_items(
     index += 1
     if is_dict(obj):
         try:
-            # We are at the last entry in the path so we must remove the field
-            if (len(path)) == index:
+            # Remove the field if there are no more dict keys in the path,
+            # only "<array>" traversal markers or end.
+            if all(p == "<array>" for p in path[index:]):
                 item = obj.pop(key)
             else:
                 item = obj[key]

{hiddenlayer_sdk-3.5.0 → hiddenlayer_sdk-3.6.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.5.0"  # x-release-please-version
+__version__ = "3.6.0"  # x-release-please-version

{hiddenlayer_sdk-3.5.0 → hiddenlayer_sdk-3.6.0}/src/hiddenlayer/lib/__init__.py

@@ -1,9 +1,13 @@
 # Custom extensions for HiddenLayer SDK
+from ._beta import BetaWarning, warn_beta, check_beta_endpoint
 from .model_scan import ModelScanner, AsyncModelScanner
 from .community_scan import CommunityScanner, CommunityScanSource, AsyncCommunityScanner
 from .evaluation_sessions import EvaluationSessionsResource, AsyncEvaluationSessionsResource
 
 __all__ = [
+    "BetaWarning",
+    "warn_beta",
+    "check_beta_endpoint",
     "CommunityScanner",
     "AsyncCommunityScanner",
     "ModelScanner",

hiddenlayer_sdk-3.6.0/src/hiddenlayer/lib/_beta.py

@@ -0,0 +1,45 @@
+"""Runtime beta warning utility.
+
+Emits a warning when a beta endpoint is called, so SDK consumers know
+the method is not yet GA.
+"""
+
+from __future__ import annotations
+
+import warnings
+
+
+class BetaWarning(UserWarning):
+    """Warning emitted when a beta API endpoint is called."""
+
+
+def warn_beta(qualified_name: str, *, stacklevel: int = 3) -> None:
+    """Emit a warning that a beta endpoint was called.
+
+    Args:
+        qualified_name: Fully qualified method name, e.g. "InteractionsResource.analyze"
+        stacklevel: How many frames to skip when reporting the warning location.
+    """
+    warnings.warn(
+        f"[BETA] {qualified_name}: This endpoint is not GA or Production ready "
+        "and is subject to changes at any time. Breaking changes may occur.",
+        BetaWarning,
+        stacklevel=stacklevel,
+    )
+
+
+def check_beta_endpoint(url: str) -> None:
+    """Check whether *url* is a beta endpoint and emit a warning if so.
+
+    Args:
+        url: The URL path for the request (e.g. "/detection/v2/request-evaluations").
+    """
+    from ._beta_endpoints import BETA_ENDPOINTS
+
+    qualified_name = BETA_ENDPOINTS.get(url)
+    if qualified_name is not None:
+        # Called from _prepare_options, which is deeper in the stack than
+        # a direct warn_beta call from a resource method.  The higher
+        # stacklevel won't point at user code, but the message itself
+        # identifies the method.
+        warn_beta(qualified_name, stacklevel=4)

hiddenlayer_sdk-3.6.0/src/hiddenlayer/lib/_beta_endpoints.py

@@ -0,0 +1,11 @@
+"""Auto-generated registry of beta endpoints.
+
+DO NOT EDIT -- regenerated by scripts/utils/generate-beta-endpoints.cjs
+
+Maps URL paths to qualified method names for runtime warnings.
+"""
+from __future__ import annotations
+
+BETA_ENDPOINTS: dict[str, str] = {
+    "/evaluations/v1/red-team": "RedTeamResource.create",
+}

{hiddenlayer_sdk-3.5.0 → hiddenlayer_sdk-3.6.0}/src/hiddenlayer/lib/community_scan.py

@@ -9,7 +9,14 @@ import logging
 from typing import Union, Literal, cast
 from typing_extensions import TYPE_CHECKING
 
-from .scan_utils import get_scan_results, wait_for_scan_results, get_scan_results_async, wait_for_scan_results_async
+from .scan_utils import (
+    ScanResultMixin,
+    AsyncScanResultMixin,
+    get_scan_results,
+    wait_for_scan_results,
+    get_scan_results_async,
+    wait_for_scan_results_async,
+)
 
 logger = logging.getLogger(__name__)
 
@@ -31,7 +38,7 @@ class CommunityScanSource:
     HUGGING_FACE = "HUGGING_FACE"
 
 
-class CommunityScanner:
+class CommunityScanner(ScanResultMixin):
     """
     Community scanner that provides the community_scan method with polling functionality.
 
@@ -108,7 +115,7 @@ class CommunityScanner:
             return get_scan_results(self._client, scan_id=scan_id)
 
 
-class AsyncCommunityScanner:
+class AsyncCommunityScanner(AsyncScanResultMixin):
     """
     Async version of CommunityScanner for use with AsyncHiddenLayer client.
     """
@@ -171,4 +178,4 @@ class AsyncCommunityScanner:
             return await wait_for_scan_results_async(self._client, scan_id=scan_id)
         else:
             # Return current scan status without waiting
-            return await get_scan_results_async(self._client, scan_id=scan_id)
+            return await get_scan_results_async(self._client, scan_id=scan_id)

{hiddenlayer_sdk-3.5.0 → hiddenlayer_sdk-3.6.0}/src/hiddenlayer/lib/model_scan.py

@@ -12,7 +12,14 @@ from fnmatch import fnmatch
 from pathlib import Path
 from typing_extensions import TYPE_CHECKING
 
-from .scan_utils import get_scan_results, wait_for_scan_results, get_scan_results_async, wait_for_scan_results_async
+from .scan_utils import (
+    ScanResultMixin,
+    AsyncScanResultMixin,
+    get_scan_results,
+    wait_for_scan_results,
+    get_scan_results_async,
+    wait_for_scan_results_async,
+)
 from .._exceptions import BadRequestError
 
 logger = logging.getLogger(__name__)
@@ -114,7 +121,7 @@ def filter_path_objects(
 
         yield item
 
-class ModelScanner:
+class ModelScanner(ScanResultMixin):
     """
     Model scanner that provides file and folder scanning functionality.
 
@@ -483,7 +490,7 @@ class ModelScanner:
         self._client.scans.upload.file.complete(file_id=upload.upload_id, scan_id=scan_id)
 
 
-class AsyncModelScanner:
+class AsyncModelScanner(AsyncScanResultMixin):
     """
     Async version of ModelScanner for use with AsyncHiddenLayer client.
     """