aeri-python 4.0.0__py3-none-any.whl

aeri/api/ingestion/__init__.py

@@ -0,0 +1,169 @@
+# 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 (
+        BaseEvent,
+        CreateEventBody,
+        CreateEventEvent,
+        CreateGenerationBody,
+        CreateGenerationEvent,
+        CreateObservationEvent,
+        CreateSpanBody,
+        CreateSpanEvent,
+        IngestionError,
+        IngestionEvent,
+        IngestionEvent_EventCreate,
+        IngestionEvent_GenerationCreate,
+        IngestionEvent_GenerationUpdate,
+        IngestionEvent_ObservationCreate,
+        IngestionEvent_ObservationUpdate,
+        IngestionEvent_ScoreCreate,
+        IngestionEvent_SdkLog,
+        IngestionEvent_SpanCreate,
+        IngestionEvent_SpanUpdate,
+        IngestionEvent_TraceCreate,
+        IngestionResponse,
+        IngestionSuccess,
+        IngestionUsage,
+        ObservationBody,
+        ObservationType,
+        OpenAiCompletionUsageSchema,
+        OpenAiResponseUsageSchema,
+        OpenAiUsage,
+        OptionalObservationBody,
+        ScoreBody,
+        ScoreEvent,
+        SdkLogBody,
+        SdkLogEvent,
+        TraceBody,
+        TraceEvent,
+        UpdateEventBody,
+        UpdateGenerationBody,
+        UpdateGenerationEvent,
+        UpdateObservationEvent,
+        UpdateSpanBody,
+        UpdateSpanEvent,
+        UsageDetails,
+    )
+_dynamic_imports: typing.Dict[str, str] = {
+    "BaseEvent": ".types",
+    "CreateEventBody": ".types",
+    "CreateEventEvent": ".types",
+    "CreateGenerationBody": ".types",
+    "CreateGenerationEvent": ".types",
+    "CreateObservationEvent": ".types",
+    "CreateSpanBody": ".types",
+    "CreateSpanEvent": ".types",
+    "IngestionError": ".types",
+    "IngestionEvent": ".types",
+    "IngestionEvent_EventCreate": ".types",
+    "IngestionEvent_GenerationCreate": ".types",
+    "IngestionEvent_GenerationUpdate": ".types",
+    "IngestionEvent_ObservationCreate": ".types",
+    "IngestionEvent_ObservationUpdate": ".types",
+    "IngestionEvent_ScoreCreate": ".types",
+    "IngestionEvent_SdkLog": ".types",
+    "IngestionEvent_SpanCreate": ".types",
+    "IngestionEvent_SpanUpdate": ".types",
+    "IngestionEvent_TraceCreate": ".types",
+    "IngestionResponse": ".types",
+    "IngestionSuccess": ".types",
+    "IngestionUsage": ".types",
+    "ObservationBody": ".types",
+    "ObservationType": ".types",
+    "OpenAiCompletionUsageSchema": ".types",
+    "OpenAiResponseUsageSchema": ".types",
+    "OpenAiUsage": ".types",
+    "OptionalObservationBody": ".types",
+    "ScoreBody": ".types",
+    "ScoreEvent": ".types",
+    "SdkLogBody": ".types",
+    "SdkLogEvent": ".types",
+    "TraceBody": ".types",
+    "TraceEvent": ".types",
+    "UpdateEventBody": ".types",
+    "UpdateGenerationBody": ".types",
+    "UpdateGenerationEvent": ".types",
+    "UpdateObservationEvent": ".types",
+    "UpdateSpanBody": ".types",
+    "UpdateSpanEvent": ".types",
+    "UsageDetails": ".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__ = [
+    "BaseEvent",
+    "CreateEventBody",
+    "CreateEventEvent",
+    "CreateGenerationBody",
+    "CreateGenerationEvent",
+    "CreateObservationEvent",
+    "CreateSpanBody",
+    "CreateSpanEvent",
+    "IngestionError",
+    "IngestionEvent",
+    "IngestionEvent_EventCreate",
+    "IngestionEvent_GenerationCreate",
+    "IngestionEvent_GenerationUpdate",
+    "IngestionEvent_ObservationCreate",
+    "IngestionEvent_ObservationUpdate",
+    "IngestionEvent_ScoreCreate",
+    "IngestionEvent_SdkLog",
+    "IngestionEvent_SpanCreate",
+    "IngestionEvent_SpanUpdate",
+    "IngestionEvent_TraceCreate",
+    "IngestionResponse",
+    "IngestionSuccess",
+    "IngestionUsage",
+    "ObservationBody",
+    "ObservationType",
+    "OpenAiCompletionUsageSchema",
+    "OpenAiResponseUsageSchema",
+    "OpenAiUsage",
+    "OptionalObservationBody",
+    "ScoreBody",
+    "ScoreEvent",
+    "SdkLogBody",
+    "SdkLogEvent",
+    "TraceBody",
+    "TraceEvent",
+    "UpdateEventBody",
+    "UpdateGenerationBody",
+    "UpdateGenerationEvent",
+    "UpdateObservationEvent",
+    "UpdateSpanBody",
+    "UpdateSpanEvent",
+    "UsageDetails",
+]

