aeri-python 4.0.0__py3-none-any.whl

aeri/api/legacy/observations_v1/types/__init__.py

@@ -0,0 +1,44 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .observations import Observations
+    from .observations_views import ObservationsViews
+_dynamic_imports: typing.Dict[str, str] = {
+    "Observations": ".observations",
+    "ObservationsViews": ".observations_views",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(
+            f"No {attr_name} found in _dynamic_imports for module name -> {__name__}"
+        )
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(
+            f"Failed to import {attr_name} from {module_name}: {e}"
+        ) from e
+    except AttributeError as e:
+        raise AttributeError(
+            f"Failed to get {attr_name} from {module_name}: {e}"
+        ) from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = ["Observations", "ObservationsViews"]

aeri/api/legacy/observations_v1/types/observations.py

@@ -0,0 +1,17 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....commons.types.observation import Observation
+from ....core.pydantic_utilities import UniversalBaseModel
+from ....utils.pagination.types.meta_response import MetaResponse
+
+
+class Observations(UniversalBaseModel):
+    data: typing.List[Observation]
+    meta: MetaResponse
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
+        extra="allow", frozen=True
+    )

aeri/api/legacy/observations_v1/types/observations_views.py

@@ -0,0 +1,17 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....commons.types.observations_view import ObservationsView
+from ....core.pydantic_utilities import UniversalBaseModel
+from ....utils.pagination.types.meta_response import MetaResponse
+
+
+class ObservationsViews(UniversalBaseModel):
+    data: typing.List[ObservationsView]
+    meta: MetaResponse
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
+        extra="allow", frozen=True
+    )

aeri/api/legacy/raw_client.py

@@ -0,0 +1,13 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+
+
+class RawLegacyClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+
+class AsyncRawLegacyClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper

aeri/api/legacy/score_v1/__init__.py

