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

mirascope/core/azure/_utils/_handle_stream.py

@@ -1,130 +0,0 @@
-"""Handles the stream of completion chunks."""
-
-import copy
-from collections.abc import AsyncGenerator, Generator
-
-from azure.ai.inference.models import (
-    ChatCompletionsToolCall,
-    FunctionCall,
-    StreamingChatCompletionsUpdate,
-)
-
-from ..call_response_chunk import AzureCallResponseChunk
-from ..tool import AzureTool
-
-
-def _handle_chunk(
-    chunk: StreamingChatCompletionsUpdate,
-    current_tool_call: ChatCompletionsToolCall,
-    current_tool_type: type[AzureTool] | None,
-    tool_types: list[type[AzureTool]] | None,
-) -> tuple[
-    AzureTool | None,
-    ChatCompletionsToolCall,
-    type[AzureTool] | None,
-]:
-    """Handles a chunk of the stream."""
-    if (
-        not tool_types
-        or not chunk.choices
-        or not (tool_calls := chunk.choices[0].delta.tool_calls)
-    ):
-        return None, current_tool_call, current_tool_type
-
-    tool_call = tool_calls[0]
-    # Reset on new tool
-    if tool_call.id and tool_call.function is not None:
-        previous_tool_call = copy.deepcopy(current_tool_call)
-        previous_tool_type = current_tool_type
-        current_tool_call = ChatCompletionsToolCall(
-            id=tool_call.id,
-            function=FunctionCall(
-                arguments="",
-                name=tool_call.function.name if tool_call.function.name else "",
-            ),
-        )
-        current_tool_type = None
-        for tool_type in tool_types:
-            if tool_type._name() == tool_call.function.name:
-                current_tool_type = tool_type
-                break
-        if current_tool_type is None:
-            raise RuntimeError(
-                f"Unknown tool type in stream: {tool_call.function.name}"
-            )  # pragma: no cover
-        if (
-            previous_tool_call.id
-            and previous_tool_call.function.arguments
-            and previous_tool_type is not None
-        ):
-            return (
-                previous_tool_type.from_tool_call(previous_tool_call),
-                current_tool_call,
-                current_tool_type,
-            )
-
-    # Update arguments with each chunk
-    if tool_call.function and tool_call.function.arguments:
-        current_tool_call.function.arguments += tool_call.function.arguments
-
-    return None, current_tool_call, current_tool_type
-
-
-def handle_stream(
-    stream: Generator[StreamingChatCompletionsUpdate, None, None],
-    tool_types: list[type[AzureTool]] | None,
-    partial_tools: bool = False,
-) -> Generator[tuple[AzureCallResponseChunk, AzureTool | None], None, None]:
-    """Iterator over the stream and constructs tools as they are streamed."""
-    current_tool_call = ChatCompletionsToolCall(
-        id="", function=FunctionCall(arguments="", name="")
-    )
-    current_tool_type = None
-    for chunk in stream:
-        if not tool_types or not chunk.choices or not chunk.choices[0].delta.tool_calls:
-            if current_tool_type:
-                yield (
-                    AzureCallResponseChunk(chunk=chunk),
-                    current_tool_type.from_tool_call(current_tool_call),
-                )
-                current_tool_type = None
-            else:
-                yield AzureCallResponseChunk(chunk=chunk), None
-        tool, current_tool_call, current_tool_type = _handle_chunk(
-            chunk,
-            current_tool_call,
-            current_tool_type,
-            tool_types,
-        )
-        if tool is not None:
-            yield AzureCallResponseChunk(chunk=chunk), tool
-
-
-async def handle_stream_async(
-    stream: AsyncGenerator[StreamingChatCompletionsUpdate, None],
-    tool_types: list[type[AzureTool]] | None,
-    partial_tools: bool = False,
-) -> AsyncGenerator[tuple[AzureCallResponseChunk, AzureTool | None], None]:
-    """Async iterator over the stream and constructs tools as they are streamed."""
-    current_tool_call = ChatCompletionsToolCall(
-        id="", function=FunctionCall(arguments="", name="")
-    )
-    current_tool_type = None
-    async for chunk in stream:
-        if not tool_types or not chunk.choices[0].delta.tool_calls:
-            if current_tool_type:
-                yield (
-                    AzureCallResponseChunk(chunk=chunk),
-                    current_tool_type.from_tool_call(current_tool_call),
-                )
-                current_tool_type = None
-            else:
-                yield AzureCallResponseChunk(chunk=chunk), None
-        tool, current_tool_call, current_tool_type = _handle_chunk(
-            chunk,
-            current_tool_call,
-            current_tool_type,
-            tool_types,
-        )
-        if tool is not None:
-            yield AzureCallResponseChunk(chunk=chunk), tool

