aeri-python 4.0.0__py3-none-any.whl

aeri/api/score_configs/types/__init__.py

@@ -0,0 +1,46 @@
+# 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 .create_score_config_request import CreateScoreConfigRequest
+    from .score_configs import ScoreConfigs
+    from .update_score_config_request import UpdateScoreConfigRequest
+_dynamic_imports: typing.Dict[str, str] = {
+    "CreateScoreConfigRequest": ".create_score_config_request",
+    "ScoreConfigs": ".score_configs",
+    "UpdateScoreConfigRequest": ".update_score_config_request",
+}
+
+
+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__ = ["CreateScoreConfigRequest", "ScoreConfigs", "UpdateScoreConfigRequest"]

aeri/api/score_configs/types/create_score_config_request.py

@@ -0,0 +1,46 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...commons.types.config_category import ConfigCategory
+from ...commons.types.score_config_data_type import ScoreConfigDataType
+from ...core.pydantic_utilities import UniversalBaseModel
+from ...core.serialization import FieldMetadata
+
+
+class CreateScoreConfigRequest(UniversalBaseModel):
+    name: str
+    data_type: typing_extensions.Annotated[
+        ScoreConfigDataType, FieldMetadata(alias="dataType")
+    ]
+    categories: typing.Optional[typing.List[ConfigCategory]] = pydantic.Field(
+        default=None
+    )
+    """
+    Configure custom categories for categorical scores. Pass a list of objects with `label` and `value` properties. Categories are autogenerated for boolean configs and cannot be passed
+    """
+
+    min_value: typing_extensions.Annotated[
+        typing.Optional[float], FieldMetadata(alias="minValue")
+    ] = pydantic.Field(default=None)
+    """
+    Configure a minimum value for numerical scores. If not set, the minimum value defaults to -∞
+    """
+
+    max_value: typing_extensions.Annotated[
+        typing.Optional[float], FieldMetadata(alias="maxValue")
+    ] = pydantic.Field(default=None)
+    """
+    Configure a maximum value for numerical scores. If not set, the maximum value defaults to +∞
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Description is shown across the Aeri UI and can be used to e.g. explain the config categories in detail, why a numeric range was set, or provide additional context on config name or usage
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
+        extra="allow", frozen=True
+    )

aeri/api/score_configs/types/score_configs.py

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

aeri/api/score_configs/types/update_score_config_request.py

@@ -0,0 +1,53 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...commons.types.config_category import ConfigCategory
+from ...core.pydantic_utilities import UniversalBaseModel
+from ...core.serialization import FieldMetadata
+
+
+class UpdateScoreConfigRequest(UniversalBaseModel):
+    is_archived: typing_extensions.Annotated[
+        typing.Optional[bool], FieldMetadata(alias="isArchived")
+    ] = pydantic.Field(default=None)
+    """
+    The status of the score config showing if it is archived or not
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The name of the score config
+    """
+
+    categories: typing.Optional[typing.List[ConfigCategory]] = pydantic.Field(
+        default=None
+    )
+    """
+    Configure custom categories for categorical scores. Pass a list of objects with `label` and `value` properties. Categories are autogenerated for boolean configs and cannot be passed
+    """
+
+    min_value: typing_extensions.Annotated[
+        typing.Optional[float], FieldMetadata(alias="minValue")
+    ] = pydantic.Field(default=None)
+    """
+    Configure a minimum value for numerical scores. If not set, the minimum value defaults to -∞
+    """
+
+    max_value: typing_extensions.Annotated[
+        typing.Optional[float], FieldMetadata(alias="maxValue")
+    ] = pydantic.Field(default=None)
+    """
+    Configure a maximum value for numerical scores. If not set, the maximum value defaults to +∞
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Description is shown across the Aeri UI and can be used to e.g. explain the config categories in detail, why a numeric range was set, or provide additional context on config name or usage
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
+        extra="allow", frozen=True
+    )

aeri/api/scores/__init__.py

