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

mirascope/core/anthropic/stream.py

@@ -1,147 +0,0 @@
-"""The `AnthropicStream` class for convenience around streaming LLM calls.
-
-usage docs: learn/streams.md
-"""
-
-from anthropic.types import (
-    Message,
-    MessageParam,
-    TextBlock,
-    ToolParam,
-    ToolUseBlock,
-    Usage,
-)
-from anthropic.types.content_block import ContentBlock
-from anthropic.types.text_block_param import TextBlockParam
-from anthropic.types.tool_use_block_param import ToolUseBlockParam
-from pydantic import BaseModel
-
-from ..base.stream import BaseStream
-from ..base.types import CostMetadata
-from .call_params import AnthropicCallParams
-from .call_response import AnthropicCallResponse
-from .call_response_chunk import AnthropicCallResponseChunk
-from .dynamic_config import AnthropicDynamicConfig, AsyncAnthropicDynamicConfig
-from .tool import AnthropicTool
-
-FinishReason = Message.__annotations__["stop_reason"]
-
-
-class AnthropicStream(
-    BaseStream[
-        AnthropicCallResponse,
-        AnthropicCallResponseChunk,
-        MessageParam,
-        MessageParam,
-        MessageParam,
-        MessageParam,
-        AnthropicTool,
-        ToolParam,
-        AsyncAnthropicDynamicConfig | AnthropicDynamicConfig,
-        AnthropicCallParams,
-        FinishReason,
-    ]
-):
-    """A class for convenience around streaming Anthropic LLM calls.
-
-    Example:
-
-    ```python
-    from mirascope.core import prompt_template
-    from mirascope.core.anthropic import anthropic_call
-
-
-    @anthropic_call("claude-3-5-sonnet-20240620", stream=True)
-    def recommend_book(genre: str) -> str:
-        return f"Recommend a {genre} book"
-
-
-    stream = recommend_book("fantasy")  # returns `AnthropicStream` instance
-    for chunk, _ in stream:
-        print(chunk.content, end="", flush=True)
-    ```
-    """
-
-    _provider = "anthropic"
-
-    def _construct_message_param(
-        self, tool_calls: list[ToolUseBlock] | None = None, content: str | None = None
-    ) -> MessageParam:
-        """Constructs the message parameter for the assistant."""
-        message_param_tool_calls = []
-        if tool_calls:
-            message_param_tool_calls: list[ToolUseBlockParam] = [
-                ToolUseBlockParam(
-                    id=tool_call.id,
-                    input=tool_call.input,
-                    name=tool_call.name,
-                    type="tool_use",
-                )
-                for tool_call in tool_calls
-            ]
-        return {
-            "role": "assistant",
-            "content": ([TextBlockParam(text=content, type="text")] if content else [])
-            + message_param_tool_calls,
-        }
-
-    def construct_call_response(self) -> AnthropicCallResponse:
-        """Constructs the call response from a consumed AnthropicStream.
-
-        Raises:
-            ValueError: if the stream has not yet been consumed.
-        """
-        if not hasattr(self, "message_param"):
-            raise ValueError(
-                "No stream response, check if the stream has been consumed."
-            )
-        usage = Usage(
-            input_tokens=int(self.input_tokens or 0),
-            output_tokens=int(self.output_tokens or 0),
-        )
-
-        content_blocks: list[ContentBlock] = []
-
-        if isinstance(self.message_param["content"], str):
-            content_blocks.append(
-                TextBlock(text=self.message_param["content"], type="text")
-            )
-        else:
-            for content in self.message_param["content"]:
-                content_type = (
-                    content.type if isinstance(content, BaseModel) else content["type"]
-                )
-
-                if content_type == "text":
-                    content_blocks.append(TextBlock.model_validate(content))
-                elif content_type == "tool_use":
-                    content_blocks.append(ToolUseBlock.model_validate(content))
-        completion = Message(
-            id=self.id if self.id else "",
-            content=content_blocks,
-            model=self.model,
-            role="assistant",
-            stop_reason=self.finish_reasons[0] if self.finish_reasons else None,
-            stop_sequence=None,
-            type="message",
-            usage=usage,
-        )
-        return AnthropicCallResponse(
-            metadata=self.metadata,
-            response=completion,
-            tool_types=self.tool_types,
-            prompt_template=self.prompt_template,
-            fn_args=self.fn_args if self.fn_args else {},
-            dynamic_config=self.dynamic_config,
-            messages=self.messages,
-            call_params=self.call_params,
-            call_kwargs=self.call_kwargs,
-            user_message_param=self.user_message_param,
-            start_time=self.start_time,
-            end_time=self.end_time,
-        )
-
-    @property
-    def cost_metadata(self) -> CostMetadata:
-        """Get metadata required for cost calculation."""
-        return super().cost_metadata

