hiddenlayer-sdk 2.0.10__py3-none-any.whl → 3.0.1__py3-none-any.whl

hiddenlayer/resources/sensors.py

@@ -0,0 +1,575 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict
+from typing_extensions import Literal
+
+import httpx
+
+from ..types import sensor_query_params, sensor_create_params, sensor_update_params
+from .._types import Body, Omit, Query, Headers, NoneType, NotGiven, omit, not_given
+from .._utils import maybe_transform, strip_not_given, async_maybe_transform
+from .._compat import cached_property
+from .._resource import SyncAPIResource, AsyncAPIResource
+from .._response import (
+    to_raw_response_wrapper,
+    to_streamed_response_wrapper,
+    async_to_raw_response_wrapper,
+    async_to_streamed_response_wrapper,
+)
+from .._base_client import make_request_options
+from ..types.sensor_query_response import SensorQueryResponse
+from ..types.sensor_create_response import SensorCreateResponse
+from ..types.sensor_update_response import SensorUpdateResponse
+from ..types.sensor_retrieve_response import SensorRetrieveResponse
+
+__all__ = ["SensorsResource", "AsyncSensorsResource"]
+
+
+class SensorsResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> SensorsResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/hiddenlayerai/hiddenlayer-sdk-python#accessing-raw-response-data-eg-headers
+        """
+        return SensorsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> SensorsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/hiddenlayerai/hiddenlayer-sdk-python#with_streaming_response
+        """
+        return SensorsResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        plaintext_name: str,
+        active: bool | Omit = omit,
+        adhoc: bool | Omit = omit,
+        tags: Dict[str, object] | Omit = omit,
+        version: int | Omit = omit,
+        x_correlation_id: str | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> SensorCreateResponse:
+        """
+        Create Sensor Record
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        extra_headers = {**strip_not_given({"X-Correlation-Id": x_correlation_id}), **(extra_headers or {})}
+        return self._post(
+            "/api/v2/sensors/create",
+            body=maybe_transform(
+                {
+                    "plaintext_name": plaintext_name,
+                    "active": active,
+                    "adhoc": adhoc,
+                    "tags": tags,
+                    "version": version,
+                },
+                sensor_create_params.SensorCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SensorCreateResponse,
+        )
+
+    def retrieve(
+        self,
+        sensor_id: str,
+        *,
+        x_correlation_id: str | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> SensorRetrieveResponse:
+        """
+        Get Sensor
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not sensor_id:
+            raise ValueError(f"Expected a non-empty value for `sensor_id` but received {sensor_id!r}")
+        extra_headers = {**strip_not_given({"X-Correlation-Id": x_correlation_id}), **(extra_headers or {})}
+        return self._get(
+            f"/api/v2/sensors/{sensor_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SensorRetrieveResponse,
+        )
+
+    def update(
+        self,
+        sensor_id: str,
+        *,
+        active: bool | Omit = omit,
+        plaintext_name: str | Omit = omit,
+        tags: Dict[str, object] | Omit = omit,
+        x_correlation_id: str | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> SensorUpdateResponse:
+        """
+        Update Sensor
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not sensor_id:
+            raise ValueError(f"Expected a non-empty value for `sensor_id` but received {sensor_id!r}")
+        extra_headers = {**strip_not_given({"X-Correlation-Id": x_correlation_id}), **(extra_headers or {})}
+        return self._put(
+            f"/api/v2/sensors/{sensor_id}",
+            body=maybe_transform(
+                {
+                    "active": active,
+                    "plaintext_name": plaintext_name,
+                    "tags": tags,
+                },
+                sensor_update_params.SensorUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SensorUpdateResponse,
+        )
+
+    def delete(
+        self,
+        sensor_id: str,
+        *,
+        x_correlation_id: str | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> None:
+        """
+        Remove an Adhoc Sensor
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not sensor_id:
+            raise ValueError(f"Expected a non-empty value for `sensor_id` but received {sensor_id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        extra_headers = {**strip_not_given({"X-Correlation-Id": x_correlation_id}), **(extra_headers or {})}
+        return self._delete(
+            f"/api/v2/sensors/{sensor_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    def query(
+        self,
+        *,
+        filter: sensor_query_params.Filter | Omit = omit,
+        order_by: str | Omit = omit,
+        order_dir: Literal["asc", "desc"] | Omit = omit,
+        page_number: int | Omit = omit,
+        page_size: int | Omit = omit,
+        x_correlation_id: str | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> SensorQueryResponse:
+        """
+        Query Sensors
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        extra_headers = {**strip_not_given({"X-Correlation-Id": x_correlation_id}), **(extra_headers or {})}
+        return self._post(
+            "/api/v2/sensors/query",
+            body=maybe_transform(
+                {
+                    "filter": filter,
+                    "order_by": order_by,
+                    "order_dir": order_dir,
+                    "page_number": page_number,
+                    "page_size": page_size,
+                },
+                sensor_query_params.SensorQueryParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SensorQueryResponse,
+        )
+
+
+class AsyncSensorsResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncSensorsResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/hiddenlayerai/hiddenlayer-sdk-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncSensorsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncSensorsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/hiddenlayerai/hiddenlayer-sdk-python#with_streaming_response
+        """
+        return AsyncSensorsResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        plaintext_name: str,
+        active: bool | Omit = omit,
+        adhoc: bool | Omit = omit,
+        tags: Dict[str, object] | Omit = omit,
+        version: int | Omit = omit,
+        x_correlation_id: str | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> SensorCreateResponse:
+        """
+        Create Sensor Record
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        extra_headers = {**strip_not_given({"X-Correlation-Id": x_correlation_id}), **(extra_headers or {})}
+        return await self._post(
+            "/api/v2/sensors/create",
+            body=await async_maybe_transform(
+                {
+                    "plaintext_name": plaintext_name,
+                    "active": active,
+                    "adhoc": adhoc,
+                    "tags": tags,
+                    "version": version,
+                },
+                sensor_create_params.SensorCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SensorCreateResponse,
+        )
+
+    async def retrieve(
+        self,
+        sensor_id: str,
+        *,
+        x_correlation_id: str | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> SensorRetrieveResponse:
+        """
+        Get Sensor
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not sensor_id:
+            raise ValueError(f"Expected a non-empty value for `sensor_id` but received {sensor_id!r}")
+        extra_headers = {**strip_not_given({"X-Correlation-Id": x_correlation_id}), **(extra_headers or {})}
+        return await self._get(
+            f"/api/v2/sensors/{sensor_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SensorRetrieveResponse,
+        )
+
+    async def update(
+        self,
+        sensor_id: str,
+        *,
+        active: bool | Omit = omit,
+        plaintext_name: str | Omit = omit,
+        tags: Dict[str, object] | Omit = omit,
+        x_correlation_id: str | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> SensorUpdateResponse:
+        """
+        Update Sensor
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not sensor_id:
+            raise ValueError(f"Expected a non-empty value for `sensor_id` but received {sensor_id!r}")
+        extra_headers = {**strip_not_given({"X-Correlation-Id": x_correlation_id}), **(extra_headers or {})}
+        return await self._put(
+            f"/api/v2/sensors/{sensor_id}",
+            body=await async_maybe_transform(
+                {
+                    "active": active,
+                    "plaintext_name": plaintext_name,
+                    "tags": tags,
+                },
+                sensor_update_params.SensorUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SensorUpdateResponse,
+        )
+
+    async def delete(
+        self,
+        sensor_id: str,
+        *,
+        x_correlation_id: str | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> None:
+        """
+        Remove an Adhoc Sensor
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not sensor_id:
+            raise ValueError(f"Expected a non-empty value for `sensor_id` but received {sensor_id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        extra_headers = {**strip_not_given({"X-Correlation-Id": x_correlation_id}), **(extra_headers or {})}
+        return await self._delete(
+            f"/api/v2/sensors/{sensor_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    async def query(
+        self,
+        *,
+        filter: sensor_query_params.Filter | Omit = omit,
+        order_by: str | Omit = omit,
+        order_dir: Literal["asc", "desc"] | Omit = omit,
+        page_number: int | Omit = omit,
+        page_size: int | Omit = omit,
+        x_correlation_id: str | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> SensorQueryResponse:
+        """
+        Query Sensors
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        extra_headers = {**strip_not_given({"X-Correlation-Id": x_correlation_id}), **(extra_headers or {})}
+        return await self._post(
+            "/api/v2/sensors/query",
+            body=await async_maybe_transform(
+                {
+                    "filter": filter,
+                    "order_by": order_by,
+                    "order_dir": order_dir,
+                    "page_number": page_number,
+                    "page_size": page_size,
+                },
+                sensor_query_params.SensorQueryParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SensorQueryResponse,
+        )
+
+
+class SensorsResourceWithRawResponse:
+    def __init__(self, sensors: SensorsResource) -> None:
+        self._sensors = sensors
+
+        self.create = to_raw_response_wrapper(
+            sensors.create,
+        )
+        self.retrieve = to_raw_response_wrapper(
+            sensors.retrieve,
+        )
+        self.update = to_raw_response_wrapper(
+            sensors.update,
+        )
+        self.delete = to_raw_response_wrapper(
+            sensors.delete,
+        )
+        self.query = to_raw_response_wrapper(
+            sensors.query,
+        )
+
+
+class AsyncSensorsResourceWithRawResponse:
+    def __init__(self, sensors: AsyncSensorsResource) -> None:
+        self._sensors = sensors
+
+        self.create = async_to_raw_response_wrapper(
+            sensors.create,
+        )
+        self.retrieve = async_to_raw_response_wrapper(
+            sensors.retrieve,
+        )
+        self.update = async_to_raw_response_wrapper(
+            sensors.update,
+        )
+        self.delete = async_to_raw_response_wrapper(
+            sensors.delete,
+        )
+        self.query = async_to_raw_response_wrapper(
+            sensors.query,
+        )
+
+
+class SensorsResourceWithStreamingResponse:
+    def __init__(self, sensors: SensorsResource) -> None:
+        self._sensors = sensors
+
+        self.create = to_streamed_response_wrapper(
+            sensors.create,
+        )
+        self.retrieve = to_streamed_response_wrapper(
+            sensors.retrieve,
+        )
+        self.update = to_streamed_response_wrapper(
+            sensors.update,
+        )
+        self.delete = to_streamed_response_wrapper(
+            sensors.delete,
+        )
+        self.query = to_streamed_response_wrapper(
+            sensors.query,
+        )
+
+
+class AsyncSensorsResourceWithStreamingResponse:
+    def __init__(self, sensors: AsyncSensorsResource) -> None:
+        self._sensors = sensors
+
+        self.create = async_to_streamed_response_wrapper(
+            sensors.create,
+        )
+        self.retrieve = async_to_streamed_response_wrapper(
+            sensors.retrieve,
+        )
+        self.update = async_to_streamed_response_wrapper(
+            sensors.update,
+        )
+        self.delete = async_to_streamed_response_wrapper(
+            sensors.delete,
+        )
+        self.query = async_to_streamed_response_wrapper(
+            sensors.query,
+        )

hiddenlayer/types/__init__.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .sensor_query_params import SensorQueryParams as SensorQueryParams
+from .sensor_create_params import SensorCreateParams as SensorCreateParams
+from .sensor_update_params import SensorUpdateParams as SensorUpdateParams
+from .sensor_query_response import SensorQueryResponse as SensorQueryResponse
+from .sensor_create_response import SensorCreateResponse as SensorCreateResponse
+from .sensor_update_response import SensorUpdateResponse as SensorUpdateResponse
+from .model_retrieve_response import ModelRetrieveResponse as ModelRetrieveResponse
+from .sensor_retrieve_response import SensorRetrieveResponse as SensorRetrieveResponse
+from .interaction_analyze_params import InteractionAnalyzeParams as InteractionAnalyzeParams
+from .interaction_analyze_response import InteractionAnalyzeResponse as InteractionAnalyzeResponse
+from .prompt_analyzer_create_params import PromptAnalyzerCreateParams as PromptAnalyzerCreateParams
+from .prompt_analyzer_create_response import PromptAnalyzerCreateResponse as PromptAnalyzerCreateResponse

hiddenlayer/types/interaction_analyze_params.py

@@ -0,0 +1,62 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Union, Iterable
+from typing_extensions import Required, Annotated, TypeAlias, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["InteractionAnalyzeParams", "Metadata", "Input", "InputMessage", "Output", "OutputMessage"]
+
+
+class InteractionAnalyzeParams(TypedDict, total=False):
+    metadata: Required[Metadata]
+
+    input: Input
+
+    output: Output
+
+    hl_project_id: Annotated[str, PropertyInfo(alias="HL-Project-Id")]
+
+    x_correlation_id: Annotated[str, PropertyInfo(alias="X-Correlation-Id")]
+
+
+class Metadata(TypedDict, total=False):
+    model: Required[str]
+    """The language model for the interactions."""
+
+    requester_id: Required[str]
+    """The identifier for the entity making the interactions."""
+
+    provider: str
+    """The provider of the language model."""
+
+
+class InputMessage(TypedDict, total=False):
+    content: Required[str]
+    """The textual content of the message."""
+
+    role: str
+    """The role of the message sender (e.g., user, assistant, system)."""
+
+
+class InputTyped(TypedDict, total=False):
+    messages: Iterable[InputMessage]
+    """The list of messages as input to a language model."""
+
+
+Input: TypeAlias = Union[InputTyped, Dict[str, object]]
+
+
+class OutputMessage(TypedDict, total=False):
+    content: Required[str]
+    """The textual content of the message."""
+
+    role: str
+    """The role of the message sender (e.g., user, assistant, system)."""
+
+
+class Output(TypedDict, total=False):
+    messages: Iterable[OutputMessage]
+    """The list of messages as output from a language model."""