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

mirascope/core/mistral/_utils/_message_param_converter.py

@@ -1,176 +0,0 @@
-import base64
-import json
-import re
-from typing import cast
-
-from mistralai.models import (
-    AssistantMessage,
-    ImageURLChunk,
-    ReferenceChunk,
-    SystemMessage,
-    TextChunk,
-    ToolMessage,
-    UserMessage,
-)
-
-from mirascope.core.base._utils._base_message_param_converter import (
-    BaseMessageParamConverter,
-)
-from mirascope.core.mistral._utils import convert_message_params
-
-from ...base import BaseMessageParam, ImagePart, TextPart, ToolResultPart
-from ...base.message_param import ImageURLPart, ToolCallPart
-
-
-def _create_image_part_from_data_url(image_url: str) -> ImagePart | None:
-    match = re.match(r"data:(image/\w+);base64,(.+)", image_url)
-    if not match:
-        return None
-    mime_type = match.group(1)
-    image_base64 = match.group(2)
-    image_data = base64.b64decode(image_base64)
-    return ImagePart(
-        type="image",
-        media_type=mime_type,
-        image=image_data,
-        detail=None,
-    )
-
-
-class MistralMessageParamConverter(BaseMessageParamConverter):
-    """Converts between Mistral `AssistantMessage` and Mirascope `BaseMessageParam`."""
-
-    @staticmethod
-    def to_provider(message_params: list[BaseMessageParam]) -> list:
-        """
-        Convert from Mirascope `BaseMessageParam` to Mistral messages (AssistantMessage, etc.).
-        Mistral’s code snippet references convert_message_params returning a list of
-        [AssistantMessage|SystemMessage|ToolMessage|UserMessage].
-        """
-        return convert_message_params(
-            cast(
-                list[
-                    BaseMessageParam
-                    | AssistantMessage
-                    | SystemMessage
-                    | ToolMessage
-                    | UserMessage
-                ],
-                message_params,
-            )
-        )
-
-    @staticmethod
-    def from_provider(
-        message_params: list[
-            AssistantMessage | ToolMessage | SystemMessage | UserMessage
-        ],
-    ) -> list[BaseMessageParam]:
-        """
-        Convert from Mistral's `AssistantMessage` to Mirascope `BaseMessageParam`.
-        """
-        converted: list[BaseMessageParam] = []
-        for message_param in message_params:
-            content = message_param.content
-
-            converted_parts = []
-
-            if tool_calls := getattr(message_param, "tool_calls", None):
-                for tool in tool_calls:
-                    arguments = tool.function.arguments
-                    converted.append(
-                        BaseMessageParam(
-                            role="tool",
-                            content=[
-                                ToolCallPart(
-                                    type="tool_call",
-                                    name=tool.function.name,
-                                    id=tool.id,
-                                    args=json.loads(arguments)
-                                    if isinstance(arguments, str)
-                                    else arguments,
-                                )
-                            ],
-                        )
-                    )
-            elif isinstance(message_param, ToolMessage):
-                converted.append(
-                    BaseMessageParam(
-                        role="tool",
-                        content=[
-                            ToolResultPart(
-                                type="tool_result",
-                                name=message_param.name,  # pyright: ignore [reportArgumentType]
-                                content=message_param.content,  # pyright: ignore [reportArgumentType]
-                                id=message_param.tool_call_id,  # pyright: ignore [reportArgumentType]
-                            )
-                        ],
-                    )
-                )
-            elif isinstance(content, str):
-                converted_parts.append(TextPart(type="text", text=content))
-            elif isinstance(content, list):
-                for chunk in content:
-                    if isinstance(chunk, TextChunk):
-                        converted_parts.append(TextPart(type="text", text=chunk.text))
-
-                    elif isinstance(chunk, ImageURLChunk):
-                        image_url = chunk.image_url
-                        if isinstance(image_url, str):
-                            if image_part := _create_image_part_from_data_url(
-                                image_url
-                            ):
-                                converted_parts.append(image_part)
-                            else:
-                                converted_parts.append(
-                                    ImageURLPart(
-                                        type="image_url",
-                                        url=image_url,
-                                        detail=None,
-                                    )
-                                )
-
-                        else:
-                            img_url_str = image_url.url  # type: ignore
-                            if image_part := _create_image_part_from_data_url(
-                                img_url_str
-                            ):
-                                converted_parts.append(image_part)
-                            else:
-                                converted_parts.append(
-                                    ImageURLPart(
-                                        type="image_url",
-                                        url=img_url_str,
-                                        detail=image_url.detail
-                                        if isinstance(image_url.detail, str)
-                                        else None,
-                                    )
-                                )
-                    elif isinstance(chunk, ReferenceChunk):
-                        raise ValueError(
-                            "ReferenceChunk is not supported for conversion to BaseMessageParam."
-                        )
-
-                    else:
-                        # Unknown chunk type
-                        raise ValueError(
-                            f"Unsupported ContentChunk type: {type(chunk).__name__}"
-                        )
-
-            if len(converted_parts) == 1 and isinstance(converted_parts[0], TextPart):
-                converted.append(
-                    BaseMessageParam(
-                        role=message_param.role,  # pyright: ignore [reportArgumentType]
-                        content=converted_parts[0].text,
-                    )
-                )
-            else:
-                if converted_parts:
-                    converted.append(
-                        BaseMessageParam(
-                            role=message_param.role,  # pyright: ignore [reportArgumentType]
-                            content=converted_parts,
-                        )
-                    )
-
-        return converted