mirascope/core/anthropic/tool.py

@@ -1,101 +0,0 @@
-"""The `OpenAITool` class for easy tool usage with OpenAI LLM calls.
-
-usage docs: learn/tools.md
-"""
-
-from __future__ import annotations
-
-from typing import Any, cast
-
-from anthropic.types import ToolParam, ToolUseBlock
-from pydantic.json_schema import SkipJsonSchema
-from typing_extensions import TypedDict
-
-from ..base import BaseTool, ToolConfig
-from ..base._partial import partial
-
-
-class _CacheControl(TypedDict):
-    type: str
-
-
-class AnthropicToolConfig(ToolConfig, total=False):
-    """A tool configuration for Anthropic-specific features."""
-
-    cache_control: _CacheControl
-
-
-class AnthropicTool(BaseTool):
-    """A class for defining tools for Anthropic LLM calls.
-
-    Example:
-
-    ```python
-    from mirascope.core import prompt_template
-    from mirascope.core.anthropic import anthropic_call
-
-
-    def format_book(title: str, author: str) -> str:
-        return f"{title} by {author}"
-
-
-    @anthropic_call("claude-3-5-sonnet-20240620", tools=[format_book])
-    def recommend_book(genre: str) -> str:
-        return f"Recommend a {genre} book"
-
-    response = recommend_book("fantasy")
-    if tool := response.tool:  # returns an `AnthropicTool` instance
-        print(tool.call())
-    ```
-    """
-
-    __provider__ = "anthropic"
-    __tool_config_type__ = AnthropicToolConfig
-
-    tool_call: SkipJsonSchema[ToolUseBlock]
-
-    @classmethod
-    def tool_schema(cls) -> ToolParam:
-        """Constructs a `ToolParam` tool schema from the `BaseModel` schema defined.
-
-        Example:
-        ```python
-        from mirascope.core.anthropic import AnthropicTool
-
-
-        def format_book(title: str, author: str) -> str:
-            return f"{title} by {author}"
-
-
-        tool_type = AnthropicTool.type_from_fn(format_book)
-        print(tool_type.tool_schema())  # prints the Anthropic-specific tool schema
-        ```
-        """
-        kwargs = {
-            "input_schema": cls.model_json_schema(),
-            "name": cls._name(),
-            "description": cls._description(),
-        }
-        if "cache_control" in cls.tool_config:
-            kwargs["cache_control"] = cls.tool_config["cache_control"]
-        return ToolParam(**kwargs)
-
-    @classmethod
-    def from_tool_call(
-        cls, tool_call: ToolUseBlock, allow_partial: bool = False
-    ) -> AnthropicTool:
-        """Constructs an `AnthropicTool` instance from a `tool_call`.
-
-        Args:
-            tool_call: The Anthropic tool call from which to construct this tool
-                instance.
-        """
-        model_json = {"tool_call": tool_call}
-        model_json |= (
-            cls._dict_from_json(tool_call.input, True)
-            if isinstance(tool_call.input, str)
-            else cast(dict[str, Any], tool_call.input)
-        )
-        if allow_partial:
-            return partial(cls, {"tool_call", "delta"}).model_validate(model_json)
-        return cls.model_validate(model_json)

