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

mirascope/core/openai/call_response.py

@@ -1,273 +0,0 @@
-"""This module contains the `OpenAICallResponse` class.
-
-usage docs: learn/calls.md#handling-responses
-"""
-
-import base64
-from collections.abc import Sequence
-from functools import cached_property
-from typing import cast
-
-from openai.types.chat import (
-    ChatCompletion,
-    ChatCompletionAssistantMessageParam,
-    ChatCompletionMessageParam,
-    ChatCompletionToolMessageParam,
-    ChatCompletionToolParam,
-    ChatCompletionUserMessageParam,
-)
-from openai.types.completion_usage import CompletionUsage
-from pydantic import SerializeAsAny, SkipValidation, computed_field
-
-from .. import BaseMessageParam
-from ..base import (
-    BaseCallResponse,
-    transform_tool_outputs,
-)
-from ..base._utils._get_image_dimensions import (
-    get_image_dimensions,
-)
-from ..base.types import (
-    CostMetadata,
-    FinishReason,
-)
-from ._utils._message_param_converter import OpenAIMessageParamConverter
-from .call_params import OpenAICallParams
-from .dynamic_config import OpenAIDynamicConfig
-from .tool import OpenAITool
-
-try:
-    from openai.types.chat import (
-        ChatCompletionAudio,  # pyright: ignore [reportAssignmentType]
-    )
-except ImportError:  # pragma: no cover
-
-    class ChatCompletionAudio:
-        @property
-        def data(self) -> str: ...
-
-        @property
-        def transcript(self) -> str: ...
-
-
-class OpenAICallResponse(
-    BaseCallResponse[
-        ChatCompletion,
-        OpenAITool,
-        ChatCompletionToolParam,
-        OpenAIDynamicConfig,
-        ChatCompletionMessageParam,
-        OpenAICallParams,
-        ChatCompletionUserMessageParam,
-        OpenAIMessageParamConverter,
-    ]
-):
-    """A convenience wrapper around the OpenAI `ChatCompletion` response.
-
-    When calling the OpenAI API using a function decorated with `openai_call`, the
-    response will be an `OpenAICallResponse` instance with properties that allow for
-    more convenience access to commonly used attributes.
-
-    Example:
-
-    ```python
-    from mirascope.core import prompt_template
-    from mirascope.core.openai import openai_call
-
-
-    @openai_call("gpt-4o")
-    def recommend_book(genre: str) -> str:
-        return f"Recommend a {genre} book"
-
-
-    response = recommend_book("fantasy")  # response is an `OpenAICallResponse` instance
-    print(response.content)
-    ```
-    """
-
-    response: SkipValidation[ChatCompletion]
-    _message_converter: type[OpenAIMessageParamConverter] = OpenAIMessageParamConverter
-
-    _provider = "openai"
-
-    @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) -> CompletionUsage | 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 (
-            details.cached_tokens
-            if self.usage
-            and (details := getattr(self.usage, "prompt_tokens_details", None))
-            else 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[ChatCompletionAssistantMessageParam]:
-        """Returns the assistants's response as a message parameter."""
-        message_param = self.response.choices[0].message.model_dump(
-            exclude={"function_call", "audio"}
-        )
-        if audio := getattr(self.response.choices[0].message, "audio", None):
-            message_param["audio"] = {"id": audio.id}
-        return ChatCompletionAssistantMessageParam(**message_param)
-
-    @cached_property
-    def tools(self) -> list[OpenAITool] | None:
-        """Returns any available tool calls as their `OpenAITool` 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.
-        """
-        if hasattr(self.response.choices[0].message, "refusal") and (
-            refusal := self.response.choices[0].message.refusal
-        ):
-            raise ValueError(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) -> OpenAITool | 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
-    @transform_tool_outputs
-    def tool_message_params(
-        cls, tools_and_outputs: Sequence[tuple[OpenAITool, str]]
-    ) -> list[ChatCompletionToolMessageParam]:
-        """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 [
-            ChatCompletionToolMessageParam(  # pyright: ignore [reportCallIssue]
-                role="tool",
-                content=output,
-                tool_call_id=tool.tool_call.id,  # pyright: ignore [reportOptionalMemberAccess]
-                name=tool._name(),  # pyright: ignore [reportCallIssue]
-            )
-            for tool, output in tools_and_outputs
-        ]
-
-    @computed_field
-    @property
-    def audio(self) -> bytes | None:
-        """Returns the audio data of the response."""
-        if audio := getattr(self.response.choices[0].message, "audio", None):
-            return base64.b64decode(audio.data)
-        return None
-
-    @computed_field
-    @property
-    def audio_transcript(self) -> str | None:
-        """Returns the transcript of the audio content."""
-        if audio := getattr(self.response.choices[0].message, "audio", None):
-            return audio.transcript
-        return None
-
-    @property
-    def common_finish_reasons(self) -> list[FinishReason] | None:
-        """Provider-agnostic finish reasons."""
-        return cast(list[FinishReason], self.finish_reasons)
-
-    @property
-    def common_message_param(self) -> BaseMessageParam:
-        return OpenAIMessageParamConverter.from_provider([self.message_param])[0]
-
-    @property
-    def common_user_message_param(self) -> BaseMessageParam | None:
-        if not self.user_message_param:
-            return None
-        return OpenAIMessageParamConverter.from_provider([self.user_message_param])[0]
-
-    @property
-    def cost_metadata(self) -> CostMetadata:
-        cost_metadata = super().cost_metadata
-        for message in self.messages:
-            if message.get("role") != "user":
-                continue
-            for part in message.get("content") or []:
-                if not isinstance(part, dict):
-                    continue
-                if not (part.get("type") == "image_url" and "image_url" in part):
-                    continue
-                url = part["image_url"].get("url", "")
-                detail = part["image_url"].get("detail", "auto")
-
-                dimensions = get_image_dimensions(url)
-                if not dimensions:
-                    continue
-                dimensions.detail = detail
-                if cost_metadata.images is None:
-                    cost_metadata.images = []
-                cost_metadata.images.append(dimensions)
-        return cost_metadata

mirascope/core/openai/call_response_chunk.py

@@ -1,139 +0,0 @@
-"""This module contains the `OpenAICallResponseChunk` class.
-
-usage docs: learn/streams.md#handling-streamed-responses
-"""
-
-from __future__ import annotations
-
-import base64
-from typing import cast
-
-from openai.types.chat import ChatCompletionChunk
-from openai.types.chat.chat_completion_chunk import Choice
-from openai.types.completion_usage import CompletionUsage
-from pydantic import SkipValidation, computed_field
-
-from ..base import BaseCallResponseChunk
-from ..base.types import CostMetadata
-
-FinishReason = Choice.__annotations__["finish_reason"]
-
-
-class OpenAICallResponseChunk(BaseCallResponseChunk[ChatCompletionChunk, FinishReason]):
-    """A convenience wrapper around the OpenAI `ChatCompletionChunk` streamed chunks.
-
-    When calling the OpenAI API using a function decorated with `openai_call` and
-    `stream` set to `True`, the stream will contain `OpenAIResponseChunk` instances with
-    properties that allow for more convenient access to commonly used attributes.
-
-    Example:
-
-    ```python
-    from mirascope.core import prompt_template
-    from mirascope.core.openai import openai_call
-
-
-    @openai_call("gpt-4o-mini", stream=True)
-    def recommend_book(genre: str) -> str:
-        return f"Recommend a {genre} book"
-
-
-    stream = recommend_book("fantasy")  # response is an `OpenAIStream`
-    for chunk, _ in stream:
-        print(chunk.content, end="", flush=True)
-    ```
-    """
-
-    chunk: SkipValidation[ChatCompletionChunk]
-
-    @property
-    def content(self) -> str:
-        """Returns the content for the 0th choice delta."""
-        delta = None
-        if self.chunk.choices:
-            delta = self.chunk.choices[0].delta
-        return delta.content if delta is not None and delta.content else ""
-
-    @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) -> CompletionUsage | None:
-        """Returns the usage of the chat completion."""
-        if hasattr(self.chunk, "usage") and self.chunk.usage:
-            return self.chunk.usage
-        return None
-
-    @computed_field
-    @property
-    def cached_tokens(self) -> int | None:
-        """Returns the number of cached tokens."""
-        return (
-            details.cached_tokens
-            if hasattr(self.chunk, "usage")
-            and self.usage
-            and (details := getattr(self.usage, "prompt_tokens_details", None))
-            else None
-        )
-
-    @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 output_tokens(self) -> int | None:
-        """Returns the number of output tokens."""
-        if self.usage:
-            return self.usage.completion_tokens
-        return None
-
-    @computed_field
-    @property
-    def audio(self) -> bytes | None:
-        """Returns the audio data of the response."""
-
-        if self.chunk.choices and (
-            (audio := getattr(self.chunk.choices[0].delta, "audio", None))
-            and (audio_data := audio.get("data"))
-        ):
-            return base64.b64decode(audio_data)
-        return None
-
-    @computed_field
-    @property
-    def audio_transcript(self) -> str | None:
-        """Returns the transcript of the audio content."""
-        if self.chunk.choices and (
-            audio := getattr(self.chunk.choices[0].delta, "audio", None)
-        ):
-            return audio.get("transcript")
-        return None
-
-    @property
-    def cost_metadata(self) -> CostMetadata:
-        """Returns the cost metadata."""
-        return super().cost_metadata
-
-    @property
-    def common_finish_reasons(self) -> list[FinishReason] | None:
-        """Provider-agnostic finish reasons."""
-        return cast(list[FinishReason], self.finish_reasons)

mirascope/core/openai/dynamic_config.py

@@ -1,34 +0,0 @@
-"""This module defines the function return type for functions as LLM calls."""
-
-from openai import AsyncAzureOpenAI, AsyncOpenAI, AzureOpenAI, OpenAI
-from openai.types.chat import ChatCompletionMessageParam
-
-from ..base import BaseDynamicConfig, BaseMessageParam
-from .call_params import OpenAICallParams
-
-AsyncOpenAIDynamicConfig = BaseDynamicConfig[
-    ChatCompletionMessageParam | BaseMessageParam,
-    OpenAICallParams,
-    AsyncOpenAI | AsyncAzureOpenAI,
-]
-
-OpenAIDynamicConfig = BaseDynamicConfig[
-    ChatCompletionMessageParam | BaseMessageParam,
-    OpenAICallParams,
-    OpenAI | AzureOpenAI,
-]
-"""The function return type for functions wrapped with the `openai_call` decorator.
-
-Example:
-
-```python
-from mirascope.core import prompt_template
-from mirascope.core.openai import OpenAIDynamicConfig, openai_call
-
-
-@openai_call("gpt-4o-mini")
-@prompt_template("Recommend a {capitalized_genre} book")
-def recommend_book(genre: str) -> OpenAIDynamicConfig:
-    return {"computed_fields": {"capitalized_genre": genre.capitalize()}}
-```
-"""

mirascope/core/openai/stream.py

@@ -1,185 +0,0 @@
-"""The `OpenAIStream` class for convenience around streaming LLM calls.
-
-usage docs: learn/streams.md
-"""
-
-from collections.abc import AsyncGenerator, Generator
-
-from openai.types.chat import (
-    ChatCompletion,
-    ChatCompletionAssistantMessageParam,
-    ChatCompletionMessage,
-    ChatCompletionMessageParam,
-    ChatCompletionMessageToolCall,
-    ChatCompletionMessageToolCallParam,
-    ChatCompletionToolMessageParam,
-    ChatCompletionToolParam,
-    ChatCompletionUserMessageParam,
-)
-from openai.types.chat.chat_completion import Choice
-from openai.types.chat.chat_completion_message_tool_call_param import Function
-from openai.types.completion_usage import CompletionUsage
-
-from ..base.stream import BaseStream
-from ..base.types import CostMetadata
-from .call_params import OpenAICallParams
-from .call_response import OpenAICallResponse
-from .call_response_chunk import OpenAICallResponseChunk
-from .dynamic_config import OpenAIDynamicConfig
-from .tool import OpenAITool
-
-FinishReason = Choice.__annotations__["finish_reason"]
-
-
-class OpenAIStream(
-    BaseStream[
-        OpenAICallResponse,
-        OpenAICallResponseChunk,
-        ChatCompletionUserMessageParam,
-        ChatCompletionAssistantMessageParam,
-        ChatCompletionToolMessageParam,
-        ChatCompletionMessageParam,
-        OpenAITool,
-        ChatCompletionToolParam,
-        OpenAIDynamicConfig,
-        OpenAICallParams,
-        FinishReason,
-    ]
-):
-    """A class for convenience around streaming OpenAI LLM calls.
-
-    Example:
-
-    ```python
-    from mirascope.core import prompt_template
-    from mirascope.core.openai import openai_call
-
-
-    @openai_call("gpt-4o-mini", stream=True)
-    def recommend_book(genre: str) -> str:
-        return f"Recommend a {genre} book"
-
-
-    stream = recommend_book("fantasy")  # returns `OpenAIStream` instance
-    for chunk, _ in stream:
-        print(chunk.content, end="", flush=True)
-    ```
-    """
-
-    audio_id: str | None = None
-
-    _provider = "openai"
-
-    def __iter__(
-        self,
-    ) -> Generator[tuple[OpenAICallResponseChunk, OpenAITool | None], None, None]:
-        for chunk, tool in super().__iter__():
-            if (
-                (choices := chunk.chunk.choices)
-                and (audio := getattr(choices[0].delta, "audio", None))
-                and (audio_id := audio.get("id"))
-            ):
-                self.audio_id = audio_id
-            yield chunk, tool
-
-    def __aiter__(
-        self,
-    ) -> AsyncGenerator[tuple[OpenAICallResponseChunk, OpenAITool | None], None]:
-        aiter = super().__aiter__()
-
-        async def generator() -> AsyncGenerator[
-            tuple[OpenAICallResponseChunk, OpenAITool | None], None
-        ]:
-            async for chunk, tool in aiter:
-                if (
-                    (choices := chunk.chunk.choices)
-                    and (audio := getattr(choices[0].delta, "audio", None))
-                    and (audio_id := audio.get("id"))
-                ):
-                    self.audio_id = audio_id
-                yield chunk, tool
-
-        return generator()
-
-    def _construct_message_param(
-        self,
-        tool_calls: list[ChatCompletionMessageToolCall] | None = None,
-        content: str | None = None,
-    ) -> ChatCompletionAssistantMessageParam:
-        """Constructs the message parameter for the assistant."""
-        message_param = ChatCompletionAssistantMessageParam(
-            role="assistant", content=content
-        )
-        if tool_calls:
-            message_param["tool_calls"] = [
-                ChatCompletionMessageToolCallParam(
-                    type="function",
-                    function=Function(
-                        arguments=tool_call.function.arguments,
-                        name=tool_call.function.name,
-                    ),
-                    id=tool_call.id,
-                )
-                for tool_call in tool_calls
-            ]
-        if self.audio_id:
-            message_param["audio"] = {"id": self.audio_id}
-        return message_param
-
-    def construct_call_response(self) -> OpenAICallResponse:
-        """Constructs the call response from a consumed OpenAIStream.
-
-        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."
-            )
-        message = {
-            "role": self.message_param["role"],
-            "content": self.message_param.get("content", ""),
-            "tool_calls": self.message_param.get("tool_calls", []),
-        }
-        if not self.input_tokens and not self.output_tokens:
-            usage = None
-        else:
-            usage = CompletionUsage(
-                prompt_tokens=int(self.input_tokens or 0),
-                completion_tokens=int(self.output_tokens or 0),
-                total_tokens=int(self.input_tokens or 0) + int(self.output_tokens or 0),
-            )
-        completion = ChatCompletion(
-            id=self.id if self.id else "",
-            model=self.model,
-            choices=[
-                Choice(
-                    finish_reason=self.finish_reasons[0]
-                    if self.finish_reasons
-                    else "stop",
-                    index=0,
-                    message=ChatCompletionMessage.model_validate(message),
-                )
-            ],
-            created=0,
-            object="chat.completion",
-            usage=usage,
-        )
-        return OpenAICallResponse(
-            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:
-        return super().cost_metadata