mirascope/core/mistral/_utils/_setup_call.py

@@ -1,154 +0,0 @@
-"""This module contains the setup_call function for Mistral tools."""
-
-import os
-from collections.abc import (
-    Awaitable,
-    Callable,
-)
-from typing import Any, cast, overload
-
-from mistralai import Mistral
-from mistralai.models import (
-    AssistantMessage,
-    ChatCompletionResponse,
-    CompletionEvent,
-    ResponseFormat,
-    SystemMessage,
-    TextChunk,
-    ToolChoiceEnum,
-    ToolMessage,
-    UserMessage,
-)
-from pydantic import BaseModel
-
-from ... import BaseMessageParam
-from ...base import BaseTool, _utils
-from ...base._utils import (
-    AsyncCreateFn,
-    CreateFn,
-    fn_is_async,
-    get_async_create_fn,
-    get_create_fn,
-)
-from ...base.call_params import CommonCallParams
-from ...base.stream_config import StreamConfig
-from .._call_kwargs import MistralCallKwargs
-from ..call_params import MistralCallParams
-from ..dynamic_config import MistralDynamicConfig
-from ..tool import MistralTool
-from ._convert_common_call_params import convert_common_call_params
-from ._convert_message_params import convert_message_params
-
-
-@overload
-def setup_call(
-    *,
-    model: str,
-    client: Mistral | None,
-    fn: Callable[..., Awaitable[MistralDynamicConfig]],
-    fn_args: dict[str, Any],
-    dynamic_config: MistralDynamicConfig,
-    tools: list[type[BaseTool] | Callable] | None,
-    json_mode: bool,
-    call_params: MistralCallParams | CommonCallParams,
-    response_model: type[BaseModel] | None,
-    stream: bool | StreamConfig,
-) -> tuple[
-    AsyncCreateFn[ChatCompletionResponse, CompletionEvent],
-    str | None,
-    list[AssistantMessage | SystemMessage | ToolMessage | UserMessage],
-    list[type[MistralTool]] | None,
-    MistralCallKwargs,
-]: ...
-
-
-@overload
-def setup_call(
-    *,
-    model: str,
-    client: Mistral | None,
-    fn: Callable[..., MistralDynamicConfig],
-    fn_args: dict[str, Any],
-    dynamic_config: MistralDynamicConfig,
-    tools: list[type[BaseTool] | Callable] | None,
-    json_mode: bool,
-    call_params: MistralCallParams | CommonCallParams,
-    response_model: type[BaseModel] | None,
-    stream: bool | StreamConfig,
-) -> tuple[
-    CreateFn[ChatCompletionResponse, CompletionEvent],
-    str | None,
-    list[AssistantMessage | SystemMessage | ToolMessage | UserMessage],
-    list[type[MistralTool]] | None,
-    MistralCallKwargs,
-]: ...
-
-
-def setup_call(
-    *,
-    model: str,
-    client: Mistral | None,
-    fn: Callable[..., MistralDynamicConfig | Awaitable[MistralDynamicConfig]],
-    fn_args: dict[str, Any],
-    dynamic_config: MistralDynamicConfig,
-    tools: list[type[BaseTool] | Callable] | None,
-    json_mode: bool,
-    call_params: MistralCallParams | CommonCallParams,
-    response_model: type[BaseModel] | None,
-    stream: bool | StreamConfig,
-) -> tuple[
-    CreateFn[ChatCompletionResponse, CompletionEvent]
-    | AsyncCreateFn[ChatCompletionResponse, CompletionEvent],
-    str | None,
-    list[AssistantMessage | SystemMessage | ToolMessage | UserMessage],
-    list[type[MistralTool]] | None,
-    MistralCallKwargs,
-]:
-    prompt_template, messages, tool_types, base_call_kwargs = _utils.setup_call(
-        fn,
-        fn_args,
-        dynamic_config,
-        tools,
-        MistralTool,
-        call_params,
-        convert_common_call_params,
-    )
-    call_kwargs = cast(MistralCallKwargs, base_call_kwargs)
-    messages = cast(
-        list[
-            BaseMessageParam
-            | AssistantMessage
-            | SystemMessage
-            | ToolMessage
-            | UserMessage
-        ],
-        messages,
-    )
-    messages = convert_message_params(messages)
-    if json_mode:
-        if not tools:
-            call_kwargs["response_format"] = ResponseFormat(type="json_object")
-        json_mode_content = _utils.json_mode_content(
-            tool_types[0] if tool_types else None
-        )
-        if messages[-1].role == "user":
-            if isinstance(messages[-1].content, list):
-                messages[-1].content.append(TextChunk(text=json_mode_content))
-            elif isinstance(messages[-1].content, str):
-                messages[-1].content += json_mode_content
-        else:
-            messages.append(UserMessage(content=json_mode_content.strip()))
-    elif response_model:
-        assert tool_types, "At least one tool must be provided for extraction."
-        call_kwargs["tool_choice"] = cast(ToolChoiceEnum, "any")
-    call_kwargs |= {"model": model, "messages": messages}
-
-    if client is None:
-        client = Mistral(api_key=os.environ["MISTRAL_API_KEY"])
-    if fn_is_async(fn):
-        create_or_stream = get_async_create_fn(
-            client.chat.complete_async, client.chat.stream_async
-        )
-    else:
-        create_or_stream = get_create_fn(client.chat.complete, client.chat.stream)
-    return create_or_stream, prompt_template, messages, tool_types, call_kwargs