mirascope/core/azure/__init__.py

@@ -1,31 +0,0 @@
-"""The Mirascope Azure Module."""
-
-from typing import TypeAlias
-
-from azure.ai.inference.models import ChatRequestMessage
-
-from ..base import BaseMessageParam
-from ._call import azure_call
-from ._call import azure_call as call
-from .call_params import AzureCallParams
-from .call_response import AzureCallResponse
-from .call_response_chunk import AzureCallResponseChunk
-from .dynamic_config import AsyncAzureDynamicConfig, AzureDynamicConfig
-from .stream import AzureStream
-from .tool import AzureTool, AzureToolConfig
-
-AzureMessageParam: TypeAlias = ChatRequestMessage | BaseMessageParam
-
-__all__ = [
-    "AsyncAzureDynamicConfig",
-    "AzureCallParams",
-    "AzureCallResponse",
-    "AzureCallResponseChunk",
-    "AzureDynamicConfig",
-    "AzureMessageParam",
-    "AzureStream",
-    "AzureTool",
-    "AzureToolConfig",
-    "azure_call",
-    "call",
-]

mirascope/core/azure/_call.py

@@ -1,67 +0,0 @@
-"""The `azure_call` decorator for functions as LLM calls."""
-
-from ..base import call_factory
-from ._utils import (
-    get_json_output,
-    handle_stream,
-    handle_stream_async,
-    setup_call,
-)
-from .call_params import AzureCallParams
-from .call_response import AzureCallResponse
-from .call_response_chunk import AzureCallResponseChunk
-from .stream import AzureStream
-from .tool import AzureTool
-
-azure_call = call_factory(
-    TCallResponse=AzureCallResponse,
-    TCallResponseChunk=AzureCallResponseChunk,
-    TToolType=AzureTool,
-    TStream=AzureStream,
-    default_call_params=AzureCallParams(),
-    setup_call=setup_call,
-    get_json_output=get_json_output,
-    handle_stream=handle_stream,
-    handle_stream_async=handle_stream_async,
-)
-"""A decorator for calling the Azure API with a typed function.
-
-usage docs: learn/calls.md
-
-This decorator is used to wrap a typed function that calls the Azure API. It parses
-the prompt template of the wrapped function as the messages array and templates the input
-arguments for the function into each message's template.
-
-Example:
-
-```python
-from mirascope.core import prompt_template
-from mirascope.core.azure import azure_call
-
-
-@azure_call("gpt-4o-mini")
-def recommend_book(genre: str) -> str:
-    return f"Recommend a {genre} book"
-
-response = recommend_book("fantasy")
-print(response.content)
-```
-
-Args:
-    model (str): The Azure model to use in the API call.
-    stream (bool): Whether to stream the response from the API call.
-    tools (list[BaseTool | Callable]): The tools to use in the Azure API call.
-    response_model (BaseModel | BaseType): The response model into which the response
-        should be structured.
-    output_parser (Callable[[AzureCallResponse | ResponseModelT], Any]): A function for 
-        parsing the call response whose value will be returned in place of the original
-        call response.
-    json_mode (bool): Whether to use JSON Mode.
-    client (object): An optional custom client to use in place of the default client.
-    call_params (AzureCallParams): The `AzureCallParams` call parameters to use in the
-        API call.
-
-Returns:
-    decorator (Callable): The decorator for turning a typed function into an Azure API
-        call.
-"""

mirascope/core/azure/_call_kwargs.py

@@ -1,13 +0,0 @@
-"""This module contains the type definition for the Azure call keyword arguments."""
-
-from collections.abc import Sequence
-
-from azure.ai.inference.models import ChatCompletionsToolDefinition, ChatRequestMessage
-
-from ..base import BaseCallKwargs
-from .call_params import AzureCallParams
-
-
-class AzureCallKwargs(AzureCallParams, BaseCallKwargs[ChatCompletionsToolDefinition]):
-    model: str
-    messages: Sequence[ChatRequestMessage]

