mirascope 1.0.5__py3-none-any.whl → 2.1.1__py3-none-any.whl

mirascope/api/_generated/api_keys/types/__init__.py

@@ -0,0 +1,15 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .api_keys_create_response import ApiKeysCreateResponse
+from .api_keys_get_response import ApiKeysGetResponse
+from .api_keys_list_all_for_org_response_item import ApiKeysListAllForOrgResponseItem
+from .api_keys_list_response_item import ApiKeysListResponseItem
+
+__all__ = [
+    "ApiKeysCreateResponse",
+    "ApiKeysGetResponse",
+    "ApiKeysListAllForOrgResponseItem",
+    "ApiKeysListResponseItem",
+]

mirascope/api/_generated/api_keys/types/api_keys_create_response.py

@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...core.serialization import FieldMetadata
+
+
+class ApiKeysCreateResponse(UniversalBaseModel):
+    id: str
+    name: str
+    key_prefix: typing_extensions.Annotated[str, FieldMetadata(alias="keyPrefix")]
+    environment_id: typing_extensions.Annotated[str, FieldMetadata(alias="environmentId")]
+    owner_id: typing_extensions.Annotated[str, FieldMetadata(alias="ownerId")]
+    created_at: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="createdAt")] = None
+    last_used_at: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="lastUsedAt")] = None
+    key: str
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

mirascope/api/_generated/api_keys/types/api_keys_get_response.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...core.serialization import FieldMetadata
+
+
+class ApiKeysGetResponse(UniversalBaseModel):
+    id: str
+    name: str
+    key_prefix: typing_extensions.Annotated[str, FieldMetadata(alias="keyPrefix")]
+    environment_id: typing_extensions.Annotated[str, FieldMetadata(alias="environmentId")]
+    owner_id: typing_extensions.Annotated[str, FieldMetadata(alias="ownerId")]
+    created_at: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="createdAt")] = None
+    last_used_at: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="lastUsedAt")] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

mirascope/api/_generated/api_keys/types/api_keys_list_all_for_org_response_item.py

@@ -0,0 +1,40 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...core.serialization import FieldMetadata
+
+
+class ApiKeysListAllForOrgResponseItem(UniversalBaseModel):
+    id: str
+    name: str
+    key_prefix: typing_extensions.Annotated[str, FieldMetadata(alias="keyPrefix")]
+    environment_id: typing_extensions.Annotated[
+        str, FieldMetadata(alias="environmentId")
+    ]
+    owner_id: typing_extensions.Annotated[str, FieldMetadata(alias="ownerId")]
+    created_at: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="createdAt")
+    ] = None
+    last_used_at: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="lastUsedAt")
+    ] = None
+    project_id: typing_extensions.Annotated[str, FieldMetadata(alias="projectId")]
+    project_name: typing_extensions.Annotated[str, FieldMetadata(alias="projectName")]
+    environment_name: typing_extensions.Annotated[
+        str, FieldMetadata(alias="environmentName")
+    ]
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
+            extra="allow", frozen=True
+        )  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

mirascope/api/_generated/api_keys/types/api_keys_list_response_item.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...core.serialization import FieldMetadata
+
+
+class ApiKeysListResponseItem(UniversalBaseModel):
+    id: str
+    name: str
+    key_prefix: typing_extensions.Annotated[str, FieldMetadata(alias="keyPrefix")]
+    environment_id: typing_extensions.Annotated[str, FieldMetadata(alias="environmentId")]
+    owner_id: typing_extensions.Annotated[str, FieldMetadata(alias="ownerId")]
+    created_at: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="createdAt")] = None
+    last_used_at: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="lastUsedAt")] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

mirascope/api/_generated/client.py