mirascope/core/mistral/call_params.py

@@ -1,36 +0,0 @@
-"""usage docs: learn/calls.md#provider-specific-parameters"""
-
-from __future__ import annotations
-
-from mistralai.models import ResponseFormat, ToolChoice, ToolChoiceEnum
-from typing_extensions import NotRequired
-
-from ..base import BaseCallParams
-
-
-class MistralCallParams(BaseCallParams):
-    """The parameters to use when calling the Mistral API.
-
-    [Mistral API Reference](https://docs.mistral.ai/api/)
-
-    Attributes:
-        endpoint: ...
-        max_tokens: ...
-        random_seed: ...
-        response_format: ...
-        safe_mode: ...
-        safe_prompt: ...
-        temperature: ...
-        tool_choice: ...
-        top_p: ...
-    """
-
-    endpoint: NotRequired[str | None]
-    max_tokens: NotRequired[int | None]
-    random_seed: NotRequired[int | None]
-    response_format: NotRequired[ResponseFormat | None]
-    safe_mode: NotRequired[bool | None]
-    safe_prompt: NotRequired[bool | None]
-    temperature: NotRequired[float | None]
-    tool_choice: NotRequired[ToolChoice | ToolChoiceEnum | None]
-    top_p: NotRequired[float | None]

mirascope/core/mistral/call_response.py