@@ -0,0 +1,76 @@
+# 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 (
+        GetScoresResponse,
+        GetScoresResponseData,
+        GetScoresResponseDataBoolean,
+        GetScoresResponseDataCategorical,
+        GetScoresResponseDataCorrection,
+        GetScoresResponseDataNumeric,
+        GetScoresResponseData_Boolean,
+        GetScoresResponseData_Categorical,
+        GetScoresResponseData_Correction,
+        GetScoresResponseData_Numeric,
+        GetScoresResponseTraceData,
+    )
+_dynamic_imports: typing.Dict[str, str] = {
+    "GetScoresResponse": ".types",
+    "GetScoresResponseData": ".types",
+    "GetScoresResponseDataBoolean": ".types",
+    "GetScoresResponseDataCategorical": ".types",
+    "GetScoresResponseDataCorrection": ".types",
+    "GetScoresResponseDataNumeric": ".types",
+    "GetScoresResponseData_Boolean": ".types",
+    "GetScoresResponseData_Categorical": ".types",
+    "GetScoresResponseData_Correction": ".types",
+    "GetScoresResponseData_Numeric": ".types",
+    "GetScoresResponseTraceData": ".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__ = [
+    "GetScoresResponse",
+    "GetScoresResponseData",
+    "GetScoresResponseDataBoolean",
+    "GetScoresResponseDataCategorical",
+    "GetScoresResponseDataCorrection",
+    "GetScoresResponseDataNumeric",
+    "GetScoresResponseData_Boolean",
+    "GetScoresResponseData_Categorical",
+    "GetScoresResponseData_Correction",
+    "GetScoresResponseData_Numeric",
+    "GetScoresResponseTraceData",
+]

aeri/api/scores/client.py

