mirascope 2.0.0a2__py3-none-any.whl → 2.0.0a3__py3-none-any.whl

mirascope/__init__.py

@@ -1,5 +1,5 @@
 """Mirascope v2 Beta."""
 
-from . import graphs as graphs, llm as llm
+from . import api as api, llm as llm, ops as ops
 
-__all__ = ["graphs", "llm"]
+__all__ = ["api", "llm", "ops"]

mirascope/api/__init__.py

@@ -0,0 +1,6 @@
+"""The Mirascope Cloud API client."""
+
+from .client import AsyncMirascope, Mirascope
+from .settings import get_settings, settings
+
+__all__ = ["AsyncMirascope", "Mirascope", "get_settings", "settings"]

mirascope/api/_generated/README.md

@@ -0,0 +1,207 @@
+# Mirascope Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=Mirascope%2FPython)
+[![pypi](https://img.shields.io/pypi/v/mirascope)](https://pypi.python.org/pypi/mirascope)
+
+The Mirascope Python library provides convenient access to the Mirascope APIs from Python.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
+## Installation
+
+```sh
+pip install mirascope
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from mirascope.api._generated import Mirascope
+from mirascope.api._generated.traces import (
+    TracesCreateRequestResourceSpansItem,
+    TracesCreateRequestResourceSpansItemScopeSpansItem,
+    TracesCreateRequestResourceSpansItemScopeSpansItemSpansItem,
+)
+
+client = Mirascope()
+client.traces.create(
+    resource_spans=[
+        TracesCreateRequestResourceSpansItem(
+            scope_spans=[
+                TracesCreateRequestResourceSpansItemScopeSpansItem(
+                    spans=[
+                        TracesCreateRequestResourceSpansItemScopeSpansItemSpansItem(
+                            trace_id="traceId",
+                            span_id="spanId",
+                            name="name",
+                            start_time_unix_nano="startTimeUnixNano",
+                            end_time_unix_nano="endTimeUnixNano",
+                        )
+                    ],
+                )
+            ],
+        )
+    ],
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+
+```python
+import asyncio
+
+from mirascope.api._generated import AsyncMirascope
+from mirascope.api._generated.traces import (
+    TracesCreateRequestResourceSpansItem,
+    TracesCreateRequestResourceSpansItemScopeSpansItem,
+    TracesCreateRequestResourceSpansItemScopeSpansItemSpansItem,
+)
+
+client = AsyncMirascope()
+
+
+async def main() -> None:
+    await client.traces.create(
+        resource_spans=[
+            TracesCreateRequestResourceSpansItem(
+                scope_spans=[
+                    TracesCreateRequestResourceSpansItemScopeSpansItem(
+                        spans=[
+                            TracesCreateRequestResourceSpansItemScopeSpansItemSpansItem(
+                                trace_id="traceId",
+                                span_id="spanId",
+                                name="name",
+                                start_time_unix_nano="startTimeUnixNano",
+                                end_time_unix_nano="endTimeUnixNano",
+                            )
+                        ],
+                    )
+                ],
+            )
+        ],
+    )
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from mirascope.api._generated.core.api_error import ApiError
+
+try:
+    client.traces.create(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from mirascope.api._generated import Mirascope
+
+client = Mirascope(
+    ...,
+)
+response = client.traces.with_raw_response.create(...)
+print(response.headers)  # access the response headers
+print(response.data)  # access the underlying object
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.traces.create(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from mirascope.api._generated import Mirascope
+
+client = Mirascope(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.traces.create(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+
+```python
+import httpx
+from mirascope.api._generated import Mirascope
+
+client = Mirascope(
+    ...,
+    httpx_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

mirascope/api/_generated/__init__.py

@@ -0,0 +1,85 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .types import (
+    HttpApiDecodeError,
+    HttpApiDecodeErrorTag,
+    Issue,
+    IssueTag,
+    PropertyKey,
+    PropertyKeyTag,
+    PropertyKeyTagTag,
+)
+from .errors import BadRequestError
+from . import docs, health, traces
+from .client import AsyncMirascope, Mirascope
+from .environment import MirascopeEnvironment
+from .health import HealthCheckResponse, HealthCheckResponseStatus
+from .traces import (
+    TracesCreateRequestResourceSpansItem,
+    TracesCreateRequestResourceSpansItemResource,
+    TracesCreateRequestResourceSpansItemResourceAttributesItem,
+    TracesCreateRequestResourceSpansItemResourceAttributesItemValue,
+    TracesCreateRequestResourceSpansItemResourceAttributesItemValueArrayValue,
+    TracesCreateRequestResourceSpansItemResourceAttributesItemValueKvlistValue,
+    TracesCreateRequestResourceSpansItemResourceAttributesItemValueKvlistValueValuesItem,
+    TracesCreateRequestResourceSpansItemScopeSpansItem,
+    TracesCreateRequestResourceSpansItemScopeSpansItemScope,
+    TracesCreateRequestResourceSpansItemScopeSpansItemScopeAttributesItem,
+    TracesCreateRequestResourceSpansItemScopeSpansItemScopeAttributesItemValue,
+    TracesCreateRequestResourceSpansItemScopeSpansItemScopeAttributesItemValueArrayValue,
+    TracesCreateRequestResourceSpansItemScopeSpansItemScopeAttributesItemValueKvlistValue,
+    TracesCreateRequestResourceSpansItemScopeSpansItemScopeAttributesItemValueKvlistValueValuesItem,
+    TracesCreateRequestResourceSpansItemScopeSpansItemSpansItem,
+    TracesCreateRequestResourceSpansItemScopeSpansItemSpansItemAttributesItem,
+    TracesCreateRequestResourceSpansItemScopeSpansItemSpansItemAttributesItemValue,
+    TracesCreateRequestResourceSpansItemScopeSpansItemSpansItemAttributesItemValueArrayValue,
+    TracesCreateRequestResourceSpansItemScopeSpansItemSpansItemAttributesItemValueKvlistValue,
+    TracesCreateRequestResourceSpansItemScopeSpansItemSpansItemAttributesItemValueKvlistValueValuesItem,
+    TracesCreateRequestResourceSpansItemScopeSpansItemSpansItemStatus,
+    TracesCreateResponse,
+    TracesCreateResponsePartialSuccess,
+)
+
+__all__ = [
+    "AsyncMirascope",
+    "BadRequestError",
+    "HealthCheckResponse",
+    "HealthCheckResponseStatus",
+    "HttpApiDecodeError",
+    "HttpApiDecodeErrorTag",
+    "Issue",
+    "IssueTag",
+    "Mirascope",
+    "MirascopeEnvironment",
+    "PropertyKey",
+    "PropertyKeyTag",
+    "PropertyKeyTagTag",
+    "TracesCreateRequestResourceSpansItem",
+    "TracesCreateRequestResourceSpansItemResource",
+    "TracesCreateRequestResourceSpansItemResourceAttributesItem",
+    "TracesCreateRequestResourceSpansItemResourceAttributesItemValue",
+    "TracesCreateRequestResourceSpansItemResourceAttributesItemValueArrayValue",
+    "TracesCreateRequestResourceSpansItemResourceAttributesItemValueKvlistValue",
+    "TracesCreateRequestResourceSpansItemResourceAttributesItemValueKvlistValueValuesItem",
+    "TracesCreateRequestResourceSpansItemScopeSpansItem",
+    "TracesCreateRequestResourceSpansItemScopeSpansItemScope",
+    "TracesCreateRequestResourceSpansItemScopeSpansItemScopeAttributesItem",
+    "TracesCreateRequestResourceSpansItemScopeSpansItemScopeAttributesItemValue",
+    "TracesCreateRequestResourceSpansItemScopeSpansItemScopeAttributesItemValueArrayValue",
+    "TracesCreateRequestResourceSpansItemScopeSpansItemScopeAttributesItemValueKvlistValue",
+    "TracesCreateRequestResourceSpansItemScopeSpansItemScopeAttributesItemValueKvlistValueValuesItem",
+    "TracesCreateRequestResourceSpansItemScopeSpansItemSpansItem",
+    "TracesCreateRequestResourceSpansItemScopeSpansItemSpansItemAttributesItem",
+    "TracesCreateRequestResourceSpansItemScopeSpansItemSpansItemAttributesItemValue",
+    "TracesCreateRequestResourceSpansItemScopeSpansItemSpansItemAttributesItemValueArrayValue",
+    "TracesCreateRequestResourceSpansItemScopeSpansItemSpansItemAttributesItemValueKvlistValue",
+    "TracesCreateRequestResourceSpansItemScopeSpansItemSpansItemAttributesItemValueKvlistValueValuesItem",
+    "TracesCreateRequestResourceSpansItemScopeSpansItemSpansItemStatus",
+    "TracesCreateResponse",
+    "TracesCreateResponsePartialSuccess",
+    "docs",
+    "health",
+    "traces",
+]

mirascope/api/_generated/client.py

@@ -0,0 +1,155 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .docs.client import AsyncDocsClient, DocsClient
+from .environment import MirascopeEnvironment
+from .health.client import AsyncHealthClient, HealthClient
+from .traces.client import AsyncTracesClient, TracesClient
+
+
+class Mirascope:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
+
+    Parameters
+    ----------
+    base_url : typing.Optional[str]
+        The base url to use for requests from the client.
+
+    environment : MirascopeEnvironment
+        The environment to use for requests from the client. from .environment import MirascopeEnvironment
+
+
+
+        Defaults to MirascopeEnvironment.PRODUCTION
+
+
+
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests. By default the timeout is 180 seconds, unless a custom httpx client is used, in which case this default is not enforced.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    httpx_client : typing.Optional[httpx.Client]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+
+    Examples
+    --------
+    from mirascope.api._generated import Mirascope
+
+    client = Mirascope()
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: MirascopeEnvironment = MirascopeEnvironment.PRODUCTION,
+        timeout: typing.Optional[float] = None,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.Client] = None,
+    ):
+        _defaulted_timeout = (
+            timeout
+            if timeout is not None
+            else 180
+            if httpx_client is None
+            else httpx_client.timeout.read
+        )
+        self._client_wrapper = SyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else httpx.Client(
+                timeout=_defaulted_timeout, follow_redirects=follow_redirects
+            )
+            if follow_redirects is not None
+            else httpx.Client(timeout=_defaulted_timeout),
+            timeout=_defaulted_timeout,
+        )
+        self.health = HealthClient(client_wrapper=self._client_wrapper)
+        self.traces = TracesClient(client_wrapper=self._client_wrapper)
+        self.docs = DocsClient(client_wrapper=self._client_wrapper)
+
+
+class AsyncMirascope:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
+
+    Parameters
+    ----------
+    base_url : typing.Optional[str]
+        The base url to use for requests from the client.
+
+    environment : MirascopeEnvironment
+        The environment to use for requests from the client. from .environment import MirascopeEnvironment
+
+
+
+        Defaults to MirascopeEnvironment.PRODUCTION
+
+
+
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests. By default the timeout is 180 seconds, unless a custom httpx client is used, in which case this default is not enforced.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    httpx_client : typing.Optional[httpx.AsyncClient]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+
+    Examples
+    --------
+    from mirascope.api._generated import AsyncMirascope
+
+    client = AsyncMirascope()
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: MirascopeEnvironment = MirascopeEnvironment.PRODUCTION,
+        timeout: typing.Optional[float] = None,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.AsyncClient] = None,
+    ):
+        _defaulted_timeout = (
+            timeout
+            if timeout is not None
+            else 180
+            if httpx_client is None
+            else httpx_client.timeout.read
+        )
+        self._client_wrapper = AsyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else httpx.AsyncClient(
+                timeout=_defaulted_timeout, follow_redirects=follow_redirects
+            )
+            if follow_redirects is not None
+            else httpx.AsyncClient(timeout=_defaulted_timeout),
+            timeout=_defaulted_timeout,
+        )
+        self.health = AsyncHealthClient(client_wrapper=self._client_wrapper)
+        self.traces = AsyncTracesClient(client_wrapper=self._client_wrapper)
+        self.docs = AsyncDocsClient(client_wrapper=self._client_wrapper)
+
+
+def _get_base_url(
+    *, base_url: typing.Optional[str] = None, environment: MirascopeEnvironment
+) -> str:
+    if base_url is not None:
+        return base_url
+    elif environment is not None:
+        return environment.value
+    else:
+        raise Exception(
+            "Please pass in either base_url or environment to construct the client"
+        )

mirascope/api/_generated/core/__init__.py

@@ -0,0 +1,52 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .api_error import ApiError
+from .client_wrapper import AsyncClientWrapper, BaseClientWrapper, SyncClientWrapper
+from .datetime_utils import serialize_datetime
+from .file import File, convert_file_dict_to_httpx_tuples, with_content_type
+from .http_client import AsyncHttpClient, HttpClient
+from .http_response import AsyncHttpResponse, HttpResponse
+from .jsonable_encoder import jsonable_encoder
+from .pydantic_utilities import (
+    IS_PYDANTIC_V2,
+    UniversalBaseModel,
+    UniversalRootModel,
+    parse_obj_as,
+    universal_field_validator,
+    universal_root_validator,
+    update_forward_refs,
+)
+from .query_encoder import encode_query
+from .remove_none_from_dict import remove_none_from_dict
+from .request_options import RequestOptions
+from .serialization import FieldMetadata, convert_and_respect_annotation_metadata
+
+__all__ = [
+    "ApiError",
+    "AsyncClientWrapper",
+    "AsyncHttpClient",
+    "AsyncHttpResponse",
+    "BaseClientWrapper",
+    "FieldMetadata",
+    "File",
+    "HttpClient",
+    "HttpResponse",
+    "IS_PYDANTIC_V2",
+    "RequestOptions",
+    "SyncClientWrapper",
+    "UniversalBaseModel",
+    "UniversalRootModel",
+    "convert_and_respect_annotation_metadata",
+    "convert_file_dict_to_httpx_tuples",
+    "encode_query",
+    "jsonable_encoder",
+    "parse_obj_as",
+    "remove_none_from_dict",
+    "serialize_datetime",
+    "universal_field_validator",
+    "universal_root_validator",
+    "update_forward_refs",
+    "with_content_type",
+]

mirascope/api/_generated/core/api_error.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from typing import Any, Dict, Optional
+
+
+class ApiError(Exception):
+    headers: Optional[Dict[str, str]]
+    status_code: Optional[int]
+    body: Any
+
+    def __init__(
+        self,
+        *,
+        headers: Optional[Dict[str, str]] = None,
+        status_code: Optional[int] = None,
+        body: Any = None,
+    ) -> None:
+        self.headers = headers
+        self.status_code = status_code
+        self.body = body
+
+    def __str__(self) -> str:
+        return f"headers: {self.headers}, status_code: {self.status_code}, body: {self.body}"

mirascope/api/_generated/core/client_wrapper.py

@@ -0,0 +1,58 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+from .http_client import AsyncHttpClient, HttpClient
+
+
+class BaseClientWrapper:
+    def __init__(self, *, base_url: str, timeout: typing.Optional[float] = None):
+        self._base_url = base_url
+        self._timeout = timeout
+
+    def get_headers(self) -> typing.Dict[str, str]:
+        headers: typing.Dict[str, str] = {
+            "X-Fern-Language": "Python",
+        }
+        return headers
+
+    def get_base_url(self) -> str:
+        return self._base_url
+
+    def get_timeout(self) -> typing.Optional[float]:
+        return self._timeout
+
+
+class SyncClientWrapper(BaseClientWrapper):
+    def __init__(
+        self,
+        *,
+        base_url: str,
+        timeout: typing.Optional[float] = None,
+        httpx_client: httpx.Client,
+    ):
+        super().__init__(base_url=base_url, timeout=timeout)
+        self.httpx_client = HttpClient(
+            httpx_client=httpx_client,
+            base_headers=self.get_headers,
+            base_timeout=self.get_timeout,
+            base_url=self.get_base_url,
+        )
+
+
+class AsyncClientWrapper(BaseClientWrapper):
+    def __init__(
+        self,
+        *,
+        base_url: str,
+        timeout: typing.Optional[float] = None,
+        httpx_client: httpx.AsyncClient,
+    ):
+        super().__init__(base_url=base_url, timeout=timeout)
+        self.httpx_client = AsyncHttpClient(
+            httpx_client=httpx_client,
+            base_headers=self.get_headers,
+            base_timeout=self.get_timeout,
+            base_url=self.get_base_url,
+        )

mirascope/api/_generated/core/datetime_utils.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+
+
+def serialize_datetime(v: dt.datetime) -> str:
+    """
+    Serialize a datetime including timezone info.
+
+    Uses the timezone info provided if present, otherwise uses the current runtime's timezone info.
+
+    UTC datetimes end in "Z" while all other timezones are represented as offset from UTC, e.g. +05:00.
+    """
+
+    def _serialize_zoned_datetime(v: dt.datetime) -> str:
+        if v.tzinfo is not None and v.tzinfo.tzname(None) == dt.timezone.utc.tzname(
+            None
+        ):
+            # UTC is a special case where we use "Z" at the end instead of "+00:00"
+            return v.isoformat().replace("+00:00", "Z")
+        else:
+            # Delegate to the typical +/- offset format
+            return v.isoformat()
+
+    if v.tzinfo is not None:
+        return _serialize_zoned_datetime(v)
+    else:
+        local_tz = dt.datetime.now().astimezone().tzinfo
+        localized_dt = v.replace(tzinfo=local_tz)
+        return _serialize_zoned_datetime(localized_dt)