aeri/api/ingestion/client.py

@@ -0,0 +1,221 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from .raw_client import AsyncRawIngestionClient, RawIngestionClient
+from .types.ingestion_event import IngestionEvent
+from .types.ingestion_response import IngestionResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class IngestionClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawIngestionClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawIngestionClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawIngestionClient
+        """
+        return self._raw_client
+
+    def batch(
+        self,
+        *,
+        batch: typing.Sequence[IngestionEvent],
+        metadata: typing.Optional[typing.Any] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> IngestionResponse:
+        """
+        **Legacy endpoint for batch ingestion for Aeri Observability.**
+
+        -> Please use the OpenTelemetry endpoint (`/api/public/otel/v1/traces`). Learn more: https://aeri.com/integrations/native/opentelemetry
+
+        Within each batch, there can be multiple events.
+        Each event has a type, an id, a timestamp, metadata and a body.
+        Internally, we refer to this as the "event envelope" as it tells us something about the event but not the trace.
+        We use the event id within this envelope to deduplicate messages to avoid processing the same event twice, i.e. the event id should be unique per request.
+        The event.body.id is the ID of the actual trace and will be used for updates and will be visible within the Aeri App.
+        I.e. if you want to update a trace, you'd use the same body id, but separate event IDs.
+
+        Notes:
+        - Introduction to data model: https://aeri.com/docs/observability/data-model
+        - Batch sizes are limited to 3.5 MB in total. You need to adjust the number of events per batch accordingly.
+        - The API does not return a 4xx status code for input errors. Instead, it responds with a 207 status code, which includes a list of the encountered errors.
+
+        Parameters
+        ----------
+        batch : typing.Sequence[IngestionEvent]
+            Batch of tracing events to be ingested. Discriminated by attribute `type`.
+
+        metadata : typing.Optional[typing.Any]
+            Optional. Metadata field used by the Aeri SDKs for debugging.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        IngestionResponse
+
+        Examples
+        --------
+        import datetime
+
+        from aeri import AeriAPI
+        from aeri.ingestion import IngestionEvent_TraceCreate, TraceBody
+
+        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.ingestion.batch(
+            batch=[
+                IngestionEvent_TraceCreate(
+                    id="abcdef-1234-5678-90ab",
+                    timestamp="2022-01-01T00:00:00.000Z",
+                    body=TraceBody(
+                        id="abcdef-1234-5678-90ab",
+                        timestamp=datetime.datetime.fromisoformat(
+                            "2022-01-01 00:00:00+00:00",
+                        ),
+                        environment="production",
+                        name="My Trace",
+                        user_id="1234-5678-90ab-cdef",
+                        input="My input",
+                        output="My output",
+                        session_id="1234-5678-90ab-cdef",
+                        release="1.0.0",
+                        version="1.0.0",
+                        metadata="My metadata",
+                        tags=["tag1", "tag2"],
+                        public=True,
+                    ),
+                )
+            ],
+        )
+        """
+        _response = self._raw_client.batch(
+            batch=batch, metadata=metadata, request_options=request_options
+        )
+        return _response.data
+
+
+class AsyncIngestionClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawIngestionClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawIngestionClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawIngestionClient
+        """
+        return self._raw_client
+
+    async def batch(
+        self,
+        *,
+        batch: typing.Sequence[IngestionEvent],
+        metadata: typing.Optional[typing.Any] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> IngestionResponse:
+        """
+        **Legacy endpoint for batch ingestion for Aeri Observability.**
+
+        -> Please use the OpenTelemetry endpoint (`/api/public/otel/v1/traces`). Learn more: https://aeri.com/integrations/native/opentelemetry
+
+        Within each batch, there can be multiple events.
+        Each event has a type, an id, a timestamp, metadata and a body.
+        Internally, we refer to this as the "event envelope" as it tells us something about the event but not the trace.
+        We use the event id within this envelope to deduplicate messages to avoid processing the same event twice, i.e. the event id should be unique per request.
+        The event.body.id is the ID of the actual trace and will be used for updates and will be visible within the Aeri App.
+        I.e. if you want to update a trace, you'd use the same body id, but separate event IDs.
+
+        Notes:
+        - Introduction to data model: https://aeri.com/docs/observability/data-model
+        - Batch sizes are limited to 3.5 MB in total. You need to adjust the number of events per batch accordingly.
+        - The API does not return a 4xx status code for input errors. Instead, it responds with a 207 status code, which includes a list of the encountered errors.
+
+        Parameters
+        ----------
+        batch : typing.Sequence[IngestionEvent]
+            Batch of tracing events to be ingested. Discriminated by attribute `type`.
+
+        metadata : typing.Optional[typing.Any]
+            Optional. Metadata field used by the Aeri SDKs for debugging.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        IngestionResponse
+
+        Examples
+        --------
+        import asyncio
+        import datetime
+
+        from aeri import AsyncAeriAPI
+        from aeri.ingestion import IngestionEvent_TraceCreate, TraceBody
+
+        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.ingestion.batch(
+                batch=[
+                    IngestionEvent_TraceCreate(
+                        id="abcdef-1234-5678-90ab",
+                        timestamp="2022-01-01T00:00:00.000Z",
+                        body=TraceBody(
+                            id="abcdef-1234-5678-90ab",
+                            timestamp=datetime.datetime.fromisoformat(
+                                "2022-01-01 00:00:00+00:00",
+                            ),
+                            environment="production",
+                            name="My Trace",
+                            user_id="1234-5678-90ab-cdef",
+                            input="My input",
+                            output="My output",
+                            session_id="1234-5678-90ab-cdef",
+                            release="1.0.0",
+                            version="1.0.0",
+                            metadata="My metadata",
+                            tags=["tag1", "tag2"],
+                            public=True,
+                        ),
+                    )
+                ],
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.batch(
+            batch=batch, metadata=metadata, request_options=request_options
+        )
+        return _response.data

aeri/api/ingestion/raw_client.py

@@ -0,0 +1,293 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ..commons.errors.access_denied_error import AccessDeniedError
+from ..commons.errors.error import Error
+from ..commons.errors.method_not_allowed_error import MethodNotAllowedError
+from ..commons.errors.not_found_error import NotFoundError
+from ..commons.errors.unauthorized_error import UnauthorizedError
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.pydantic_utilities import parse_obj_as
+from ..core.request_options import RequestOptions
+from ..core.serialization import convert_and_respect_annotation_metadata
+from .types.ingestion_event import IngestionEvent
+from .types.ingestion_response import IngestionResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawIngestionClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def batch(
+        self,
+        *,
+        batch: typing.Sequence[IngestionEvent],
+        metadata: typing.Optional[typing.Any] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[IngestionResponse]:
+        """
+        **Legacy endpoint for batch ingestion for Aeri Observability.**
+
+        -> Please use the OpenTelemetry endpoint (`/api/public/otel/v1/traces`). Learn more: https://aeri.com/integrations/native/opentelemetry
+
+        Within each batch, there can be multiple events.
+        Each event has a type, an id, a timestamp, metadata and a body.
+        Internally, we refer to this as the "event envelope" as it tells us something about the event but not the trace.
+        We use the event id within this envelope to deduplicate messages to avoid processing the same event twice, i.e. the event id should be unique per request.
+        The event.body.id is the ID of the actual trace and will be used for updates and will be visible within the Aeri App.
+        I.e. if you want to update a trace, you'd use the same body id, but separate event IDs.
+
+        Notes:
+        - Introduction to data model: https://aeri.com/docs/observability/data-model
+        - Batch sizes are limited to 3.5 MB in total. You need to adjust the number of events per batch accordingly.
+        - The API does not return a 4xx status code for input errors. Instead, it responds with a 207 status code, which includes a list of the encountered errors.
+
+        Parameters
+        ----------
+        batch : typing.Sequence[IngestionEvent]
+            Batch of tracing events to be ingested. Discriminated by attribute `type`.
+
+        metadata : typing.Optional[typing.Any]
+            Optional. Metadata field used by the Aeri SDKs for debugging.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[IngestionResponse]
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/public/ingestion",
+            method="POST",
+            json={
+                "batch": convert_and_respect_annotation_metadata(
+                    object_=batch,
+                    annotation=typing.Sequence[IngestionEvent],
+                    direction="write",
+                ),
+                "metadata": metadata,
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    IngestionResponse,
+                    parse_obj_as(
+                        type_=IngestionResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise Error(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise AccessDeniedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 405:
+                raise MethodNotAllowedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(
+                status_code=_response.status_code,
+                headers=dict(_response.headers),
+                body=_response.text,
+            )
+        raise ApiError(
+            status_code=_response.status_code,
+            headers=dict(_response.headers),
+            body=_response_json,
+        )
+
+
+class AsyncRawIngestionClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def batch(
+        self,
+        *,
+        batch: typing.Sequence[IngestionEvent],
+        metadata: typing.Optional[typing.Any] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[IngestionResponse]:
+        """
+        **Legacy endpoint for batch ingestion for Aeri Observability.**
+
+        -> Please use the OpenTelemetry endpoint (`/api/public/otel/v1/traces`). Learn more: https://aeri.com/integrations/native/opentelemetry
+
+        Within each batch, there can be multiple events.
+        Each event has a type, an id, a timestamp, metadata and a body.
+        Internally, we refer to this as the "event envelope" as it tells us something about the event but not the trace.
+        We use the event id within this envelope to deduplicate messages to avoid processing the same event twice, i.e. the event id should be unique per request.
+        The event.body.id is the ID of the actual trace and will be used for updates and will be visible within the Aeri App.
+        I.e. if you want to update a trace, you'd use the same body id, but separate event IDs.
+
+        Notes:
+        - Introduction to data model: https://aeri.com/docs/observability/data-model
+        - Batch sizes are limited to 3.5 MB in total. You need to adjust the number of events per batch accordingly.
+        - The API does not return a 4xx status code for input errors. Instead, it responds with a 207 status code, which includes a list of the encountered errors.
+
+        Parameters
+        ----------
+        batch : typing.Sequence[IngestionEvent]
+            Batch of tracing events to be ingested. Discriminated by attribute `type`.
+
+        metadata : typing.Optional[typing.Any]
+            Optional. Metadata field used by the Aeri SDKs for debugging.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[IngestionResponse]
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/public/ingestion",
+            method="POST",
+            json={
+                "batch": convert_and_respect_annotation_metadata(
+                    object_=batch,
+                    annotation=typing.Sequence[IngestionEvent],
+                    direction="write",
+                ),
+                "metadata": metadata,
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    IngestionResponse,
+                    parse_obj_as(
+                        type_=IngestionResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise Error(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise AccessDeniedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 405:
+                raise MethodNotAllowedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(
+                status_code=_response.status_code,
+                headers=dict(_response.headers),
+                body=_response.text,
+            )
+        raise ApiError(
+            status_code=_response.status_code,
+            headers=dict(_response.headers),
+            body=_response_json,
+        )