aeri-python 4.0.0__py3-none-any.whl

aeri/api/legacy/observations_v1/client.py

@@ -0,0 +1,523 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ...commons.types.observation_level import ObservationLevel
+from ...commons.types.observations_view import ObservationsView
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
+from .raw_client import AsyncRawObservationsV1Client, RawObservationsV1Client
+from .types.observations_views import ObservationsViews
+
+
+class ObservationsV1Client:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawObservationsV1Client(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawObservationsV1Client:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawObservationsV1Client
+        """
+        return self._raw_client
+
+    def get(
+        self,
+        observation_id: str,
+        *,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ObservationsView:
+        """
+        Get a observation
+
+        Parameters
+        ----------
+        observation_id : str
+            The unique aeri identifier of an observation, can be an event, span or generation
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ObservationsView
+
+        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.observations_v1.get(
+            observation_id="observationId",
+        )
+        """
+        _response = self._raw_client.get(
+            observation_id, request_options=request_options
+        )
+        return _response.data
+
+    def get_many(
+        self,
+        *,
+        page: typing.Optional[int] = None,
+        limit: typing.Optional[int] = None,
+        name: typing.Optional[str] = None,
+        user_id: typing.Optional[str] = None,
+        type: typing.Optional[str] = None,
+        trace_id: typing.Optional[str] = None,
+        level: typing.Optional[ObservationLevel] = None,
+        parent_observation_id: typing.Optional[str] = None,
+        environment: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        from_start_time: typing.Optional[dt.datetime] = None,
+        to_start_time: typing.Optional[dt.datetime] = None,
+        version: typing.Optional[str] = None,
+        filter: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ObservationsViews:
+        """
+        Get a list of observations.
+
+        Consider using the [v2 observations endpoint](/api-reference#tag/observationsv2/GET/api/public/v2/observations) for cursor-based pagination and field selection.
+
+        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.
+
+        name : typing.Optional[str]
+
+        user_id : typing.Optional[str]
+
+        type : typing.Optional[str]
+
+        trace_id : typing.Optional[str]
+
+        level : typing.Optional[ObservationLevel]
+            Optional filter for observations with a specific level (e.g. "DEBUG", "DEFAULT", "WARNING", "ERROR").
+
+        parent_observation_id : typing.Optional[str]
+
+        environment : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Optional filter for observations where the environment is one of the provided values.
+
+        from_start_time : typing.Optional[dt.datetime]
+            Retrieve only observations with a start_time on or after this datetime (ISO 8601).
+
+        to_start_time : typing.Optional[dt.datetime]
+            Retrieve only observations with a start_time before this datetime (ISO 8601).
+
+        version : typing.Optional[str]
+            Optional filter to only include observations with a certain version.
+
+        filter : typing.Optional[str]
+            JSON string containing an array of filter conditions. When provided, this takes precedence over query parameter filters (userId, name, type, level, environment, fromStartTime, ...).
+
+            ## Filter Structure
+            Each filter condition has the following structure:
+            ```json
+            [
+              {
+                "type": string,           // Required. One of: "datetime", "string", "number", "stringOptions", "categoryOptions", "arrayOptions", "stringObject", "numberObject", "boolean", "null"
+                "column": string,         // Required. Column to filter on (see available columns below)
+                "operator": string,       // Required. Operator based on type:
+                                          // - datetime: ">", "<", ">=", "<="
+                                          // - string: "=", "contains", "does not contain", "starts with", "ends with"
+                                          // - stringOptions: "any of", "none of"
+                                          // - categoryOptions: "any of", "none of"
+                                          // - arrayOptions: "any of", "none of", "all of"
+                                          // - number: "=", ">", "<", ">=", "<="
+                                          // - stringObject: "=", "contains", "does not contain", "starts with", "ends with"
+                                          // - numberObject: "=", ">", "<", ">=", "<="
+                                          // - boolean: "=", "<>"
+                                          // - null: "is null", "is not null"
+                "value": any,             // Required (except for null type). Value to compare against. Type depends on filter type
+                "key": string             // Required only for stringObject, numberObject, and categoryOptions types when filtering on nested fields like metadata
+              }
+            ]
+            ```
+
+            ## Available Columns
+
+            ### Core Observation Fields
+            - `id` (string) - Observation ID
+            - `type` (string) - Observation type (SPAN, GENERATION, EVENT)
+            - `name` (string) - Observation name
+            - `traceId` (string) - Associated trace ID
+            - `startTime` (datetime) - Observation start time
+            - `endTime` (datetime) - Observation end time
+            - `environment` (string) - Environment tag
+            - `level` (string) - Log level (DEBUG, DEFAULT, WARNING, ERROR)
+            - `statusMessage` (string) - Status message
+            - `version` (string) - Version tag
+
+            ### Performance Metrics
+            - `latency` (number) - Latency in seconds (calculated: end_time - start_time)
+            - `timeToFirstToken` (number) - Time to first token in seconds
+            - `tokensPerSecond` (number) - Output tokens per second
+
+            ### Token Usage
+            - `inputTokens` (number) - Number of input tokens
+            - `outputTokens` (number) - Number of output tokens
+            - `totalTokens` (number) - Total tokens (alias: `tokens`)
+
+            ### Cost Metrics
+            - `inputCost` (number) - Input cost in USD
+            - `outputCost` (number) - Output cost in USD
+            - `totalCost` (number) - Total cost in USD
+
+            ### Model Information
+            - `model` (string) - Provided model name
+            - `promptName` (string) - Associated prompt name
+            - `promptVersion` (number) - Associated prompt version
+
+            ### Structured Data
+            - `metadata` (stringObject/numberObject/categoryOptions) - Metadata key-value pairs. Use `key` parameter to filter on specific metadata keys.
+
+            ### Associated Trace Fields (requires join with traces table)
+            - `userId` (string) - User ID from associated trace
+            - `traceName` (string) - Name from associated trace
+            - `traceEnvironment` (string) - Environment from associated trace
+            - `traceTags` (arrayOptions) - Tags from associated trace
+
+            ## Filter Examples
+            ```json
+            [
+              {
+                "type": "string",
+                "column": "type",
+                "operator": "=",
+                "value": "GENERATION"
+              },
+              {
+                "type": "number",
+                "column": "latency",
+                "operator": ">=",
+                "value": 2.5
+              },
+              {
+                "type": "stringObject",
+                "column": "metadata",
+                "key": "environment",
+                "operator": "=",
+                "value": "production"
+              }
+            ]
+            ```
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ObservationsViews
+
+        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.observations_v1.get_many()
+        """
+        _response = self._raw_client.get_many(
+            page=page,
+            limit=limit,
+            name=name,
+            user_id=user_id,
+            type=type,
+            trace_id=trace_id,
+            level=level,
+            parent_observation_id=parent_observation_id,
+            environment=environment,
+            from_start_time=from_start_time,
+            to_start_time=to_start_time,
+            version=version,
+            filter=filter,
+            request_options=request_options,
+        )
+        return _response.data
+
+
+class AsyncObservationsV1Client:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawObservationsV1Client(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawObservationsV1Client:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawObservationsV1Client
+        """
+        return self._raw_client
+
+    async def get(
+        self,
+        observation_id: str,
+        *,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ObservationsView:
+        """
+        Get a observation
+
+        Parameters
+        ----------
+        observation_id : str
+            The unique aeri identifier of an observation, can be an event, span or generation
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ObservationsView
+
+        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.observations_v1.get(
+                observation_id="observationId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get(
+            observation_id, request_options=request_options
+        )
+        return _response.data
+
+    async def get_many(
+        self,
+        *,
+        page: typing.Optional[int] = None,
+        limit: typing.Optional[int] = None,
+        name: typing.Optional[str] = None,
+        user_id: typing.Optional[str] = None,
+        type: typing.Optional[str] = None,
+        trace_id: typing.Optional[str] = None,
+        level: typing.Optional[ObservationLevel] = None,
+        parent_observation_id: typing.Optional[str] = None,
+        environment: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        from_start_time: typing.Optional[dt.datetime] = None,
+        to_start_time: typing.Optional[dt.datetime] = None,
+        version: typing.Optional[str] = None,
+        filter: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ObservationsViews:
+        """
+        Get a list of observations.
+
+        Consider using the [v2 observations endpoint](/api-reference#tag/observationsv2/GET/api/public/v2/observations) for cursor-based pagination and field selection.
+
+        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.
+
+        name : typing.Optional[str]
+
+        user_id : typing.Optional[str]
+
+        type : typing.Optional[str]
+
+        trace_id : typing.Optional[str]
+
+        level : typing.Optional[ObservationLevel]
+            Optional filter for observations with a specific level (e.g. "DEBUG", "DEFAULT", "WARNING", "ERROR").
+
+        parent_observation_id : typing.Optional[str]
+
+        environment : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Optional filter for observations where the environment is one of the provided values.
+
+        from_start_time : typing.Optional[dt.datetime]
+            Retrieve only observations with a start_time on or after this datetime (ISO 8601).
+
+        to_start_time : typing.Optional[dt.datetime]
+            Retrieve only observations with a start_time before this datetime (ISO 8601).
+
+        version : typing.Optional[str]
+            Optional filter to only include observations with a certain version.
+
+        filter : typing.Optional[str]
+            JSON string containing an array of filter conditions. When provided, this takes precedence over query parameter filters (userId, name, type, level, environment, fromStartTime, ...).
+
+            ## Filter Structure
+            Each filter condition has the following structure:
+            ```json
+            [
+              {
+                "type": string,           // Required. One of: "datetime", "string", "number", "stringOptions", "categoryOptions", "arrayOptions", "stringObject", "numberObject", "boolean", "null"
+                "column": string,         // Required. Column to filter on (see available columns below)
+                "operator": string,       // Required. Operator based on type:
+                                          // - datetime: ">", "<", ">=", "<="
+                                          // - string: "=", "contains", "does not contain", "starts with", "ends with"
+                                          // - stringOptions: "any of", "none of"
+                                          // - categoryOptions: "any of", "none of"
+                                          // - arrayOptions: "any of", "none of", "all of"
+                                          // - number: "=", ">", "<", ">=", "<="
+                                          // - stringObject: "=", "contains", "does not contain", "starts with", "ends with"
+                                          // - numberObject: "=", ">", "<", ">=", "<="
+                                          // - boolean: "=", "<>"
+                                          // - null: "is null", "is not null"
+                "value": any,             // Required (except for null type). Value to compare against. Type depends on filter type
+                "key": string             // Required only for stringObject, numberObject, and categoryOptions types when filtering on nested fields like metadata
+              }
+            ]
+            ```
+
+            ## Available Columns
+
+            ### Core Observation Fields
+            - `id` (string) - Observation ID
+            - `type` (string) - Observation type (SPAN, GENERATION, EVENT)
+            - `name` (string) - Observation name
+            - `traceId` (string) - Associated trace ID
+            - `startTime` (datetime) - Observation start time
+            - `endTime` (datetime) - Observation end time
+            - `environment` (string) - Environment tag
+            - `level` (string) - Log level (DEBUG, DEFAULT, WARNING, ERROR)
+            - `statusMessage` (string) - Status message
+            - `version` (string) - Version tag
+
+            ### Performance Metrics
+            - `latency` (number) - Latency in seconds (calculated: end_time - start_time)
+            - `timeToFirstToken` (number) - Time to first token in seconds
+            - `tokensPerSecond` (number) - Output tokens per second
+
+            ### Token Usage
+            - `inputTokens` (number) - Number of input tokens
+            - `outputTokens` (number) - Number of output tokens
+            - `totalTokens` (number) - Total tokens (alias: `tokens`)
+
+            ### Cost Metrics
+            - `inputCost` (number) - Input cost in USD
+            - `outputCost` (number) - Output cost in USD
+            - `totalCost` (number) - Total cost in USD
+
+            ### Model Information
+            - `model` (string) - Provided model name
+            - `promptName` (string) - Associated prompt name
+            - `promptVersion` (number) - Associated prompt version
+
+            ### Structured Data
+            - `metadata` (stringObject/numberObject/categoryOptions) - Metadata key-value pairs. Use `key` parameter to filter on specific metadata keys.
+
+            ### Associated Trace Fields (requires join with traces table)
+            - `userId` (string) - User ID from associated trace
+            - `traceName` (string) - Name from associated trace
+            - `traceEnvironment` (string) - Environment from associated trace
+            - `traceTags` (arrayOptions) - Tags from associated trace
+
+            ## Filter Examples
+            ```json
+            [
+              {
+                "type": "string",
+                "column": "type",
+                "operator": "=",
+                "value": "GENERATION"
+              },
+              {
+                "type": "number",
+                "column": "latency",
+                "operator": ">=",
+                "value": 2.5
+              },
+              {
+                "type": "stringObject",
+                "column": "metadata",
+                "key": "environment",
+                "operator": "=",
+                "value": "production"
+              }
+            ]
+            ```
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ObservationsViews
+
+        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.observations_v1.get_many()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_many(
+            page=page,
+            limit=limit,
+            name=name,
+            user_id=user_id,
+            type=type,
+            trace_id=trace_id,
+            level=level,
+            parent_observation_id=parent_observation_id,
+            environment=environment,
+            from_start_time=from_start_time,
+            to_start_time=to_start_time,
+            version=version,
+            filter=filter,
+            request_options=request_options,
+        )
+        return _response.data