mirascope/core/azure/_utils/_message_param_converter.py

@@ -1,117 +0,0 @@
-import json
-from typing import cast
-
-from azure.ai.inference.models import (
-    AssistantMessage,
-    ChatRequestMessage,
-    ContentItem,
-    ImageContentItem,
-    TextContentItem,
-    ToolMessage,
-    UserMessage,
-)
-
-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,
-)
-
-
-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):
-    """Converts between Azure `ChatRequestMessage` / `AssistantMessage` and Mirascope `BaseMessageParam`."""
-
-    @staticmethod
-    def to_provider(message_params: list[BaseMessageParam]) -> list[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[ChatRequestMessage],
-    ) -> list[BaseMessageParam]:
-        """
-        Convert from Azure's `AssistantMessage` back to Mirascope `BaseMessageParam`.
-        """
-        converted: list[BaseMessageParam] = []
-        for message_param in message_params:
-            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
-                    )
-                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/_utils/_setup_call.py

@@ -1,183 +0,0 @@
-"""This module contains the setup_call function for Azure tools."""
-
-import inspect
-import os
-import warnings
-from collections.abc import AsyncIterable, Awaitable, Callable, Iterable
-from typing import Any, cast, overload
-
-from azure.ai.inference import ChatCompletionsClient
-from azure.ai.inference.aio import ChatCompletionsClient as AsyncChatCompletionsClient
-from azure.ai.inference.models import (
-    ChatCompletions,
-    ChatRequestMessage,
-    StreamingChatCompletionsUpdate,
-    UserMessage,
-)
-from azure.core.credentials import AzureKeyCredential
-from pydantic import BaseModel
-
-from ...base import BaseMessageParam, BaseTool, _utils
-from ...base._utils import (
-    DEFAULT_TOOL_DOCSTRING,
-    AsyncCreateFn,
-    CreateFn,
-    get_async_create_fn,
-    get_create_fn,
-)
-from ...base.call_params import CommonCallParams
-from ...base.stream_config import StreamConfig
-from .._call_kwargs import AzureCallKwargs
-from ..call_params import AzureCallParams, ResponseFormatJSON
-from ..dynamic_config import AsyncAzureDynamicConfig, AzureDynamicConfig
-from ..tool import AzureTool, GenerateAzureStrictToolJsonSchema
-from ._convert_common_call_params import convert_common_call_params
-from ._convert_message_params import convert_message_params
-from ._get_credential import get_credential
-
-try:
-    from azure.ai.inference.models._models import (
-        ChatCompletionsResponseFormatJSON as FormatJSON,
-    )
-
-    json_object: ResponseFormatJSON | None = None
-except ImportError:  # pragma: no cover
-    # https://github.com/Azure/azure-sdk-for-python/commit/cf61ada8243d619ee6164bf1d32b3939b3c271e5#diff-0fb29d8cce6df3a014592ba8e9959409b8c471088381549807239324f5e8ddc4R15-R17
-    from azure.ai.inference.models._models import (
-        JsonSchemaFormat as FormatJSON,  # pyright: ignore [reportAttributeAccessIssue]
-    )
-
-    json_object = "json_object"  # pyright: ignore [reportAssignmentType]
-
-
-@overload
-def setup_call(
-    *,
-    model: str,
-    client: AsyncChatCompletionsClient | None,
-    fn: Callable[..., Awaitable[AsyncAzureDynamicConfig]],
-    fn_args: dict[str, Any],
-    dynamic_config: AsyncAzureDynamicConfig,
-    tools: list[type[BaseTool] | Callable] | None,
-    json_mode: bool,
-    call_params: AzureCallParams | CommonCallParams,
-    response_model: type[BaseModel] | None,
-    stream: bool | StreamConfig,
-) -> tuple[
-    AsyncCreateFn[ChatCompletions, StreamingChatCompletionsUpdate],
-    str | None,
-    list[ChatRequestMessage],
-    list[type[AzureTool]] | None,
-    AzureCallKwargs,
-]: ...
-
-
-@overload
-def setup_call(
-    *,
-    model: str,
-    client: ChatCompletionsClient | None,
-    fn: Callable[..., AzureDynamicConfig],
-    fn_args: dict[str, Any],
-    dynamic_config: AzureDynamicConfig,
-    tools: list[type[BaseTool] | Callable] | None,
-    json_mode: bool,
-    call_params: AzureCallParams | CommonCallParams,
-    response_model: type[BaseModel] | None,
-    stream: bool | StreamConfig,
-) -> tuple[
-    CreateFn[ChatCompletions, StreamingChatCompletionsUpdate],
-    str | None,
-    list[ChatRequestMessage],
-    list[type[AzureTool]] | None,
-    AzureCallKwargs,
-]: ...
-
-
-def setup_call(
-    *,
-    model: str,
-    client: ChatCompletionsClient | AsyncChatCompletionsClient | None,
-    fn: Callable[..., AzureDynamicConfig]
-    | Callable[..., Awaitable[AzureDynamicConfig]],
-    fn_args: dict[str, Any],
-    dynamic_config: AzureDynamicConfig,
-    tools: list[type[BaseTool] | Callable] | None,
-    json_mode: bool,
-    call_params: AzureCallParams | CommonCallParams,
-    response_model: type[BaseModel] | None,
-    stream: bool | StreamConfig,
-) -> tuple[
-    CreateFn[ChatCompletions, StreamingChatCompletionsUpdate]
-    | AsyncCreateFn[ChatCompletions, StreamingChatCompletionsUpdate],
-    str | None,
-    list[ChatRequestMessage],
-    list[type[AzureTool]] | None,
-    AzureCallKwargs,
-]:
-    prompt_template, messages, tool_types, base_call_kwargs = _utils.setup_call(
-        fn,
-        fn_args,
-        dynamic_config,
-        tools,
-        AzureTool,
-        call_params,
-        convert_common_call_params,
-    )
-    call_kwargs = cast(AzureCallKwargs, base_call_kwargs)
-    messages = cast(list[BaseMessageParam | ChatRequestMessage], messages)
-    messages = convert_message_params(messages)
-    if json_mode:
-        if response_model and response_model.model_config.get("strict", False):
-            call_kwargs["response_format"] = FormatJSON(
-                {
-                    "name": response_model.__name__,
-                    "description": response_model.__doc__ or DEFAULT_TOOL_DOCSTRING,
-                    "strict": True,
-                    "schema": response_model.model_json_schema(
-                        schema_generator=GenerateAzureStrictToolJsonSchema
-                    ),
-                }
-            )
-        else:
-            call_kwargs["response_format"] = json_object or FormatJSON()
-            json_mode_content = _utils.json_mode_content(response_model).strip()
-            messages.append(UserMessage(content=json_mode_content))
-    elif response_model:
-        assert tool_types, "At least one tool must be provided for extraction."
-        if tool_types and tool_types[0].model_config.get("strict", False):
-            warnings.warn(
-                "You must set `json_mode=True` to use `strict=True` response models. "
-                "Ignoring `strict` and using tools for extraction.",
-                UserWarning,
-            )
-        call_kwargs["tool_choice"] = "required"
-    call_kwargs |= {"model": model, "messages": messages}
-
-    if client is None:
-        endpoint = os.environ["AZURE_INFERENCE_ENDPOINT"]
-        credential = cast(AzureKeyCredential, get_credential())
-
-        client = (
-            AsyncChatCompletionsClient(endpoint=endpoint, credential=credential)
-            if inspect.iscoroutinefunction(fn)
-            else ChatCompletionsClient(endpoint=endpoint, credential=credential)
-        )
-    create = (
-        get_async_create_fn(
-            cast(
-                AsyncCreateFn[
-                    ChatCompletions, AsyncIterable[StreamingChatCompletionsUpdate]
-                ],
-                client.complete,
-            )
-        )
-        if isinstance(client, AsyncChatCompletionsClient)
-        else get_create_fn(
-            cast(
-                CreateFn[ChatCompletions, Iterable[StreamingChatCompletionsUpdate]],
-                client.complete,
-            )
-        )
-    )
-    return create, prompt_template, messages, tool_types, call_kwargs

