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

mirascope/core/mistral/call_response_chunk.py

@@ -8,6 +8,7 @@ from typing import cast
 from mistralai.models import CompletionChunk, FinishReason, UsageInfo
 
 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,
 )
@@ -92,6 +93,11 @@ class MistralCallResponseChunk(BaseCallResponseChunk[CompletionChunk, FinishReas
             return self.usage.completion_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/mistral/stream.py

@@ -17,7 +17,7 @@ from mistralai.models import (
 )
 
 from ..base.stream import BaseStream
-from ._utils import calculate_cost
+from ..base.types import CostMetadata
 from .call_params import MistralCallParams
 from .call_response import MistralCallResponse
 from .call_response_chunk import MistralCallResponseChunk
@@ -62,13 +62,6 @@ class MistralStream(
 
     _provider = "mistral"
 
-    @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 | None = None, content: str | None = None
     ) -> AssistantMessage:
@@ -121,3 +114,7 @@ class MistralStream(
             start_time=self.start_time,
             end_time=self.end_time,
         )
+
+    @property
+    def cost_metadata(self) -> CostMetadata:
+        return super().cost_metadata

mirascope/core/openai/_utils/__init__.py

@@ -1,13 +1,11 @@
 """OpenAI 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/openai/_utils/_convert_message_params.py

@@ -83,17 +83,17 @@ def convert_message_params(
                     audio = _load_media(part.url)
                     audio_type = get_audio_type(audio)
                     if audio_type not in [
-                        "audio/wav",
-                        "audio/mp3",
+                        "wav",
+                        "mp3",
                     ]:
                         raise ValueError(
-                            f"Unsupported audio media type: {audio_type}. "
+                            f"Unsupported audio media type: audio/{audio_type}. "
                             "OpenAI currently only supports WAV and MP3 audio file types."
                         )
                     converted_content.append(
                         {
                             "input_audio": {
-                                "format": audio_type.split("/")[-1],
+                                "format": audio_type,
                                 "data": base64.b64encode(audio).decode("utf-8"),
                             },
                             "type": "input_audio",

mirascope/core/openai/call_response.py

@@ -23,8 +23,13 @@ from ..base import (
     BaseCallResponse,
     transform_tool_outputs,
 )
-from ..base.types import FinishReason
-from ._utils import calculate_cost
+from ..base._utils._get_image_dimensions import (
+    get_image_dimensions,
+)
+from ..base.types import (
+    CostMetadata,
+    FinishReason,
+)
 from ._utils._message_param_converter import OpenAIMessageParamConverter
 from .call_params import OpenAICallParams
 from .dynamic_config import OpenAIDynamicConfig
@@ -135,14 +140,6 @@ class OpenAICallResponse(
         """Returns the number of output tokens."""
         return self.usage.completion_tokens if self.usage else None
 
-    @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) -> SerializeAsAny[ChatCompletionAssistantMessageParam]:
@@ -248,3 +245,26 @@ class OpenAICallResponse(
         if not self.user_message_param:
             return None
         return OpenAIMessageParamConverter.from_provider([self.user_message_param])[0]
+
+    @property
+    def cost_metadata(self) -> CostMetadata:
+        cost_metadata = super().cost_metadata
+        for message in self.messages:
+            if message.get("role") != "user":
+                continue
+            for part in message.get("content") or []:
+                if not isinstance(part, dict):
+                    continue
+                if not (part.get("type") == "image_url" and "image_url" in part):
+                    continue
+                url = part["image_url"].get("url", "")
+                detail = part["image_url"].get("detail", "auto")
+
+                dimensions = get_image_dimensions(url)
+                if not dimensions:
+                    continue
+                dimensions.detail = detail
+                if cost_metadata.images is None:
+                    cost_metadata.images = []
+                cost_metadata.images.append(dimensions)
+        return cost_metadata

mirascope/core/openai/call_response_chunk.py

@@ -14,6 +14,7 @@ from openai.types.completion_usage import CompletionUsage
 from pydantic import SkipValidation, computed_field
 
 from ..base import BaseCallResponseChunk
+from ..base.types import CostMetadata
 
 FinishReason = Choice.__annotations__["finish_reason"]
 
@@ -127,6 +128,11 @@ class OpenAICallResponseChunk(BaseCallResponseChunk[ChatCompletionChunk, FinishR
             return audio.get("transcript")
         return None
 
+    @property
+    def cost_metadata(self) -> CostMetadata:
+        """Returns the cost metadata."""
+        return super().cost_metadata
+
     @property
     def common_finish_reasons(self) -> list[FinishReason] | None:
         """Provider-agnostic finish reasons."""

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,14 @@
-from ._protocols import LocalProvider, Provider
+from ..core import CostMetadata, 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",
+    "CostMetadata",
+    "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")