mirascope 1.19.0__py3-none-any.whl → 1.20.0__py3-none-any.whl

mirascope/core/openai/stream.py

@@ -21,7 +21,7 @@ from openai.types.chat.chat_completion_message_tool_call_param import Function
 from openai.types.completion_usage import CompletionUsage
 
 from ..base.stream import BaseStream
-from ._utils import calculate_cost
+from ..base.types import CostMetadata
 from .call_params import OpenAICallParams
 from .call_response import OpenAICallResponse
 from .call_response_chunk import OpenAICallResponseChunk
@@ -101,13 +101,6 @@ class OpenAIStream(
 
         return generator()
 
-    @property
-    def cost(self) -> float | None:
-        """Returns the cost of the call."""
-        return calculate_cost(
-            self.input_tokens, self.cached_tokens, self.output_tokens, self.model
-        )
-
     def _construct_message_param(
         self,
         tool_calls: list[ChatCompletionMessageToolCall] | None = None,
@@ -186,3 +179,7 @@ class OpenAIStream(
             start_time=self.start_time,
             end_time=self.end_time,
         )
+
+    @property
+    def cost_metadata(self) -> CostMetadata:
+        return super().cost_metadata

mirascope/core/vertex/_utils/__init__.py

@@ -1,13 +1,11 @@
 """Vertex utilities for decorator factories."""
 
-from ._calculate_cost import calculate_cost
 from ._convert_message_params import convert_message_params
 from ._get_json_output import get_json_output
 from ._handle_stream import handle_stream, handle_stream_async
 from ._setup_call import setup_call
 
 __all__ = [
-    "calculate_cost",
     "convert_message_params",
     "get_json_output",
     "handle_stream",

mirascope/core/vertex/call_response.py

@@ -11,8 +11,7 @@ from vertexai.generative_models import Content, GenerationResponse, Part, Tool
 
 from .. import BaseMessageParam
 from ..base import BaseCallResponse, transform_tool_outputs
-from ..base.types import FinishReason
-from ._utils import calculate_cost
+from ..base.types import CostMetadata, FinishReason
 from ._utils._convert_finish_reason_to_common_finish_reasons import (
     _convert_finish_reasons_to_common_finish_reasons,
 )
@@ -124,14 +123,6 @@ class VertexCallResponse(
         """Returns the number of output tokens."""
         return self.usage.candidates_token_count
 
-    @computed_field
-    @property
-    def cost(self) -> float | None:
-        """Returns the cost of the call."""
-        return calculate_cost(
-            self.input_tokens, self.cached_tokens, self.output_tokens, self.model
-        )
-
     @computed_field
     @cached_property
     def message_param(self) -> Content:
@@ -205,3 +196,7 @@ class VertexCallResponse(
         if not self.user_message_param:
             return None
         return VertexMessageParamConverter.from_provider([self.user_message_param])[0]
+
+    @property
+    def cost_metadata(self) -> CostMetadata:
+        return super().cost_metadata

mirascope/core/vertex/call_response_chunk.py

@@ -6,6 +6,7 @@ usage docs: learn/streams.md#handling-streamed-responses
 from vertexai.generative_models import FinishReason, GenerationResponse
 
 from ..base import BaseCallResponseChunk, types
+from ..base.types import CostMetadata
 from ._utils._convert_finish_reason_to_common_finish_reasons import (
     _convert_finish_reasons_to_common_finish_reasons,
 )
@@ -86,6 +87,11 @@ class VertexCallResponseChunk(
         """Returns the number of output tokens."""
         return None
 
+    @property
+    def cost_metadata(self) -> CostMetadata:
+        """Returns the cost metadata."""
+        return super().cost_metadata
+
     @property
     def common_finish_reasons(self) -> list[types.FinishReason] | None:
         return _convert_finish_reasons_to_common_finish_reasons(

mirascope/core/vertex/stream.py

@@ -16,7 +16,7 @@ from vertexai.generative_models import (
 )
 
 from ..base.stream import BaseStream
-from ._utils import calculate_cost
+from ..base.types import CostMetadata
 from .call_params import VertexCallParams
 from .call_response import VertexCallResponse
 from .call_response_chunk import VertexCallResponseChunk
@@ -61,13 +61,6 @@ class VertexStream(
 
     _provider = "vertex"
 
-    @property
-    def cost(self) -> float | None:
-        """Returns the cost of the call."""
-        return calculate_cost(
-            self.input_tokens, self.cached_tokens, self.output_tokens, self.model
-        )
-
     def _construct_message_param(
         self,
         tool_calls: list[FunctionCall] | None = None,
@@ -120,3 +113,7 @@ class VertexStream(
             start_time=self.start_time,
             end_time=self.end_time,
         )
+
+    @property
+    def cost_metadata(self) -> CostMetadata:
+        return super().cost_metadata

mirascope/core/xai/_utils/__init__.py

@@ -1,6 +1,5 @@
 """xAI utilities for decorator factories."""
 
-from ._calculate_cost import calculate_cost
 from ._setup_call import setup_call
 
-__all__ = ["calculate_cost", "setup_call"]
+__all__ = ["setup_call"]

mirascope/core/xai/call_response.py

@@ -3,10 +3,7 @@
 usage docs: learn/calls.md#handling-responses
 """
 
-from pydantic import computed_field
-
 from ..openai import OpenAICallResponse
-from ._utils import calculate_cost
 
 
 class XAICallResponse(OpenAICallResponse):
@@ -17,11 +14,3 @@ class XAICallResponse(OpenAICallResponse):
     """
 
     _provider = "xai"
-
-    @computed_field
-    @property
-    def cost(self) -> float | None:
-        """Returns the cost of the call."""
-        return calculate_cost(
-            self.input_tokens, self.cached_tokens, self.output_tokens, self.model
-        )

mirascope/llm/__init__.py

@@ -1,6 +1,13 @@
-from ._protocols import LocalProvider, Provider
+from ..core import LocalProvider, Provider, calculate_cost
 from .call_response import CallResponse
 from .llm_call import call
 from .llm_override import override
 
-__all__ = ["CallResponse", "LocalProvider", "Provider", "call", "override"]
+__all__ = [
+    "CallResponse",
+    "LocalProvider",
+    "Provider",
+    "calculate_cost",
+    "call",
+    "override",
+]

mirascope/llm/_protocols.py

@@ -19,22 +19,23 @@ from typing import (
 
 from pydantic import BaseModel
 
-from mirascope.core import BaseDynamicConfig, BaseTool
-from mirascope.core.base import (
+from ..core import BaseDynamicConfig, BaseTool
+from ..core.base import (
     BaseCallResponse,
     BaseCallResponseChunk,
     BaseType,
     CommonCallParams,
 )
-from mirascope.core.base._utils._protocols import (
+from ..core.base._utils._protocols import (
     AsyncLLMFunctionDecorator,
     LLMFunctionDecorator,
     SyncLLMFunctionDecorator,
 )
-from mirascope.core.base.stream_config import StreamConfig
-from mirascope.llm.call_response import CallResponse
-from mirascope.llm.call_response_chunk import CallResponseChunk
-from mirascope.llm.stream import Stream
+from ..core.base.stream_config import StreamConfig
+from ..core.base.types import LocalProvider, Provider
+from .call_response import CallResponse
+from .call_response_chunk import CallResponseChunk
+from .stream import Stream
 
 _BaseStreamT = TypeVar("_BaseStreamT", covariant=True)
 _ResponseModelT = TypeVar("_ResponseModelT", bound=BaseModel | BaseType | Enum)
@@ -61,27 +62,6 @@ _BaseCallResponseChunkT = TypeVar(
 )
 
 
-Provider: TypeAlias = Literal[
-    "anthropic",
-    "azure",
-    "bedrock",
-    "cohere",
-    "gemini",
-    "google",
-    "groq",
-    "litellm",
-    "mistral",
-    "openai",
-    "vertex",
-    "xai",
-]
-
-LocalProvider: TypeAlias = Literal[
-    "ollama",
-    "vllm",
-]
-
-
 class _CallDecorator(
     Protocol[
         _BaseCallResponseT,

mirascope/llm/call_response.py

@@ -7,8 +7,8 @@ from typing import Any, TypeVar
 
 from pydantic import computed_field
 
-from mirascope.core import BaseDynamicConfig
-from mirascope.core.base import (
+from ..core import BaseDynamicConfig
+from ..core.base import (
     BaseCallParams,
     BaseCallResponse,
     BaseMessageParam,
@@ -16,10 +16,10 @@ from mirascope.core.base import (
     Usage,
     transform_tool_outputs,
 )
-from mirascope.core.base.message_param import ToolResultPart
-from mirascope.core.base.types import FinishReason
-from mirascope.llm._response_metaclass import _ResponseMetaclass
-from mirascope.llm.tool import Tool
+from ..core.base.message_param import ToolResultPart
+from ..core.base.types import FinishReason
+from ._response_metaclass import _ResponseMetaclass
+from .tool import Tool
 
 _ResponseT = TypeVar("_ResponseT")
 

mirascope/llm/call_response_chunk.py

@@ -4,9 +4,9 @@ from __future__ import annotations
 
 from typing import Any, Generic, TypeVar
 
-from mirascope.core.base.call_response_chunk import BaseCallResponseChunk
-from mirascope.core.base.types import FinishReason, Usage
-from mirascope.llm._response_metaclass import _ResponseMetaclass
+from ..core.base.call_response_chunk import BaseCallResponseChunk
+from ..core.base.types import CostMetadata, FinishReason, Usage
+from ._response_metaclass import _ResponseMetaclass
 
 _ChunkT = TypeVar("_ChunkT")
 
@@ -40,6 +40,9 @@ class CallResponseChunk(
             "__pydantic_private__",
             "__class_getitem__",
             "_properties",
+            "cost_metadata",
+            "finish_reasons",
+            "usage",
         } | set(object.__getattribute__(self, "_properties"))
 
         if name in special_names:
@@ -58,3 +61,9 @@ class CallResponseChunk(
     @property
     def usage(self) -> Usage | None:
         return self._response.common_usage
+
+    @property
+    def cost_metadata(self) -> CostMetadata:
+        """Get metadata required for cost calculation."""
+
+        return self._response.cost_metadata

mirascope/llm/llm_call.py

@@ -9,27 +9,25 @@ from typing import Any, ParamSpec, TypeVar, cast, get_args
 
 from pydantic import BaseModel
 
-from mirascope.core import BaseTool
-from mirascope.core.base import (
+from ..core import BaseTool
+from ..core.base import (
     BaseCallResponse,
     BaseCallResponseChunk,
     BaseStream,
     BaseType,
     CommonCallParams,
 )
-from mirascope.core.base._utils import fn_is_async
-from mirascope.llm.call_response import CallResponse
-from mirascope.llm.stream import Stream
-
+from ..core.base._utils import fn_is_async
 from ..core.base.stream_config import StreamConfig
+from ..core.base.types import LocalProvider, Provider
 from ._protocols import (
     AsyncLLMFunctionDecorator,
     CallDecorator,
     LLMFunctionDecorator,
-    LocalProvider,
-    Provider,
     SyncLLMFunctionDecorator,
 )
+from .call_response import CallResponse
+from .stream import Stream
 
 _P = ParamSpec("_P")
 _R = TypeVar("_R")
@@ -53,7 +51,7 @@ def _get_local_provider_call(
     client: Any | None,  # noqa: ANN401
 ) -> tuple[Callable, Any | None]:
     if provider == "ollama":
-        from mirascope.core.openai import openai_call
+        from ..core.openai import openai_call
 
         if client:
             return openai_call, client
@@ -62,7 +60,7 @@ def _get_local_provider_call(
         client = OpenAI(api_key="ollama", base_url="http://localhost:11434/v1")
         return openai_call, client
     else:  # provider == "vllm"
-        from mirascope.core.openai import openai_call
+        from ..core.openai import openai_call
 
         if client:
             return openai_call, client
@@ -75,51 +73,51 @@ def _get_local_provider_call(
 def _get_provider_call(provider: Provider) -> Callable:
     """Returns the provider-specific call decorator based on the provider name."""
     if provider == "anthropic":
-        from mirascope.core.anthropic import anthropic_call
+        from ..core.anthropic import anthropic_call
 
         return anthropic_call
     elif provider == "azure":
-        from mirascope.core.azure import azure_call
+        from ..core.azure import azure_call
 
         return azure_call
     elif provider == "bedrock":
-        from mirascope.core.bedrock import bedrock_call
+        from ..core.bedrock import bedrock_call
 
         return bedrock_call
     elif provider == "cohere":
-        from mirascope.core.cohere import cohere_call
+        from ..core.cohere import cohere_call
 
         return cohere_call
     elif provider == "gemini":
-        from mirascope.core.gemini import gemini_call
+        from ..core.gemini import gemini_call
 
         return gemini_call
     elif provider == "google":
-        from mirascope.core.google import google_call
+        from ..core.google import google_call
 
         return google_call
     elif provider == "groq":
-        from mirascope.core.groq import groq_call
+        from ..core.groq import groq_call
 
         return groq_call
     elif provider == "litellm":
-        from mirascope.core.litellm import litellm_call
+        from ..core.litellm import litellm_call
 
         return litellm_call
     elif provider == "mistral":
-        from mirascope.core.mistral import mistral_call
+        from ..core.mistral import mistral_call
 
         return mistral_call
     elif provider == "openai":
-        from mirascope.core.openai import openai_call
+        from ..core.openai import openai_call
 
         return openai_call
     elif provider == "vertex":
-        from mirascope.core.vertex import vertex_call
+        from ..core.vertex import vertex_call
 
         return vertex_call
     elif provider == "xai":
-        from mirascope.core.xai import xai_call
+        from ..core.xai import xai_call
 
         return xai_call
     raise ValueError(f"Unsupported provider: {provider}")
@@ -264,7 +262,7 @@ template.
 Example:
 
 ```python
-from mirascope.llm import call
+from ..llm import call
 
 
 @call(provider="openai", model="gpt-4o-mini")

mirascope/llm/llm_override.py

@@ -5,22 +5,22 @@ from __future__ import annotations
 from collections.abc import Callable
 from typing import TYPE_CHECKING, Any, Literal, ParamSpec, TypeVar, overload
 
-from mirascope.core.base import CommonCallParams
-from mirascope.llm._protocols import Provider
-from mirascope.llm.llm_call import _call
+from ..core.base import CommonCallParams
+from ..core.base.types import LocalProvider, Provider
+from .llm_call import _call
 
 if TYPE_CHECKING:
-    from mirascope.core.anthropic import AnthropicCallParams
-    from mirascope.core.azure import AzureCallParams
-    from mirascope.core.bedrock import BedrockCallParams
-    from mirascope.core.cohere import CohereCallParams
-    from mirascope.core.gemini import GeminiCallParams
-    from mirascope.core.google import GoogleCallParams
-    from mirascope.core.groq import GroqCallParams
-    from mirascope.core.litellm import LiteLLMCallParams
-    from mirascope.core.mistral import MistralCallParams
-    from mirascope.core.openai import OpenAICallParams
-    from mirascope.core.vertex import VertexCallParams
+    from ..core.anthropic import AnthropicCallParams
+    from ..core.azure import AzureCallParams
+    from ..core.bedrock import BedrockCallParams
+    from ..core.cohere import CohereCallParams
+    from ..core.gemini import GeminiCallParams
+    from ..core.google import GoogleCallParams
+    from ..core.groq import GroqCallParams
+    from ..core.litellm import LiteLLMCallParams
+    from ..core.mistral import MistralCallParams
+    from ..core.openai import OpenAICallParams
+    from ..core.vertex import VertexCallParams
 else:
     AnthropicCallParams = AzureCallParams = BedrockCallParams = CohereCallParams = (
         GeminiCallParams
@@ -42,6 +42,8 @@ def override(
     call_params: CommonCallParams | AnthropicCallParams | None = None,
     client: Any = None,  # noqa: ANN401
 ) -> Callable[_P, _R]: ...
+
+
 @overload
 def override(
     provider_agnostic_call: Callable[_P, _R],
@@ -51,6 +53,8 @@ def override(
     call_params: CommonCallParams | AzureCallParams | None = None,
     client: Any = None,  # noqa: ANN401
 ) -> Callable[_P, _R]: ...
+
+
 @overload
 def override(
     provider_agnostic_call: Callable[_P, _R],
@@ -60,6 +64,8 @@ def override(
     call_params: CommonCallParams | BedrockCallParams | None = None,
     client: Any = None,  # noqa: ANN401
 ) -> Callable[_P, _R]: ...
+
+
 @overload
 def override(
     provider_agnostic_call: Callable[_P, _R],
@@ -69,6 +75,8 @@ def override(
     call_params: CommonCallParams | CohereCallParams | None = None,
     client: Any = None,  # noqa: ANN401
 ) -> Callable[_P, _R]: ...
+
+
 @overload
 def override(
     provider_agnostic_call: Callable[_P, _R],
@@ -78,6 +86,8 @@ def override(
     call_params: CommonCallParams | GeminiCallParams | None = None,
     client: Any = None,  # noqa: ANN401
 ) -> Callable[_P, _R]: ...
+
+
 @overload
 def override(
     provider_agnostic_call: Callable[_P, _R],
@@ -98,6 +108,8 @@ def override(
     call_params: CommonCallParams | GroqCallParams | None = None,
     client: Any = None,  # noqa: ANN401
 ) -> Callable[_P, _R]: ...
+
+
 @overload
 def override(
     provider_agnostic_call: Callable[_P, _R],
@@ -107,6 +119,8 @@ def override(
     call_params: CommonCallParams | MistralCallParams | None = None,
     client: Any = None,  # noqa: ANN401
 ) -> Callable[_P, _R]: ...
+
+
 @overload
 def override(
     provider_agnostic_call: Callable[_P, _R],
@@ -116,6 +130,8 @@ def override(
     call_params: CommonCallParams | OpenAICallParams | None = None,
     client: Any = None,  # noqa: ANN401
 ) -> Callable[_P, _R]: ...
+
+
 @overload
 def override(
     provider_agnostic_call: Callable[_P, _R],
@@ -125,6 +141,8 @@ def override(
     call_params: CommonCallParams | LiteLLMCallParams | None = None,
     client: Any = None,  # noqa: ANN401
 ) -> Callable[_P, _R]: ...
+
+
 @overload
 def override(
     provider_agnostic_call: Callable[_P, _R],
@@ -134,6 +152,8 @@ def override(
     call_params: CommonCallParams | VertexCallParams | None = None,
     client: Any = None,  # noqa: ANN401
 ) -> Callable[_P, _R]: ...
+
+
 @overload
 def override(
     provider_agnostic_call: Callable[_P, _R],
@@ -143,6 +163,8 @@ def override(
     call_params: CommonCallParams | None = None,
     client: Any = None,  # noqa: ANN401
 ) -> Callable[_P, _R]: ...
+
+
 @overload
 def override(
     provider_agnostic_call: Callable[_P, _R],
@@ -157,7 +179,7 @@ def override(
 def override(
     provider_agnostic_call: Callable[_P, _R],
     *,
-    provider: Provider | None = None,
+    provider: Provider | LocalProvider | None = None,
     model: str | None = None,
     call_params: CommonCallParams
     | AnthropicCallParams
@@ -185,20 +207,27 @@ def override(
     Returns:
         The overridden function.
     """
-    _original_args = provider_agnostic_call._original_args  # pyright: ignore [reportFunctionMemberAccess]
-    if provider is not None and not model and call_params is None and client is None:
+    if (provider and not model) or (model and not provider):
         raise ValueError(
-            "If provider is specified, model or call_params must also be specified."
+            "Provider and model must both be overridden if either is overridden."
         )
 
+    original_provider = provider_agnostic_call._original_provider  # pyright: ignore [reportFunctionMemberAccess]
+    original_args = provider_agnostic_call._original_args  # pyright: ignore [reportFunctionMemberAccess]
+
+    # Note: if switching providers, we will always use `client` since `original_client`
+    # would be from a different provider and fail.
+    if provider and provider == original_provider:
+        client = client or original_args["client"]
+
     return _call(  # pyright: ignore [reportReturnType]
-        provider=provider or provider_agnostic_call._original_provider,  # pyright: ignore [reportFunctionMemberAccess]
-        model=model or _original_args["model"],
-        stream=_original_args["stream"],
-        tools=_original_args["tools"],
-        response_model=_original_args["response_model"],
-        output_parser=_original_args["output_parser"],
-        json_mode=_original_args["json_mode"],
-        client=client or _original_args["client"],
-        call_params=call_params or _original_args["call_params"],
+        provider=provider or original_provider,
+        model=model or original_args["model"],
+        stream=original_args["stream"],
+        tools=original_args["tools"],
+        response_model=original_args["response_model"],
+        output_parser=original_args["output_parser"],
+        json_mode=original_args["json_mode"],
+        client=client,
+        call_params=call_params or original_args["call_params"],
     )(provider_agnostic_call._original_fn)  # pyright: ignore [reportFunctionMemberAccess]

mirascope/llm/stream.py

@@ -5,7 +5,7 @@ from __future__ import annotations
 from collections.abc import AsyncGenerator, Generator
 from typing import Any, Generic, TypeVar
 
-from mirascope.core.base import (
+from ..core.base import (
     BaseCallParams,
     BaseCallResponse,
     BaseCallResponseChunk,
@@ -13,12 +13,12 @@ from mirascope.core.base import (
     BaseMessageParam,
     BaseTool,
 )
-from mirascope.core.base.call_response import JsonableType
-from mirascope.core.base.stream import BaseStream
-from mirascope.core.base.types import FinishReason
-from mirascope.llm.call_response import CallResponse
-from mirascope.llm.call_response_chunk import CallResponseChunk
-from mirascope.llm.tool import Tool
+from ..core.base.call_response import JsonableType
+from ..core.base.stream import BaseStream
+from ..core.base.types import FinishReason
+from ..llm.call_response import CallResponse
+from ..llm.call_response_chunk import CallResponseChunk
+from .tool import Tool
 
 _BaseCallResponseT = TypeVar("_BaseCallResponseT", bound=BaseCallResponse)
 _BaseCallResponseChunkT = TypeVar(

mirascope/llm/tool.py

@@ -6,7 +6,7 @@ from typing import Any, TypeVar
 
 from pydantic._internal._model_construction import ModelMetaclass
 
-from mirascope.core.base.tool import BaseTool
+from ..core.base.tool import BaseTool
 
 _ToolResponseT = TypeVar("_ToolResponseT", bound=BaseTool)
 

mirascope/retries/fallback.py

@@ -8,7 +8,7 @@ from typing_extensions import NotRequired, Required, TypedDict
 
 from .. import llm
 from ..core.base import CommonCallParams
-from ..llm._protocols import Provider
+from ..core.base.types import Provider
 
 _P = ParamSpec("_P")
 _R = TypeVar("_R")

{mirascope-1.19.0.dist-info → mirascope-1.20.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mirascope
-Version: 1.19.0
+Version: 1.20.0
 Summary: LLM abstractions that aren't obstructions
 Project-URL: Homepage, https://mirascope.com
 Project-URL: Documentation, https://mirascope.com/WELCOME