mirascope/core/azure/call_params.py

@@ -1,59 +0,0 @@
-"""usage docs: learn/calls.md#provider-specific-parameters"""
-
-from __future__ import annotations
-
-from typing import Any, Literal, TypeAlias
-
-from azure.ai.inference.models import (
-    ChatCompletionsNamedToolChoice,
-    ChatCompletionsToolChoicePreset,
-)
-
-try:
-    from azure.ai.inference.models import (
-        ChatCompletionsResponseFormatJSON,
-    )
-
-    ResponseFormatJSON: TypeAlias = ChatCompletionsResponseFormatJSON  # pyright: ignore [reportRedeclaration]
-except ImportError:  # pragma: no cover
-    from azure.ai.inference.models import (
-        JsonSchemaFormat,  # pyright: ignore [reportAttributeAccessIssue]
-    )
-
-    ResponseFormatJSON: TypeAlias = JsonSchemaFormat | Literal["json_object"]  # pyright: ignore [reportRedeclaration]
-
-from typing_extensions import NotRequired
-
-from ..base import BaseCallParams
-
-
-class AzureCallParams(BaseCallParams):
-    """The parameters to use when calling the Azure API.
-
-    [Azure API Reference](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/ai/azure-ai-inference)
-
-    Attributes:
-        frequency_penalty: ...
-        max_tokens: ...
-        model_extras: ...
-        presence_penalty: ...
-        response_format: ...
-        seed: ...
-        stop: ...
-        temperature: ...
-        tool_choice: ...
-        top_p: ...
-    """
-
-    frequency_penalty: NotRequired[float | None]
-    max_tokens: NotRequired[int | None]
-    model_extras: NotRequired[dict[str, Any] | None]
-    presence_penalty: NotRequired[float | None]
-    response_format: NotRequired[ResponseFormatJSON | None]
-    seed: NotRequired[int | None]
-    stop: NotRequired[list[str] | None]
-    temperature: NotRequired[float | None]
-    tool_choice: NotRequired[
-        str | ChatCompletionsToolChoicePreset | ChatCompletionsNamedToolChoice | None
-    ]
-    top_p: NotRequired[float | None]

