mirascope 1.16.8__py3-none-any.whl → 1.17.0__py3-none-any.whl

mirascope/__init__.py

@@ -6,6 +6,15 @@ from contextlib import suppress
 with suppress(ImportError):
     from . import core as core
 
+from .core import (
+    BaseDynamicConfig,
+    BaseMessageParam,
+    BaseTool,
+    BaseToolKit,
+    Messages,
+    prompt_template,
+)
+
 with suppress(ImportError):
     from . import integrations as integrations
 
@@ -14,4 +23,14 @@ with suppress(ImportError):
 
 __version__ = importlib.metadata.version("mirascope")
 
-__all__ = ["core", "integrations", "retries", "__version__"]
+__all__ = [
+    "BaseDynamicConfig",
+    "BaseMessageParam",
+    "BaseTool",
+    "BaseToolKit",
+    "core",
+    "integrations",
+    "prompt_template",
+    "retries",
+    "__version__",
+]

mirascope/core/anthropic/_utils/_convert_message_params.py

@@ -5,6 +5,7 @@ import base64
 from anthropic.types import MessageParam
 
 from ...base import BaseMessageParam
+from ...base._utils._parse_content_template import _load_media, get_image_type
 
 
 def convert_message_params(
@@ -45,6 +46,18 @@ def convert_message_params(
                             },
                         }
                     )
+                elif part.type == "image_url":
+                    image = _load_media(part.url)
+                    converted_content.append(
+                        {
+                            "type": "image",
+                            "source": {
+                                "data": base64.b64encode(image).decode("utf-8"),
+                                "media_type": f"image/{get_image_type(image)}",
+                                "type": "base64",
+                            },
+                        }
+                    )
                 elif part.type == "document":
                     if part.media_type != "application/pdf":
                         raise ValueError(

mirascope/core/anthropic/call_response.py

@@ -186,5 +186,13 @@ class AnthropicCallResponse(
         return _convert_finish_reasons_to_common_finish_reasons(self.finish_reasons)
 
     @property
-    def common_message_param(self) -> list[BaseMessageParam]:
-        return AnthropicMessageParamConverter.from_provider([(self.message_param)])
+    def common_message_param(self) -> BaseMessageParam:
+        return AnthropicMessageParamConverter.from_provider([(self.message_param)])[0]
+
+    @property
+    def common_user_message_param(self) -> BaseMessageParam | None:
+        if not self.user_message_param:
+            return None
+        return AnthropicMessageParamConverter.from_provider(
+            [(self.user_message_param)]
+        )[0]

mirascope/core/azure/_utils/_convert_message_params.py

@@ -51,6 +51,16 @@ def convert_message_params(
                             },
                         }
                     )