@@ -0,0 +1,420 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..commons.types.score import Score
+from ..commons.types.score_data_type import ScoreDataType
+from ..commons.types.score_source import ScoreSource
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from .raw_client import AsyncRawScoresClient, RawScoresClient
+from .types.get_scores_response import GetScoresResponse
+
+
+class ScoresClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawScoresClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawScoresClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawScoresClient
+        """
+        return self._raw_client
+
+    def get_many(
+        self,
+        *,
+        page: typing.Optional[int] = None,
+        limit: typing.Optional[int] = None,
+        user_id: typing.Optional[str] = None,
+        name: typing.Optional[str] = None,
+        from_timestamp: typing.Optional[dt.datetime] = None,
+        to_timestamp: typing.Optional[dt.datetime] = None,
+        environment: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        source: typing.Optional[ScoreSource] = None,
+        operator: typing.Optional[str] = None,
+        value: typing.Optional[float] = None,
+        score_ids: typing.Optional[str] = None,
+        config_id: typing.Optional[str] = None,
+        session_id: typing.Optional[str] = None,
+        dataset_run_id: typing.Optional[str] = None,
+        trace_id: typing.Optional[str] = None,
+        observation_id: typing.Optional[str] = None,
+        queue_id: typing.Optional[str] = None,
+        data_type: typing.Optional[ScoreDataType] = None,
+        trace_tags: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        fields: typing.Optional[str] = None,
+        filter: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetScoresResponse:
+        """
+        Get a list of scores (supports both trace and session scores)
+
+        Parameters
+        ----------
+        page : typing.Optional[int]
+            Page number, starts at 1.
+
+        limit : typing.Optional[int]
+            Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit.
+
+        user_id : typing.Optional[str]
+            Retrieve only scores with this userId associated to the trace.
+
+        name : typing.Optional[str]
+            Retrieve only scores with this name.
+
+        from_timestamp : typing.Optional[dt.datetime]
+            Optional filter to only include scores created on or after a certain datetime (ISO 8601)
+
+        to_timestamp : typing.Optional[dt.datetime]
+            Optional filter to only include scores created before a certain datetime (ISO 8601)
+
+        environment : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Optional filter for scores where the environment is one of the provided values.
+
+        source : typing.Optional[ScoreSource]
+            Retrieve only scores from a specific source.
+
+        operator : typing.Optional[str]
+            Retrieve only scores with <operator> value.
+
+        value : typing.Optional[float]
+            Retrieve only scores with <operator> value.
+
+        score_ids : typing.Optional[str]
+            Comma-separated list of score IDs to limit the results to.
+
+        config_id : typing.Optional[str]
+            Retrieve only scores with a specific configId.
+
+        session_id : typing.Optional[str]
+            Retrieve only scores with a specific sessionId.
+
+        dataset_run_id : typing.Optional[str]
+            Retrieve only scores with a specific datasetRunId.
+
+        trace_id : typing.Optional[str]
+            Retrieve only scores with a specific traceId.
+
+        observation_id : typing.Optional[str]
+            Comma-separated list of observation IDs to filter scores by.
+
+        queue_id : typing.Optional[str]
+            Retrieve only scores with a specific annotation queueId.
+
+        data_type : typing.Optional[ScoreDataType]
+            Retrieve only scores with a specific dataType.
+
+        trace_tags : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Only scores linked to traces that include all of these tags will be returned.
+
+        fields : typing.Optional[str]
+            Comma-separated list of field groups to include in the response. Available field groups: 'score' (core score fields), 'trace' (trace properties: userId, tags, environment, sessionId). If not specified, both 'score' and 'trace' are returned by default. Example: 'score' to exclude trace data, 'score,trace' to include both. Note: When filtering by trace properties (using userId or traceTags parameters), the 'trace' field group must be included, otherwise a 400 error will be returned.
+
+        filter : typing.Optional[str]
+            A JSON stringified array of filter objects. Each object requires type, column, operator, and value. Supports filtering by score metadata using the stringObject type. Example: [{"type":"stringObject","column":"metadata","key":"user_id","operator":"=","value":"abc123"}]. Supported types: stringObject (metadata key-value filtering), string, number, datetime, stringOptions, arrayOptions. Supported operators for stringObject: =, contains, does not contain, starts with, ends with.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetScoresResponse
+
+        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.scores.get_many()
+        """
+        _response = self._raw_client.get_many(
+            page=page,
+            limit=limit,
+            user_id=user_id,
+            name=name,
+            from_timestamp=from_timestamp,
+            to_timestamp=to_timestamp,
+            environment=environment,
+            source=source,
+            operator=operator,
+            value=value,
+            score_ids=score_ids,
+            config_id=config_id,
+            session_id=session_id,
+            dataset_run_id=dataset_run_id,
+            trace_id=trace_id,
+            observation_id=observation_id,
+            queue_id=queue_id,
+            data_type=data_type,
+            trace_tags=trace_tags,
+            fields=fields,
+            filter=filter,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get_by_id(
+        self, score_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> Score:
+        """
+        Get 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
+        -------
+        Score
+
+        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.scores.get_by_id(
+            score_id="scoreId",
+        )
+        """
+        _response = self._raw_client.get_by_id(
+            score_id, request_options=request_options
+        )
+        return _response.data
+
+
+class AsyncScoresClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawScoresClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawScoresClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawScoresClient
+        """
+        return self._raw_client
+
+    async def get_many(
+        self,
+        *,
+        page: typing.Optional[int] = None,
+        limit: typing.Optional[int] = None,
+        user_id: typing.Optional[str] = None,
+        name: typing.Optional[str] = None,
+        from_timestamp: typing.Optional[dt.datetime] = None,
+        to_timestamp: typing.Optional[dt.datetime] = None,
+        environment: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        source: typing.Optional[ScoreSource] = None,
+        operator: typing.Optional[str] = None,
+        value: typing.Optional[float] = None,
+        score_ids: typing.Optional[str] = None,
+        config_id: typing.Optional[str] = None,
+        session_id: typing.Optional[str] = None,
+        dataset_run_id: typing.Optional[str] = None,
+        trace_id: typing.Optional[str] = None,
+        observation_id: typing.Optional[str] = None,
+        queue_id: typing.Optional[str] = None,
+        data_type: typing.Optional[ScoreDataType] = None,
+        trace_tags: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        fields: typing.Optional[str] = None,
+        filter: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetScoresResponse:
+        """
+        Get a list of scores (supports both trace and session scores)
+
+        Parameters
+        ----------
+        page : typing.Optional[int]
+            Page number, starts at 1.
+
+        limit : typing.Optional[int]
+            Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit.
+
+        user_id : typing.Optional[str]
+            Retrieve only scores with this userId associated to the trace.
+
+        name : typing.Optional[str]
+            Retrieve only scores with this name.
+
+        from_timestamp : typing.Optional[dt.datetime]
+            Optional filter to only include scores created on or after a certain datetime (ISO 8601)
+
+        to_timestamp : typing.Optional[dt.datetime]
+            Optional filter to only include scores created before a certain datetime (ISO 8601)
+
+        environment : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Optional filter for scores where the environment is one of the provided values.
+
+        source : typing.Optional[ScoreSource]
+            Retrieve only scores from a specific source.
+
+        operator : typing.Optional[str]
+            Retrieve only scores with <operator> value.
+
+        value : typing.Optional[float]
+            Retrieve only scores with <operator> value.
+
+        score_ids : typing.Optional[str]
+            Comma-separated list of score IDs to limit the results to.
+
+        config_id : typing.Optional[str]
+            Retrieve only scores with a specific configId.
+
+        session_id : typing.Optional[str]
+            Retrieve only scores with a specific sessionId.
+
+        dataset_run_id : typing.Optional[str]
+            Retrieve only scores with a specific datasetRunId.
+
+        trace_id : typing.Optional[str]
+            Retrieve only scores with a specific traceId.
+
+        observation_id : typing.Optional[str]
+            Comma-separated list of observation IDs to filter scores by.
+
+        queue_id : typing.Optional[str]
+            Retrieve only scores with a specific annotation queueId.
+
+        data_type : typing.Optional[ScoreDataType]
+            Retrieve only scores with a specific dataType.
+
+        trace_tags : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Only scores linked to traces that include all of these tags will be returned.
+
+        fields : typing.Optional[str]
+            Comma-separated list of field groups to include in the response. Available field groups: 'score' (core score fields), 'trace' (trace properties: userId, tags, environment, sessionId). If not specified, both 'score' and 'trace' are returned by default. Example: 'score' to exclude trace data, 'score,trace' to include both. Note: When filtering by trace properties (using userId or traceTags parameters), the 'trace' field group must be included, otherwise a 400 error will be returned.
+
+        filter : typing.Optional[str]
+            A JSON stringified array of filter objects. Each object requires type, column, operator, and value. Supports filtering by score metadata using the stringObject type. Example: [{"type":"stringObject","column":"metadata","key":"user_id","operator":"=","value":"abc123"}]. Supported types: stringObject (metadata key-value filtering), string, number, datetime, stringOptions, arrayOptions. Supported operators for stringObject: =, contains, does not contain, starts with, ends with.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetScoresResponse
+
+        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.scores.get_many()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_many(
+            page=page,
+            limit=limit,
+            user_id=user_id,
+            name=name,
+            from_timestamp=from_timestamp,
+            to_timestamp=to_timestamp,
+            environment=environment,
+            source=source,
+            operator=operator,
+            value=value,
+            score_ids=score_ids,
+            config_id=config_id,
+            session_id=session_id,
+            dataset_run_id=dataset_run_id,
+            trace_id=trace_id,
+            observation_id=observation_id,
+            queue_id=queue_id,
+            data_type=data_type,
+            trace_tags=trace_tags,
+            fields=fields,
+            filter=filter,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get_by_id(
+        self, score_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> Score:
+        """
+        Get 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
+        -------
+        Score
+
+        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.scores.get_by_id(
+                score_id="scoreId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_by_id(
+            score_id, request_options=request_options
+        )
+        return _response.data