mirascope/core/azure/call_response.py

@@ -1,215 +0,0 @@
-"""This module contains the `AzureCallResponse` class.
-
-usage docs: learn/calls.md#handling-responses
-"""
-
-from collections.abc import Sequence
-from functools import cached_property
-from typing import cast
-
-from azure.ai.inference.models import (
-    AssistantMessage,
-    ChatCompletions,
-    ChatCompletionsToolDefinition,
-    ChatRequestMessage,
-    CompletionsUsage,
-    ToolMessage,
-    UserMessage,
-)
-from pydantic import SerializeAsAny, SkipValidation, 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 AzureMessageParamConverter
-from .call_params import AzureCallParams
-from .dynamic_config import AsyncAzureDynamicConfig, AzureDynamicConfig
-from .tool import AzureTool
-
-
-class AzureCallResponse(
-    BaseCallResponse[
-        ChatCompletions,
-        AzureTool,
-        ChatCompletionsToolDefinition,
-        AsyncAzureDynamicConfig | AzureDynamicConfig,
-        ChatRequestMessage,
-        AzureCallParams,
-        UserMessage,
-        AzureMessageParamConverter,
-    ]
-):
-    """A convenience wrapper around the Azure `ChatCompletion` response.
-
-    When calling the Azure API using a function decorated with `azure_call`, the
-    response will be an `AzureCallResponse` instance with properties that allow for
-    more convenience access to commonly used attributes.
-
-    Example:
-
-    ```python
-    from mirascope.core import prompt_template
-    from mirascope.core.azure import azure_call
-
-
-    @azure_call("gpt-4o")
-    def recommend_book(genre: str) -> str:
-        return f"Recommend a {genre} book"
-
-
-    response = recommend_book("fantasy")  # response is an `AzureCallResponse` instance
-    print(response.content)
-    ```
-    """
-
-    response: SkipValidation[ChatCompletions]
-    _message_converter: type[AzureMessageParamConverter] = AzureMessageParamConverter
-
-    _provider = "azure"
-
-    @computed_field
-    @property
-    def content(self) -> str:
-        """Returns the content of the chat completion for the 0th choice."""
-        message = self.response.choices[0].message
-        return message.content if message.content is not None else ""
-
-    @computed_field
-    @property
-    def finish_reasons(self) -> list[str]:
-        """Returns the finish reasons of the response."""
-        return [str(choice.finish_reason) 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) -> CompletionsUsage | None:
-        """Returns the usage of the chat completion."""
-        return self.response.usage
-
-    @computed_field
-    @property
-    def input_tokens(self) -> int | None:
-        """Returns the number of input tokens."""
-        return self.usage.prompt_tokens if self.usage else None
-
-    @computed_field
-    @property
-    def cached_tokens(self) -> int | None:
-        """Returns the number of cached tokens."""
-        return None
-
-    @computed_field
-    @property
-    def output_tokens(self) -> int | None:
-        """Returns the number of output tokens."""
-        return self.usage.completion_tokens if self.usage else None
-
-    @computed_field
-    @cached_property
-    def message_param(self) -> SerializeAsAny[AssistantMessage]:
-        """Returns the assistants's response as a message parameter."""
-        message_param = self.response.choices[0].message
-        return AssistantMessage(
-            content=message_param.content, tool_calls=message_param.tool_calls
-        )
-
-    @cached_property
-    def tools(self) -> list[AzureTool] | None:
-        """Returns any available tool calls as their `AzureTool` definition.
-
-        Raises:
-            ValidationError: if a tool call doesn't match the tool's schema.
-            ValueError: if the model refused to response, in which case the error
-                message will be the refusal.
-        """
-
-        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) -> AzureTool | None:
-        """Returns the 0th tool for the 0th choice message.
-
-        Raises:
-            ValidationError: if the tool call doesn't match the tool's schema.
-            ValueError: if the model refused to response, in which case the error
-                message will be the refusal.
-        """
-        if tools := self.tools:
-            return tools[0]
-        return None
-
-    @classmethod
-    def _get_tool_message(cls, tool: AzureTool, output: str) -> ToolMessage:
-        """Returns a tool message for the tool call."""
-        tool_message = ToolMessage(
-            content=output,
-            tool_call_id=tool.tool_call.id,  # pyright: ignore [reportOptionalMemberAccess]
-        )
-        tool_message.name = tool._name()  # pyright: ignore [reportCallIssue, reportAttributeAccessIssue]
-        return tool_message
-
-    @classmethod
-    @transform_tool_outputs
-    def tool_message_params(
-        cls, tools_and_outputs: Sequence[tuple[AzureTool, 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 `ChatCompletionToolMessageParam` parameters.
-        """
-        return [
-            cls._get_tool_message(tool, output) for tool, output in tools_and_outputs
-        ]
-
-    @property
-    def common_finish_reasons(self) -> list[FinishReason] | None:
-        """Provider-agnostic finish reasons."""
-        return _convert_finish_reasons_to_common_finish_reasons(
-            cast(list[str], self.finish_reasons)
-        )
-
-    @property
-    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]
-
-    @computed_field
-    @property
-    def cost_metadata(self) -> CostMetadata:
-        """Get metadata required for cost calculation."""
-        return super().cost_metadata