+                elif part.type == "image_url":
+                    converted_content.append(
+                        {
+                            "type": "image_url",
+                            "image_url": {
+                                "url": part.url,
+                                "detail": part.detail if part.detail else "auto",
+                            },
+                        }
+                    )
                 elif part.type == "tool_call":
                     converted_message_param = AssistantMessage(
                         tool_calls=[

mirascope/core/azure/_utils/_message_param_converter.py

@@ -4,14 +4,41 @@ from typing import cast
 from azure.ai.inference.models import (
     AssistantMessage,
     ChatRequestMessage,
+    ContentItem,
+    ImageContentItem,
+    TextContentItem,
+    ToolMessage,
+    UserMessage,
 )
 
-from mirascope.core import BaseMessageParam
 from mirascope.core.azure._utils import convert_message_params
+from mirascope.core.base import (
+    BaseMessageParam,
+    ImageURLPart,
+    TextPart,
+    ToolCallPart,
+    ToolResultPart,
+)
 from mirascope.core.base._utils._base_message_param_converter import (
     BaseMessageParamConverter,
 )
-from mirascope.core.base.message_param import ToolCallPart
+
+
+def _parse_content(content: list[ContentItem]) -> list[TextPart | ImageURLPart]:
+    converted_parts = []
+    for part in content:
+        if isinstance(part, TextContentItem):
+            converted_parts.append(TextPart(type="text", text=part.text))
+        elif isinstance(part, ImageContentItem):
+            converted_parts.append(
+                ImageURLPart(
+                    type="image_url",
+                    url=part.image_url.url,
+                    detail=part.image_url.detail,
+                )
+            )
+
+    return converted_parts
 
 
 class AzureMessageParamConverter(BaseMessageParamConverter):
@@ -19,38 +46,72 @@ class AzureMessageParamConverter(BaseMessageParamConverter):
 
     @staticmethod
     def to_provider(message_params: list[BaseMessageParam]) -> list[ChatRequestMessage]:
-        """
-        Convert from Mirascope `BaseMessageParam` to Azure's `ChatRequestMessage`.
-        """
+        """Convert from Mirascope `BaseMessageParam` to Azure's `ChatRequestMessage`."""
         return convert_message_params(
             cast(list[BaseMessageParam | ChatRequestMessage], message_params)
         )
 
     @staticmethod
-    def from_provider(message_params: list[AssistantMessage]) -> list[BaseMessageParam]:
+    def from_provider(
+        message_params: list[ChatRequestMessage],
+    ) -> list[BaseMessageParam]:
         """
         Convert from Azure's `AssistantMessage` back to Mirascope `BaseMessageParam`.
         """
         converted: list[BaseMessageParam] = []
         for message_param in message_params:
-            role: str = "assistant"
-            if not message_param.tool_calls:
-                converted.append(
-                    BaseMessageParam(role=role, content=message_param.content or "")
-                )
-                continue
-
-            contents = []
-            if tool_calls := message_param.tool_calls:
-                for tool_call in tool_calls:
-                    contents.append(
+            if isinstance(message_param, UserMessage):
+                if isinstance(message_param.content, str):
+                    converted.append(
+                        BaseMessageParam(role="user", content=message_param.content)
+                    )
+                elif isinstance(message_param.content, list):
+                    converted_parts = _parse_content(message_param.content)
+                    converted.append(
+                        BaseMessageParam(role="user", content=converted_parts)
+                    )
+            elif isinstance(message_param, AssistantMessage):
+                converted_parts = []
+                if tool_calls := message_param.tool_calls:
+                    converted_parts.extend(
                         ToolCallPart(
                             type="tool_call",
                             name=tool_call.function.name,
                             id=tool_call.id,
                             args=json.loads(tool_call.function.arguments),
                         )
+                        for tool_call in tool_calls
                     )
-
-            converted.append(BaseMessageParam(role="tool", content=contents))
+                if isinstance(message_param.content, str):
+                    converted_parts.append(
+                        TextPart(type="text", text=message_param.content)
+                    )
+                elif isinstance(message_param.content, list):
+                    converted_parts = _parse_content(message_param.content)
+                else:
+                    converted_parts.append(TextPart(type="text", text=""))
+                converted.append(
+                    BaseMessageParam(
+                        role="assistant",
+                        content=converted_parts[0].text
+                        if len(converted_parts) == 1
+                        and isinstance(converted_parts[0], TextPart)
+                        else converted_parts,
+                    )
+                )
+            elif isinstance(message_param, ToolMessage):
+                converted.append(
+                    BaseMessageParam(
+                        role="tool",
+                        content=[
+                            ToolResultPart(
+                                type="tool_result",
+                                name="",
+                                content=message_param.content,
+                                id=message_param.tool_call_id,
+                                is_error=False,
+                            )
+                        ],
+                    )
+                )
         return converted

mirascope/core/azure/call_response.py

@@ -199,5 +199,11 @@ class AzureCallResponse(
         )
 
     @property
-    def common_message_param(self) -> list[BaseMessageParam]:
-        return AzureMessageParamConverter.from_provider([self.message_param])
+    def common_message_param(self) -> BaseMessageParam:
+        return AzureMessageParamConverter.from_provider([self.message_param])[0]
+
+    @property
+    def common_user_message_param(self) -> BaseMessageParam | None:
+        if not self.user_message_param:
+            return None
+        return AzureMessageParamConverter.from_provider([self.user_message_param])[0]

mirascope/core/base/__init__.py

@@ -12,10 +12,12 @@ from .from_call_args import FromCallArgs
 from .merge_decorators import merge_decorators
 from .message_param import (
     AudioPart,
+    AudioURLPart,
     BaseMessageParam,
     CacheControlPart,
     DocumentPart,
     ImagePart,
+    ImageURLPart,
     TextPart,
     ToolCallPart,
     ToolResultPart,
@@ -32,6 +34,7 @@ from .types import AudioSegment
 
 __all__ = [
     "AudioPart",
+    "AudioURLPart",
     "AudioSegment",
     "BaseCallKwargs",
     "BaseCallParams",
@@ -52,6 +55,7 @@ __all__ = [
     "FromCallArgs",
     "GenerateJsonSchemaNoTitles",
     "ImagePart",
+    "ImageURLPart",
     "merge_decorators",
     "metadata",
     "Messages",

mirascope/core/base/_create.py

@@ -166,7 +166,7 @@ def create_factory(  # noqa: ANN202
             @wraps(fn)
             async def inner_async(
                 *args: _P.args, **kwargs: _P.kwargs
-            ) -> TCallResponse | _ParsedOutputT:
+            ) -> TCallResponse | _ParsedOutputT:  # pyright: ignore [reportInvalidTypeForm]
                 fn_args = get_fn_args(fn, args, kwargs)
                 dynamic_config = await get_dynamic_configuration(fn, args, kwargs)
                 nonlocal client

mirascope/core/base/_utils/_convert_function_to_base_tool.py

@@ -114,7 +114,7 @@ def convert_function_to_base_tool(
     if examples:
         model.model_config["json_schema_extra"] = {"examples": examples}
 
-    def call(self: base) -> Any:  # noqa: ANN401
+    def call(self: base) -> Any:  # pyright: ignore [reportInvalidTypeForm] # noqa: ANN401
         return fn(
             **(
                 ({"self": self} if has_self else {})
@@ -129,7 +129,7 @@ def convert_function_to_base_tool(
             )
         )
 
-    async def call_async(self: base) -> Callable:
+    async def call_async(self: base) -> Callable:  # pyright: ignore [reportInvalidTypeForm]
         return await call(self)
 
     if inspect.iscoroutinefunction(fn):

mirascope/core/base/_utils/_convert_messages_to_message_params.py

@@ -10,10 +10,12 @@ from typing_extensions import TypeIs
 
 from ..message_param import (
     AudioPart,
+    AudioURLPart,
     BaseMessageParam,
     CacheControlPart,
     DocumentPart,
     ImagePart,
+    ImageURLPart,
     TextPart,
 )
 from ..types import AudioSegment, Image, has_pil_module, has_pydub_module
@@ -29,17 +31,33 @@ def _convert_message_sequence_part_to_content_part(
     | TextPart
     | CacheControlPart
     | ImagePart
+    | ImageURLPart
     | Image.Image
     | AudioPart
+    | AudioURLPart
     | AudioSegment
     | Wave_read
     | DocumentPart,
-) -> TextPart | ImagePart | AudioPart | CacheControlPart | DocumentPart:
+) -> (
+    TextPart
+    | ImagePart
+    | ImageURLPart
+    | AudioPart
+    | AudioURLPart
+    | CacheControlPart
+    | DocumentPart
+):
     if isinstance(message_sequence_part, str):
         return TextPart(text=message_sequence_part, type="text")
     elif isinstance(
         message_sequence_part,
-        TextPart | ImagePart | AudioPart | CacheControlPart | DocumentPart,
+        TextPart
+        | ImagePart
+        | ImageURLPart
+        | AudioPart
+        | AudioURLPart
+        | CacheControlPart
+        | DocumentPart,
     ):
         return message_sequence_part
     elif has_pil_module and isinstance(message_sequence_part, Image.Image):
@@ -82,13 +100,26 @@ def convert_message_content_to_message_param_content(
         | TextPart
         | CacheControlPart
         | ImagePart
+        | ImageURLPart
         | Image.Image
         | AudioPart
+        | AudioURLPart
         | AudioSegment
         | Wave_read
         | DocumentPart
     ],
-) -> list[TextPart | ImagePart | AudioPart | CacheControlPart | DocumentPart] | str:
+) -> (
+    list[
+        TextPart
+        | ImagePart
+        | ImageURLPart
+        | AudioPart
+        | AudioURLPart
+        | CacheControlPart
+        | DocumentPart
+    ]
+    | str
+):
     if isinstance(message_sequence, str):
         return message_sequence
     return [
@@ -113,8 +144,10 @@ def convert_messages_to_message_params(
         | TextPart
         | CacheControlPart
         | ImagePart
+        | ImageURLPart
         | Image.Image
         | AudioPart
+        | AudioURLPart
         | AudioSegment
         | Wave_read
         | DocumentPart

mirascope/core/base/_utils/_parse_content_template.py

@@ -9,10 +9,12 @@ from typing_extensions import TypedDict
 
 from ..message_param import (
     AudioPart,
+    AudioURLPart,
     BaseMessageParam,
     CacheControlPart,
     DocumentPart,
     ImagePart,
+    ImageURLPart,
     TextPart,
 )
 from ..types import Image, has_pil_module
@@ -138,7 +140,12 @@ def _load_media(source: str | bytes) -> bytes:
 
 def _construct_image_part(
     source: str | bytes | Image.Image, options: dict[str, str] | None
-) -> ImagePart:
+) -> ImagePart | ImageURLPart:
+    detail = None
+    if options:
+        detail = options.get("detail", None)
+    if isinstance(source, str) and source.startswith(("http://", "https://", "gs://")):
+        return ImageURLPart(type="image_url", url=source, detail=detail)
     if isinstance(source, Image.Image):
         image = pil_image_to_bytes(source)
         media_type = (
@@ -149,9 +156,6 @@ def _construct_image_part(
     else:
         image = _load_media(source)
         media_type = f"image/{get_image_type(image)}"
-    detail = None
-    if options:
-        detail = options.get("detail", None)
     return ImagePart(
         type="image",
         media_type=media_type,
@@ -160,8 +164,10 @@ def _construct_image_part(
     )
 
 
-def _construct_audio_part(source: str | bytes) -> AudioPart:
+def _construct_audio_part(source: str | bytes) -> AudioPart | AudioURLPart:
     # Note: audio does not currently support additional options, at least for now.
+    if isinstance(source, str) and source.startswith(("http://", "https://", "gs://")):
+        return AudioURLPart(type="audio_url", url=source)
     audio = _load_media(source)
     return AudioPart(
         type="audio", media_type=f"audio/{get_audio_type(audio)}", audio=audio
@@ -179,8 +185,16 @@ def _construct_document_part(source: str | bytes) -> DocumentPart:
 
 def _construct_parts(
     part: _Part, attrs: dict[str, Any]
-) -> list[TextPart | ImagePart | AudioPart | CacheControlPart | DocumentPart]:
-    if part["type"] == "image":
+) -> list[
+    TextPart
+    | ImagePart
+    | ImageURLPart
+    | AudioPart
+    | AudioURLPart
+    | CacheControlPart
+    | DocumentPart
+]:
+    if part["type"] in "image":
         source = attrs[part["template"]]
         return [_construct_image_part(source, part["options"])] if source else []
     elif part["type"] == "images":
@@ -229,7 +243,13 @@ def _construct_parts(
         source = attrs[part["template"]]
         if not isinstance(
             source,
-            TextPart | ImagePart | AudioPart | CacheControlPart | DocumentPart,
+            TextPart
+            | ImagePart
+            | ImageURLPart
+            | AudioPart
+            | AudioURLPart
+            | CacheControlPart
+            | DocumentPart,
         ):
             raise ValueError(
                 f"When using 'part' template, '{part['template']}' must be a valid content part."
@@ -246,7 +266,13 @@ def _construct_parts(
         for source in sources:
             if not isinstance(
                 source,
-                TextPart | ImagePart | AudioPart | CacheControlPart | DocumentPart,
+                TextPart
+                | ImagePart
+                | ImageURLPart
+                | AudioPart
+                | AudioURLPart
+                | CacheControlPart
+                | DocumentPart,
             ):
                 raise ValueError(
                     f"When using 'parts' template, '{part['template']}' must be a list of valid content parts."

mirascope/core/base/call_response.py

@@ -275,10 +275,16 @@ class BaseCallResponse(
 
     @property
     @abstractmethod
-    def common_message_param(self) -> list[BaseMessageParam]:
+    def common_message_param(self) -> BaseMessageParam:
         """Provider-agnostic assistant message param."""
         ...
 
+    @property
+    @abstractmethod
+    def common_user_message_param(self) -> BaseMessageParam | None:
+        """Provider-agnostic user message param."""
+        ...
+
     @property
     def common_tools(self) -> list[Tool] | None:
         """Provider-agnostic tools."""

mirascope/core/base/message_param.py

@@ -49,18 +49,44 @@ class ImagePart(BaseModel):
     detail: str | None
 
 
+class ImageURLPart(BaseModel):
+    """A content part for images with a URL or base64 encoded image data.
+
+    Attributes:
+        type: Always "image_url"
+        url: The URL to the image
+        detail: (Optional) The detail to use for the image (supported by OpenAI)
+    """
+
+    type: Literal["image_url"]
+    url: str
+    detail: str | None
+
+
 class AudioPart(BaseModel):
     """A content part for audio.
 
     Attributes:
         type: Always "audio"
         media_type: The media type (e.g. audio/wav)
-        audio: The raw audio bytes
+        audio: The raw audio bytes or base64 encoded audio data
     """
 
     type: Literal["audio"]
     media_type: str
-    audio: bytes
+    audio: bytes | str
+
+
+class AudioURLPart(BaseModel):
+    """A content part for audio with a URL or base64 encoded audio data.
+
+    Attributes:
+        type: Always "audio_url"
+        url: The URL to the audio
+    """
+
+    type: Literal["audio_url"]
+    url: str
 
 
 class DocumentPart(BaseModel):
@@ -125,7 +151,9 @@ class BaseMessageParam(BaseModel):
         | Sequence[
             TextPart
             | ImagePart
+            | ImageURLPart
             | AudioPart
+            | AudioURLPart
             | CacheControlPart
             | DocumentPart
             | ToolCallPart

mirascope/core/base/messages.py

@@ -10,10 +10,12 @@ from ._utils._convert_messages_to_message_params import (
 )
 from .message_param import (
     AudioPart,
+    AudioURLPart,
     BaseMessageParam,
     CacheControlPart,
     DocumentPart,
     ImagePart,
+    ImageURLPart,
     TextPart,
 )
 from .types import AudioSegment
@@ -27,8 +29,10 @@ class Messages:
             | TextPart
             | CacheControlPart
             | ImagePart
+            | ImageURLPart
             | Image.Image
             | AudioPart
+            | AudioURLPart
             | AudioSegment
             | Wave_read
             | DocumentPart
@@ -46,8 +50,10 @@ class Messages:
             | TextPart
             | CacheControlPart
             | ImagePart
+            | ImageURLPart
             | Image.Image
             | AudioPart
+            | AudioURLPart
             | AudioSegment
             | Wave_read
             | DocumentPart
@@ -67,8 +73,10 @@ class Messages:
             | TextPart
             | CacheControlPart
             | ImagePart
+            | ImageURLPart
             | Image.Image
             | AudioPart
+            | AudioURLPart
             | AudioSegment
             | Wave_read
             | DocumentPart
@@ -88,8 +96,10 @@ class Messages:
             | TextPart
             | CacheControlPart
             | ImagePart
+            | ImageURLPart
             | Image.Image
             | AudioPart
+            | AudioURLPart
             | AudioSegment
             | Wave_read
             | DocumentPart

mirascope/core/bedrock/_utils/_convert_message_params.py

@@ -3,6 +3,8 @@
 from typing import cast
 
 from ...base import BaseMessageParam
+from ...base._utils import get_image_type
+from ...base._utils._parse_content_template import _load_media
 from .._types import ConversationRoleType, InternalBedrockMessageParam
 
 
@@ -37,7 +39,22 @@ def convert_message_params(
                             " currently only supports JPEG, PNG, GIF, and WebP images."
                         )
                     converted_content.append(
-                        {"format": part.media_type, "bytes": part.image}
+                        {
+                            "image": {
+                                "format": part.media_type.split("/")[-1],
+                                "source": {"bytes": part.image},
+                            }
+                        }
+                    )
+                elif part.type == "image_url":
+                    image = _load_media(part.url)
+                    converted_content.append(
+                        {
+                            "image": {
+                                "format": get_image_type(image),
+                                "source": {"bytes": image},
+                            },
+                        }
                     )
                 elif part.type == "tool_result":
                     if converted_content:

mirascope/core/bedrock/call_response.py

@@ -232,5 +232,11 @@ class BedrockCallResponse(
         return _convert_finish_reasons_to_common_finish_reasons(self.finish_reasons)
 
     @property
-    def common_message_param(self) -> list[BaseMessageParam]:
-        return BedrockMessageParamConverter.from_provider([self.message_param])
+    def common_message_param(self) -> BaseMessageParam:
+        return BedrockMessageParamConverter.from_provider([self.message_param])[0]
+
+    @property
+    def common_user_message_param(self) -> BaseMessageParam | None:
+        if not self.user_message_param:
+            return None
+        return BedrockMessageParamConverter.from_provider([self.user_message_param])[0]  # pyright: ignore [reportArgumentType]

mirascope/core/cohere/_utils/_message_param_converter.py

@@ -29,9 +29,10 @@ class CohereMessageParamConverter(BaseMessageParamConverter):
         """
         converted = []
         for message_param in message_params:
+            role = getattr(message_param, "role", "assistant")
             if not message_param.tool_calls:
                 converted.append(
-                    BaseMessageParam(role="assistant", content=message_param.message)
+                    BaseMessageParam(role=role, content=message_param.message)
                 )
                 continue
 
@@ -49,5 +50,5 @@ class CohereMessageParamConverter(BaseMessageParamConverter):
                     )
                 )
 
-            converted.append(BaseMessageParam(role="tool", content=converted_content))
+            converted.append(BaseMessageParam(role=role, content=converted_content))
         return converted