mirascope/core/azure/_utils/__init__.py

@@ -1,14 +0,0 @@
-"""Azure utilities for decorator factories."""
-
-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__ = [
-    "convert_message_params",
-    "get_json_output",
-    "handle_stream",
-    "handle_stream_async",
-    "setup_call",
-]

mirascope/core/azure/_utils/_convert_common_call_params.py

@@ -1,26 +0,0 @@
-from typing import cast
-
-from ...base.call_params import CommonCallParams
-from ..call_params import AzureCallParams
-
-AZURE_PARAM_MAPPING = {
-    "temperature": "temperature",
-    "max_tokens": "max_tokens",
-    "top_p": "top_p",
-    "frequency_penalty": "frequency_penalty",
-    "presence_penalty": "presence_penalty",
-    "seed": "seed",
-    "stop": "stop",
-}
-
-
-def convert_common_call_params(common_params: CommonCallParams) -> AzureCallParams:
-    """Convert CommonCallParams to Azure parameters."""
-    return cast(
-        AzureCallParams,
-        {
-            AZURE_PARAM_MAPPING[key]: [value] if isinstance(value, str) else value
-            for key, value in common_params.items()
-            if key in AZURE_PARAM_MAPPING and AZURE_PARAM_MAPPING[key] is not None
-        },
-    )

mirascope/core/azure/_utils/_convert_finish_reason_to_common_finish_reasons.py

@@ -1,21 +0,0 @@
-from mirascope.core.base._utils._convert_provider_finish_reason_to_finish_reason import (
-    FinishReasonMappingValue,
-    _convert_finish_reasons_to_common_finish_reasons_from_mapping,
-)
-from mirascope.core.base.types import FinishReason
-
-_FinishReasonMapping: dict[str, FinishReasonMappingValue] = {
-    "CompletionsFinishReason.STOPPED": "stop",
-    "CompletionsFinishReason.TOKEN_LIMIT_REACHED": "length",
-    "CompletionsFinishReason.CONTENT_FILTERED": "content_filter",
-    "CompletionsFinishReason.TOOL_CALLS": "tool_calls",
-}
-
-
-def _convert_finish_reasons_to_common_finish_reasons(
-    finish_reasons: list[str],
-) -> list[FinishReason] | None:
-    """Provider-agnostic finish reasons."""
-    return _convert_finish_reasons_to_common_finish_reasons_from_mapping(
-        finish_reasons, _FinishReasonMapping
-    )

mirascope/core/azure/_utils/_convert_message_params.py