@@ -1,205 +0,0 @@
-"""This module contains the `MistralCallResponse` class.
-
-usage docs: learn/calls.md#handling-responses
-"""
-
-from collections.abc import Sequence
-from functools import cached_property
-from typing import Any, cast
-
-from mistralai import ChatCompletionChoice
-from mistralai.models import (
-    AssistantMessage,
-    ChatCompletionResponse,
-    SystemMessage,
-    ToolMessage,
-    UsageInfo,
-    UserMessage,
-)
-from pydantic import computed_field
-
-from .. import BaseMessageParam
-from ..base import BaseCallResponse, transform_tool_outputs
-from ..base.types import CostMetadata, FinishReason
-from ._utils._convert_finish_reason_to_common_finish_reasons import (
-    _convert_finish_reasons_to_common_finish_reasons,
-)
-from ._utils._message_param_converter import MistralMessageParamConverter
-from .call_params import MistralCallParams
-from .dynamic_config import MistralDynamicConfig
-from .tool import MistralTool
-
-
-class MistralCallResponse(
-    BaseCallResponse[
-        ChatCompletionResponse,
-        MistralTool,
-        dict[str, Any],
-        MistralDynamicConfig,
-        AssistantMessage | SystemMessage | ToolMessage | UserMessage,
-        MistralCallParams,
-        UserMessage,
-        MistralMessageParamConverter,
-    ]
-):
-    """A convenience wrapper around the Mistral `ChatCompletion` response.
-
-    When calling the Mistral API using a function decorated with `mistral_call`, the
-    response will be an `MistralCallResponse` instance with properties that allow for
-    more convenience access to commonly used attributes.
-
-    Example:
-
-    ```python
-    from mirascope.core import prompt_template
-    from mirascope.core.mistral import mistral_call
-
-
-    @mistral_call("mistral-largel-latest")
-    def recommend_book(genre: str) -> str:
-        return f"Recommend a {genre} book"
-
-    response = recommend_book("fantasy")  # response is an `MistralCallResponse` instance
-    print(response.content)
-    ```
-    """
-
-    _message_converter: type[MistralMessageParamConverter] = (
-        MistralMessageParamConverter
-    )
-
-    _provider = "mistral"
-
-    @property
-    def _response_choices(self) -> list[ChatCompletionChoice]:
-        return self.response.choices or []
-
-    @computed_field
-    @property
-    def content(self) -> str:
-        """The content of the chat completion for the 0th choice."""
-        return cast(str, self._response_choices[0].message.content) or ""
-
-    @computed_field
-    @property
-    def finish_reasons(self) -> list[str]:
-        """Returns the finish reasons of the response."""
-        return [
-            choice.finish_reason if choice.finish_reason else ""
-            for choice in self._response_choices
-        ]
-
-    @computed_field
-    @property
-    def model(self) -> str:
-        """Returns the name of the response model."""
-        return self.response.model
-
-    @computed_field
-    @property
-    def id(self) -> str:
-        """Returns the id of the response."""
-        return self.response.id
-
-    @property
-    def usage(self) -> UsageInfo:
-        """Returns the usage of the chat completion."""
-        return self.response.usage
-
-    @computed_field
-    @property
-    def input_tokens(self) -> int:
-        """Returns the number of input tokens."""
-        return self.usage.prompt_tokens
-
-    @computed_field
-    @property
-    def cached_tokens(self) -> int:
-        """Returns the number of cached tokens."""
-        return 0
-
-    @computed_field
-    @property
-    def output_tokens(self) -> int | None:
-        """Returns the number of output tokens."""
-        return self.usage.completion_tokens
-
-    @computed_field
-    @cached_property
-    def message_param(self) -> AssistantMessage:
-        """Returns the assistants's response as a message parameter."""
-        return self._response_choices[0].message
-
-    @cached_property
-    def tools(self) -> list[MistralTool] | None:
-        """Returns the tools for the 0th choice message.
-
-        Raises:
-            ValidationError: if the tool call doesn't match the tool's schema.
-        """
-        tool_calls = self._response_choices[0].message.tool_calls
-        if not self.tool_types or not tool_calls:
-            return None
-
-        extracted_tools = []
-        for tool_call in tool_calls:
-            for tool_type in self.tool_types:
-                if tool_call.function.name == tool_type._name():
-                    extracted_tools.append(tool_type.from_tool_call(tool_call))
-                    break
-
-        return extracted_tools
-
-    @cached_property
-    def tool(self) -> MistralTool | None:
-        """Returns the 0th tool for the 0th choice message.
-
-        Raises:
-            ValidationError: if the tool call doesn't match the tool's schema.
-        """
-        if tools := self.tools:
-            return tools[0]
-        return None
-
-    @classmethod
-    @transform_tool_outputs
-    def tool_message_params(
-        cls, tools_and_outputs: Sequence[tuple[MistralTool, str]]
-    ) -> list[ToolMessage]:
-        """Returns the tool message parameters for tool call results.
-
-        Args:
-            tools_and_outputs: The sequence of tools and their outputs from which the tool
-                message parameters should be constructed.
-
-        Returns:
-            The list of constructed `ChatMessage` parameters.
-        """
-        return [
-            ToolMessage(
-                content=output,
-                tool_call_id=tool.tool_call.id,  # pyright: ignore [reportOptionalMemberAccess]
-                name=tool._name(),
-            )
-            for tool, output in tools_and_outputs
-        ]
-
-    @property
-    def common_finish_reasons(self) -> list[FinishReason] | None:
-        return _convert_finish_reasons_to_common_finish_reasons(self.finish_reasons)
-
-    @property
-    def common_message_param(self) -> BaseMessageParam:
-        return MistralMessageParamConverter.from_provider([self.message_param])[0]
-
-    @property
-    def common_user_message_param(self) -> BaseMessageParam | None:
-        if not self.user_message_param:
-            return None
-        return MistralMessageParamConverter.from_provider([self.user_message_param])[0]
-
-    @computed_field
-    @property
-    def cost_metadata(self) -> CostMetadata:
-        """Get metadata required for cost calculation."""
-        return super().cost_metadata