@@ -0,0 +1,43 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import CreateScoreRequest, CreateScoreResponse
+_dynamic_imports: typing.Dict[str, str] = {
+    "CreateScoreRequest": ".types",
+    "CreateScoreResponse": ".types",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(
+            f"No {attr_name} found in _dynamic_imports for module name -> {__name__}"
+        )
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(
+            f"Failed to import {attr_name} from {module_name}: {e}"
+        ) from e
+    except AttributeError as e:
+        raise AttributeError(
+            f"Failed to get {attr_name} from {module_name}: {e}"
+        ) from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = ["CreateScoreRequest", "CreateScoreResponse"]

aeri/api/legacy/score_v1/client.py

@@ -0,0 +1,329 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ...commons.types.create_score_value import CreateScoreValue
+from ...commons.types.score_data_type import ScoreDataType
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
+from .raw_client import AsyncRawScoreV1Client, RawScoreV1Client
+from .types.create_score_response import CreateScoreResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class ScoreV1Client:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawScoreV1Client(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawScoreV1Client:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawScoreV1Client
+        """
+        return self._raw_client
+
+    def create(
+        self,
+        *,
+        name: str,
+        value: CreateScoreValue,
+        id: typing.Optional[str] = OMIT,
+        trace_id: typing.Optional[str] = OMIT,
+        session_id: typing.Optional[str] = OMIT,
+        observation_id: typing.Optional[str] = OMIT,
+        dataset_run_id: typing.Optional[str] = OMIT,
+        comment: typing.Optional[str] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        environment: typing.Optional[str] = OMIT,
+        queue_id: typing.Optional[str] = OMIT,
+        data_type: typing.Optional[ScoreDataType] = OMIT,
+        config_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateScoreResponse:
+        """
+        Create a score (supports both trace and session scores)
+
+        Parameters
+        ----------
+        name : str
+
+        value : CreateScoreValue
+            The value of the score. Must be passed as string for categorical scores, and numeric for boolean and numeric scores. Boolean score values must equal either 1 or 0 (true or false)
+
+        id : typing.Optional[str]
+
+        trace_id : typing.Optional[str]
+
+        session_id : typing.Optional[str]
+
+        observation_id : typing.Optional[str]
+
+        dataset_run_id : typing.Optional[str]
+
+        comment : typing.Optional[str]
+
+        metadata : typing.Optional[typing.Dict[str, typing.Any]]
+
+        environment : typing.Optional[str]
+            The environment of the score. Can be any lowercase alphanumeric string with hyphens and underscores that does not start with 'aeri'.
+
+        queue_id : typing.Optional[str]
+            The annotation queue referenced by the score. Indicates if score was initially created while processing annotation queue.
+
+        data_type : typing.Optional[ScoreDataType]
+            The data type of the score. When passing a configId this field is inferred. Otherwise, this field must be passed or will default to numeric.
+
+        config_id : typing.Optional[str]
+            Reference a score config on a score. The unique aeri identifier of a score config. When passing this field, the dataType and stringValue fields are automatically populated.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateScoreResponse
+
+        Examples
+        --------
+        from aeri import AeriAPI
+
+        client = AeriAPI(
+            x_aeri_sdk_name="YOUR_X_AERI_SDK_NAME",
+            x_aeri_sdk_version="YOUR_X_AERI_SDK_VERSION",
+            x_aeri_public_key="YOUR_X_AERI_PUBLIC_KEY",
+            username="YOUR_USERNAME",
+            password="YOUR_PASSWORD",
+            base_url="https://yourhost.com/path/to/api",
+        )
+        client.legacy.score_v1.create(
+            name="name",
+            value=1.1,
+        )
+        """
+        _response = self._raw_client.create(
+            name=name,
+            value=value,
+            id=id,
+            trace_id=trace_id,
+            session_id=session_id,
+            observation_id=observation_id,
+            dataset_run_id=dataset_run_id,
+            comment=comment,
+            metadata=metadata,
+            environment=environment,
+            queue_id=queue_id,
+            data_type=data_type,
+            config_id=config_id,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def delete(
+        self, score_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Delete a score (supports both trace and session scores)
+
+        Parameters
+        ----------
+        score_id : str
+            The unique aeri identifier of a score
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from aeri import AeriAPI
+
+        client = AeriAPI(
+            x_aeri_sdk_name="YOUR_X_AERI_SDK_NAME",
+            x_aeri_sdk_version="YOUR_X_AERI_SDK_VERSION",
+            x_aeri_public_key="YOUR_X_AERI_PUBLIC_KEY",
+            username="YOUR_USERNAME",
+            password="YOUR_PASSWORD",
+            base_url="https://yourhost.com/path/to/api",
+        )
+        client.legacy.score_v1.delete(
+            score_id="scoreId",
+        )
+        """
+        _response = self._raw_client.delete(score_id, request_options=request_options)
+        return _response.data
+
+
+class AsyncScoreV1Client:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawScoreV1Client(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawScoreV1Client:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawScoreV1Client
+        """
+        return self._raw_client
+
+    async def create(
+        self,
+        *,
+        name: str,
+        value: CreateScoreValue,
+        id: typing.Optional[str] = OMIT,
+        trace_id: typing.Optional[str] = OMIT,
+        session_id: typing.Optional[str] = OMIT,
+        observation_id: typing.Optional[str] = OMIT,
+        dataset_run_id: typing.Optional[str] = OMIT,
+        comment: typing.Optional[str] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        environment: typing.Optional[str] = OMIT,
+        queue_id: typing.Optional[str] = OMIT,
+        data_type: typing.Optional[ScoreDataType] = OMIT,
+        config_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateScoreResponse:
+        """
+        Create a score (supports both trace and session scores)
+
+        Parameters
+        ----------
+        name : str
+
+        value : CreateScoreValue
+            The value of the score. Must be passed as string for categorical scores, and numeric for boolean and numeric scores. Boolean score values must equal either 1 or 0 (true or false)
+
+        id : typing.Optional[str]
+
+        trace_id : typing.Optional[str]
+
+        session_id : typing.Optional[str]
+
+        observation_id : typing.Optional[str]
+
+        dataset_run_id : typing.Optional[str]
+
+        comment : typing.Optional[str]
+
+        metadata : typing.Optional[typing.Dict[str, typing.Any]]
+
+        environment : typing.Optional[str]
+            The environment of the score. Can be any lowercase alphanumeric string with hyphens and underscores that does not start with 'aeri'.
+
+        queue_id : typing.Optional[str]
+            The annotation queue referenced by the score. Indicates if score was initially created while processing annotation queue.
+
+        data_type : typing.Optional[ScoreDataType]
+            The data type of the score. When passing a configId this field is inferred. Otherwise, this field must be passed or will default to numeric.
+
+        config_id : typing.Optional[str]
+            Reference a score config on a score. The unique aeri identifier of a score config. When passing this field, the dataType and stringValue fields are automatically populated.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateScoreResponse
+
+        Examples
+        --------
+        import asyncio
+
+        from aeri import AsyncAeriAPI
+
+        client = AsyncAeriAPI(
+            x_aeri_sdk_name="YOUR_X_AERI_SDK_NAME",
+            x_aeri_sdk_version="YOUR_X_AERI_SDK_VERSION",
+            x_aeri_public_key="YOUR_X_AERI_PUBLIC_KEY",
+            username="YOUR_USERNAME",
+            password="YOUR_PASSWORD",
+            base_url="https://yourhost.com/path/to/api",
+        )
+
+
+        async def main() -> None:
+            await client.legacy.score_v1.create(
+                name="name",
+                value=1.1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(
+            name=name,
+            value=value,
+            id=id,
+            trace_id=trace_id,
+            session_id=session_id,
+            observation_id=observation_id,
+            dataset_run_id=dataset_run_id,
+            comment=comment,
+            metadata=metadata,
+            environment=environment,
+            queue_id=queue_id,
+            data_type=data_type,
+            config_id=config_id,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def delete(
+        self, score_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Delete a score (supports both trace and session scores)
+
+        Parameters
+        ----------
+        score_id : str
+            The unique aeri identifier of a score
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from aeri import AsyncAeriAPI
+
+        client = AsyncAeriAPI(
+            x_aeri_sdk_name="YOUR_X_AERI_SDK_NAME",
+            x_aeri_sdk_version="YOUR_X_AERI_SDK_VERSION",
+            x_aeri_public_key="YOUR_X_AERI_PUBLIC_KEY",
+            username="YOUR_USERNAME",
+            password="YOUR_PASSWORD",
+            base_url="https://yourhost.com/path/to/api",
+        )
+
+
+        async def main() -> None:
+            await client.legacy.score_v1.delete(
+                score_id="scoreId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete(
+            score_id, request_options=request_options
+        )
+        return _response.data