@@ -0,0 +1,211 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+from .annotations.client import AnnotationsClient, AsyncAnnotationsClient
+from .api_keys.client import ApiKeysClient, AsyncApiKeysClient
+from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .docs.client import AsyncDocsClient, DocsClient
+from .environment import MirascopeEnvironment
+from .environments.client import AsyncEnvironmentsClient, EnvironmentsClient
+from .functions.client import AsyncFunctionsClient, FunctionsClient
+from .health.client import AsyncHealthClient, HealthClient
+from .organization_invitations.client import (
+    AsyncOrganizationInvitationsClient,
+    OrganizationInvitationsClient,
+)
+from .organization_memberships.client import (
+    AsyncOrganizationMembershipsClient,
+    OrganizationMembershipsClient,
+)
+from .organizations.client import AsyncOrganizationsClient, OrganizationsClient
+from .project_memberships.client import (
+    AsyncProjectMembershipsClient,
+    ProjectMembershipsClient,
+)
+from .projects.client import AsyncProjectsClient, ProjectsClient
+from .tags.client import AsyncTagsClient, TagsClient
+from .token_cost.client import AsyncTokenCostClient, TokenCostClient
+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)
+        self.organizations = OrganizationsClient(client_wrapper=self._client_wrapper)
+        self.organization_invitations = OrganizationInvitationsClient(
+            client_wrapper=self._client_wrapper
+        )
+        self.organization_memberships = OrganizationMembershipsClient(
+            client_wrapper=self._client_wrapper
+        )
+        self.projects = ProjectsClient(client_wrapper=self._client_wrapper)
+        self.project_memberships = ProjectMembershipsClient(
+            client_wrapper=self._client_wrapper
+        )
+        self.environments = EnvironmentsClient(client_wrapper=self._client_wrapper)
+        self.api_keys = ApiKeysClient(client_wrapper=self._client_wrapper)
+        self.functions = FunctionsClient(client_wrapper=self._client_wrapper)
+        self.annotations = AnnotationsClient(client_wrapper=self._client_wrapper)
+        self.tags = TagsClient(client_wrapper=self._client_wrapper)
+        self.token_cost = TokenCostClient(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)
+        self.organizations = AsyncOrganizationsClient(
+            client_wrapper=self._client_wrapper
+        )
+        self.organization_invitations = AsyncOrganizationInvitationsClient(
+            client_wrapper=self._client_wrapper
+        )
+        self.organization_memberships = AsyncOrganizationMembershipsClient(
+            client_wrapper=self._client_wrapper
+        )
+        self.projects = AsyncProjectsClient(client_wrapper=self._client_wrapper)
+        self.project_memberships = AsyncProjectMembershipsClient(
+            client_wrapper=self._client_wrapper
+        )
+        self.environments = AsyncEnvironmentsClient(client_wrapper=self._client_wrapper)
+        self.api_keys = AsyncApiKeysClient(client_wrapper=self._client_wrapper)
+        self.functions = AsyncFunctionsClient(client_wrapper=self._client_wrapper)
+        self.annotations = AsyncAnnotationsClient(client_wrapper=self._client_wrapper)
+        self.tags = AsyncTagsClient(client_wrapper=self._client_wrapper)
+        self.token_cost = AsyncTokenCostClient(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,46 @@
+# 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,28 @@
+# 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)

mirascope/api/_generated/core/file.py

@@ -0,0 +1,67 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from typing import IO, Dict, List, Mapping, Optional, Tuple, Union, cast
+
+# File typing inspired by the flexibility of types within the httpx library
+# https://github.com/encode/httpx/blob/master/httpx/_types.py
+FileContent = Union[IO[bytes], bytes, str]
+File = Union[
+    # file (or bytes)
+    FileContent,
+    # (filename, file (or bytes))
+    Tuple[Optional[str], FileContent],
+    # (filename, file (or bytes), content_type)
+    Tuple[Optional[str], FileContent, Optional[str]],
+    # (filename, file (or bytes), content_type, headers)
+    Tuple[
+        Optional[str],
+        FileContent,
+        Optional[str],
+        Mapping[str, str],
+    ],
+]
+
+
+def convert_file_dict_to_httpx_tuples(
+    d: Dict[str, Union[File, List[File]]],
+) -> List[Tuple[str, File]]:
+    """
+    The format we use is a list of tuples, where the first element is the
+    name of the file and the second is the file object. Typically HTTPX wants
+    a dict, but to be able to send lists of files, you have to use the list
+    approach (which also works for non-lists)
+    https://github.com/encode/httpx/pull/1032
+    """
+
+    httpx_tuples = []
+    for key, file_like in d.items():
+        if isinstance(file_like, list):
+            for file_like_item in file_like:
+                httpx_tuples.append((key, file_like_item))
+        else:
+            httpx_tuples.append((key, file_like))
+    return httpx_tuples
+
+
+def with_content_type(*, file: File, default_content_type: str) -> File:
+    """
+    This function resolves to the file's content type, if provided, and defaults
+    to the default_content_type value if not.
+    """
+    if isinstance(file, tuple):
+        if len(file) == 2:
+            filename, content = cast(Tuple[Optional[str], FileContent], file)  # type: ignore
+            return (filename, content, default_content_type)
+        elif len(file) == 3:
+            filename, content, file_content_type = cast(Tuple[Optional[str], FileContent, Optional[str]], file)  # type: ignore
+            out_content_type = file_content_type or default_content_type
+            return (filename, content, out_content_type)
+        elif len(file) == 4:
+            filename, content, file_content_type, headers = cast(  # type: ignore
+                Tuple[Optional[str], FileContent, Optional[str], Mapping[str, str]], file
+            )
+            out_content_type = file_content_type or default_content_type
+            return (filename, content, out_content_type, headers)
+        else:
+            raise ValueError(f"Unexpected tuple length: {len(file)}")
+    return (None, file, default_content_type)

mirascope/api/_generated/core/force_multipart.py

@@ -0,0 +1,16 @@
+# This file was auto-generated by Fern from our API Definition.
+
+
+class ForceMultipartDict(dict):
+    """
+    A dictionary subclass that always evaluates to True in boolean contexts.
+
+    This is used to force multipart/form-data encoding in HTTP requests even when
+    the dictionary is empty, which would normally evaluate to False.
+    """
+
+    def __bool__(self):
+        return True
+
+
+FORCE_MULTIPART = ForceMultipartDict()