@@ -1,121 +0,0 @@
-"""Utility for converting `BaseMessageParam` to `ChatRequestMessage`."""
-
-import base64
-import json
-from typing import cast
-
-from azure.ai.inference.models import (
-    AssistantMessage,
-    ChatCompletionsToolCall,
-    ChatRequestMessage,
-    FunctionCall,
-    ToolMessage,
-    UserMessage,
-)
-
-from ...base import BaseMessageParam
-
-
-def convert_message_params(
-    message_params: list[BaseMessageParam | ChatRequestMessage],
-) -> list[ChatRequestMessage]:
-    converted_message_params: list[ChatRequestMessage | ToolMessage] = []
-    for message_param in message_params:
-        if not isinstance(message_param, BaseMessageParam):
-            converted_message_params.append(message_param)
-        elif isinstance((content := message_param.content), str):
-            converted_message_params.append(UserMessage(content=content))
-        else:
-            converted_content = []
-            for part in content:
-                if part.type == "text":
-                    converted_content.append(part.model_dump())
-                elif part.type == "image":
-                    if part.media_type not in [
-                        "image/jpeg",
-                        "image/png",
-                        "image/gif",
-                        "image/webp",
-                    ]:
-                        raise ValueError(
-                            f"Unsupported image media type: {part.media_type}. Azure"
-                            " currently only supports JPEG, PNG, GIF, and WebP images."
-                        )
-                    data = base64.b64encode(part.image).decode("utf-8")
-                    converted_content.append(
-                        {
-                            "type": "image_url",
-                            "image_url": {
-                                "url": f"data:{part.media_type};base64,{data}",
-                                "detail": part.detail if part.detail else "auto",
-                            },
-                        }
-                    )
-                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=[
-                            ChatCompletionsToolCall(
-                                id=part.id,  # pyright: ignore [reportArgumentType]
-                                function=FunctionCall(
-                                    name=part.name, arguments=json.dumps(part.args)
-                                ),
-                            )
-                        ]
-                    )
-
-                    if converted_content:
-                        if len(converted_content) == 1:
-                            if converted_content[0]["type"] == "text":
-                                converted_message_param["content"] = converted_content[
-                                    0
-                                ]["text"]
-                        else:
-                            converted_message_params.append(
-                                ChatRequestMessage(
-                                    {
-                                        "role": message_param.role,
-                                        "content": converted_content,
-                                    }
-                                )
-                            )
-                        converted_content = []
-                    converted_message_params.append(converted_message_param)
-                elif part.type == "tool_result":
-                    if converted_content:
-                        converted_message_params.append(
-                            ChatRequestMessage(
-                                {
-                                    "role": message_param.role,
-                                    "content": converted_content,
-                                }
-                            )
-                        )
-                        converted_content = []
-                    converted_message_params.append(
-                        ToolMessage(
-                            content=part.content,
-                            tool_call_id=cast(str, part.id),
-                        )
-                    )
-                else:
-                    raise ValueError(
-                        "Azure currently only supports text and image parts. "
-                        f"Part provided: {part.type}"
-                    )
-            if converted_content:
-                converted_message_params.append(
-                    ChatRequestMessage(
-                        {"role": message_param.role, "content": converted_content}
-                    )
-                )
-    return converted_message_params

mirascope/core/azure/_utils/_get_credential.py

@@ -1,33 +0,0 @@
-from __future__ import annotations
-
-import os
-from typing import TYPE_CHECKING
-
-from azure.core.credentials import AzureKeyCredential
-
-if TYPE_CHECKING:
-    from azure.identity import (  # pyright: ignore [reportMissingImports]
-        DefaultAzureCredential,
-    )
-else:
-    AzureDefaultCredential = None
-
-
-def _get_key_from_env() -> str | None:
-    return os.environ.get("AZURE_INFERENCE_CREDENTIAL")
-
-
-def _get_azure_default_credential() -> DefaultAzureCredential:
-    try:
-        from azure.identity import DefaultAzureCredential
-    except ImportError:
-        raise ImportError(
-            "To use the AzureDefaultCredential, please install the azure-identity package with `pip install azure-identity`."
-        )
-    return DefaultAzureCredential()
-
-
-def get_credential() -> DefaultAzureCredential | AzureKeyCredential:
-    if (credential := _get_key_from_env()) is None:
-        return _get_azure_default_credential()
-    return AzureKeyCredential(credential)

mirascope/core/azure/_utils/_get_json_output.py

@@ -1,27 +0,0 @@
-"""Get the JSON output from a completion response."""
-
-from ..call_response import AzureCallResponse
-from ..call_response_chunk import AzureCallResponseChunk
-
-
-def get_json_output(
-    response: AzureCallResponse | AzureCallResponseChunk, json_mode: bool
-) -> str:
-    """Get the JSON output from a completion response."""
-    if isinstance(response, AzureCallResponse):
-        if json_mode and response.content:
-            return response.content
-        elif tool_calls := response.response.choices[0].message.tool_calls:
-            return tool_calls[0].function.arguments
-        raise ValueError("No tool call or JSON object found in response.")
-    else:
-        if json_mode:
-            return response.content
-        elif (
-            (choices := response.chunk.choices)
-            and (tool_calls := choices[0].delta.tool_calls)
-            and (function := tool_calls[0].function)
-            and (arguments := function.arguments) is not None
-        ):
-            return arguments
-        return ""