mirascope/core/mistral/call_response_chunk.py

@@ -1,105 +0,0 @@
-"""This module contains the `MistralCallResponseChunk` class.
-
-usage docs: learn/streams.md#handling-streamed-responses
-"""
-
-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,
-)
-
-
-class MistralCallResponseChunk(BaseCallResponseChunk[CompletionChunk, FinishReason]):
-    """A convenience wrapper around the Mistral `ChatCompletionChunk` streamed chunks.
-
-    When calling the Mistral API using a function decorated with `mistral_call` and
-    `stream` set to `True`, the stream will contain `MistralResponseChunk` instances with
-    properties that allow for more convenient access to commonly used attributes.
-
-    Example:
-
-    ```python
-    from mirascope.core import prompt_template
-    from mirascope.core.mistral import mistral_call
-
-
-    @mistral_call("mistral-large-latest", stream=True)
-    def recommend_book(genre: str) -> str:
-        return f"Recommend a {genre} book"
-
-
-    stream = recommend_book("fantasy")  # response is an `MistralStream`
-    for chunk, _ in stream:
-        print(chunk.content, end="", flush=True)
-    ```
-    """
-
-    @property
-    def content(self) -> str:
-        """Returns the content of the delta."""
-        delta = None
-        if self.chunk.choices:
-            delta = self.chunk.choices[0].delta
-
-        if delta is not None and isinstance(delta.content, str):
-            return delta.content
-        return ""
-
-    @property
-    def finish_reasons(self) -> list[FinishReason]:
-        """Returns the finish reasons of the response."""
-        return [
-            choice.finish_reason
-            for choice in self.chunk.choices
-            if choice.finish_reason
-        ]
-
-    @property
-    def model(self) -> str:
-        """Returns the name of the response model."""
-        return self.chunk.model
-
-    @property
-    def id(self) -> str:
-        """Returns the id of the response."""
-        return self.chunk.id
-
-    @property
-    def usage(self) -> UsageInfo | None:
-        """Returns the usage of the chat completion."""
-        return self.chunk.usage
-
-    @property
-    def input_tokens(self) -> int | None:
-        """Returns the number of input tokens."""
-        if self.usage:
-            return self.usage.prompt_tokens
-        return None
-
-    @property
-    def cached_tokens(self) -> int:
-        """Returns the number of cached tokens."""
-        return 0
-
-    @property
-    def output_tokens(self) -> int | None:
-        """Returns the number of output tokens."""
-        if self.usage:
-            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(
-            cast(list[str], self.finish_reasons)
-        )