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

mirascope/core/groq/_utils/_get_json_output.py

@@ -1,27 +0,0 @@
-"""Get the JSON output from a completion response."""
-
-from ..call_response import GroqCallResponse
-from ..call_response_chunk import GroqCallResponseChunk
-
-
-def get_json_output(
-    response: GroqCallResponse | GroqCallResponseChunk, json_mode: bool
-) -> str:
-    """Get the JSON output from a completion response."""
-    if isinstance(response, GroqCallResponse):
-        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 ""

mirascope/core/groq/_utils/_handle_stream.py

@@ -1,123 +0,0 @@
-"""Handles the stream of completion chunks."""
-
-from collections.abc import AsyncGenerator, Generator
-
-from groq.types.chat import ChatCompletionChunk, ChatCompletionMessageToolCall
-from groq.types.chat.chat_completion_message_tool_call import Function
-
-from ..call_response_chunk import GroqCallResponseChunk
-from ..tool import GroqTool
-
-
-def _handle_chunk(
-    chunk: ChatCompletionChunk,
-    current_tool_call: ChatCompletionMessageToolCall,
-    current_tool_type: type[GroqTool] | None,
-    tool_types: list[type[GroqTool]] | None,
-) -> tuple[
-    GroqTool | None,
-    ChatCompletionMessageToolCall,
-    type[GroqTool] | None,
-]:
-    """Handles a chunk of the stream."""
-    if not tool_types 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 = current_tool_call.model_copy()
-        previous_tool_type = current_tool_type
-        current_tool_call = ChatCompletionMessageToolCall(
-            id=tool_call.id,
-            function=Function(
-                arguments="",
-                name=tool_call.function.name if tool_call.function.name else "",
-            ),
-            type="function",
-        )
-        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[ChatCompletionChunk, None, None],
-    tool_types: list[type[GroqTool]] | None,
-    partial_tools: bool = False,
-) -> Generator[tuple[GroqCallResponseChunk, GroqTool | None], None, None]:
-    """Iterator over the stream and constructs tools as they are streamed."""
-    current_tool_call = ChatCompletionMessageToolCall(
-        id="", function=Function(arguments="", name=""), type="function"
-    )
-    current_tool_type = None
-    for chunk in stream:
-        if not tool_types or not chunk.choices[0].delta.tool_calls:
-            if current_tool_type:
-                yield (
-                    GroqCallResponseChunk(chunk=chunk),
-                    current_tool_type.from_tool_call(current_tool_call),
-                )
-                current_tool_type = None
-            else:
-                yield GroqCallResponseChunk(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 GroqCallResponseChunk(chunk=chunk), tool
-
-
-async def handle_stream_async(
-    stream: AsyncGenerator[ChatCompletionChunk, None],
-    tool_types: list[type[GroqTool]] | None,
-    partial_tools: bool = False,
-) -> AsyncGenerator[tuple[GroqCallResponseChunk, GroqTool | None], None]:
-    """Async iterator over the stream and constructs tools as they are streamed."""
-    current_tool_call = ChatCompletionMessageToolCall(
-        id="", function=Function(arguments="", name=""), type="function"
-    )
-    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 (
-                    GroqCallResponseChunk(chunk=chunk),
-                    current_tool_type.from_tool_call(current_tool_call),
-                )
-                current_tool_type = None
-            else:
-                yield GroqCallResponseChunk(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 GroqCallResponseChunk(chunk=chunk), tool

mirascope/core/groq/_utils/_message_param_converter.py

@@ -1,89 +0,0 @@
-import json
-from typing import cast
-
-from groq.types.chat import ChatCompletionMessageParam
-
-from mirascope.core import BaseMessageParam
-from mirascope.core.base import TextPart, ToolResultPart
-from mirascope.core.base._utils._base_message_param_converter import (
-    BaseMessageParamConverter,
-)
-from mirascope.core.base.message_param import ImageURLPart, ToolCallPart
-from mirascope.core.groq._utils import convert_message_params
-
-
-class GroqMessageParamConverter(BaseMessageParamConverter):
-    """Converts between Groq `ChatCompletionMessageParam` and Mirascope `BaseMessageParam`."""
-
-    @staticmethod
-    def to_provider(
-        message_params: list[BaseMessageParam],
-    ) -> list[ChatCompletionMessageParam]:
-        """
-        Convert from Mirascope `BaseMessageParam` to Groq `ChatCompletionMessageParam`.
-        """
-        return convert_message_params(
-            cast(list[BaseMessageParam | ChatCompletionMessageParam], message_params)
-        )
-
-    @staticmethod
-    def from_provider(
-        message_params: list[ChatCompletionMessageParam],
-    ) -> list[BaseMessageParam]:
-        """Convert from Groq's `ChatCompletionAssistantMessageParam` to Mirascope `BaseMessageParam`."""
-        converted = []
-        for message_param in message_params:
-            contents = []
-            content = message_param.get("content")
-            if message_param["role"] == "tool":
-                converted.append(
-                    BaseMessageParam(
-                        role="tool",
-                        content=[
-                            ToolResultPart(
-                                type="tool_result",
-                                name=getattr(message_param, "name", ""),
-                                content=message_param["content"],
-                                id=message_param["tool_call_id"],
-                                is_error=False,
-                            )
-                        ],
-                    )
-                )
-                continue
-            if tool_calls := message_param.get("tool_calls"):
-                for tool_call in tool_calls:
-                    contents.append(
-                        ToolCallPart(
-                            type="tool_call",
-                            name=tool_call["function"]["name"],
-                            id=tool_call["id"],
-                            args=json.loads(tool_call["function"]["arguments"]),
-                        )
-                    )
-            elif isinstance(content, str):
-                converted.append(
-                    BaseMessageParam(role=message_param["role"], content=content)
-                )
-                continue
-            elif isinstance(content, list):
-                for part in content:
-                    if "text" in part:
-                        contents.append(TextPart(type="text", text=part["text"]))
-                    elif "image_url" in part:
-                        contents.append(
-                            ImageURLPart(
-                                type="image_url",
-                                url=part["image_url"]["url"],
-                                detail=part["image_url"].get("detail"),
-                            )
-                        )
-            if contents:
-                converted.append(
-                    BaseMessageParam(role=message_param["role"], content=contents)
-                )
-            else:
-                converted.append(
-                    BaseMessageParam(role=message_param["role"], content="")
-                )
-        return converted

mirascope/core/groq/_utils/_setup_call.py

@@ -1,132 +0,0 @@
-"""This module contains the setup_call function for Groq tools."""
-
-import inspect
-from collections.abc import Awaitable, Callable
-from typing import Any, cast, overload
-
-from groq import AsyncGroq, Groq
-from groq.types.chat import (
-    ChatCompletion,
-    ChatCompletionChunk,
-    ChatCompletionMessageParam,
-)
-from pydantic import BaseModel
-
-from ...base import BaseMessageParam, BaseTool, _utils
-from ...base._utils import 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 GroqCallKwargs
-from ..call_params import GroqCallParams
-from ..dynamic_config import AsyncGroqDynamicConfig, GroqDynamicConfig
-from ..tool import GroqTool
-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: AsyncGroq | None,
-    fn: Callable[..., Awaitable[AsyncGroqDynamicConfig]],
-    fn_args: dict[str, Any],
-    dynamic_config: AsyncGroqDynamicConfig,
-    tools: list[type[BaseTool] | Callable] | None,
-    json_mode: bool,
-    call_params: GroqCallParams | CommonCallParams,
-    response_model: type[BaseModel] | None,
-    stream: bool | StreamConfig,
-) -> tuple[
-    AsyncCreateFn[ChatCompletion, ChatCompletionChunk],
-    str | None,
-    list[ChatCompletionMessageParam],
-    list[type[GroqTool]] | None,
-    GroqCallKwargs,
-]: ...
-
-
-@overload
-def setup_call(
-    *,
-    model: str,
-    client: Groq | None,
-    fn: Callable[..., GroqDynamicConfig],
-    fn_args: dict[str, Any],
-    dynamic_config: GroqDynamicConfig,
-    tools: list[type[BaseTool] | Callable] | None,
-    json_mode: bool,
-    call_params: GroqCallParams | CommonCallParams,
-    response_model: type[BaseModel] | None,
-    stream: bool | StreamConfig,
-) -> tuple[
-    CreateFn[ChatCompletion, ChatCompletionChunk],
-    str | None,
-    list[ChatCompletionMessageParam],
-    list[type[GroqTool]] | None,
-    GroqCallKwargs,
-]: ...
-
-
-def setup_call(
-    *,
-    model: str,
-    client: Groq | AsyncGroq | None,
-    fn: Callable[..., GroqDynamicConfig | Awaitable[AsyncGroqDynamicConfig]],
-    fn_args: dict[str, Any],
-    dynamic_config: GroqDynamicConfig | AsyncGroqDynamicConfig,
-    tools: list[type[BaseTool] | Callable] | None,
-    json_mode: bool,
-    call_params: GroqCallParams | CommonCallParams,
-    response_model: type[BaseModel] | None,
-    stream: bool | StreamConfig,
-) -> tuple[
-    CreateFn[ChatCompletion, ChatCompletionChunk]
-    | AsyncCreateFn[ChatCompletion, ChatCompletionChunk],
-    str | None,
-    list[ChatCompletionMessageParam],
-    list[type[GroqTool]] | None,
-    GroqCallKwargs,
-]:
-    prompt_template, messages, tool_types, base_call_kwargs = _utils.setup_call(
-        fn,
-        fn_args,
-        dynamic_config,
-        tools,
-        GroqTool,
-        call_params,
-        convert_common_call_params,
-    )
-    call_kwargs = cast(GroqCallKwargs, base_call_kwargs)
-    messages = cast(list[BaseMessageParam | ChatCompletionMessageParam], messages)
-    messages = convert_message_params(messages)
-    if json_mode:
-        if not tools:
-            call_kwargs["response_format"] = {"type": "json_object"}
-        json_mode_content = _utils.json_mode_content(response_model)
-        if messages[-1]["role"] == "user":
-            if isinstance(messages[-1]["content"], str):
-                messages[-1]["content"] += json_mode_content
-            else:
-                messages[-1]["content"] = list(messages[-1]["content"]) + [
-                    {"type": "text", "text": json_mode_content.strip()}
-                ]
-        else:
-            messages.append({"role": "user", "content": json_mode_content.strip()})
-    elif response_model:
-        assert tool_types, "At least one tool must be provided for extraction."
-        call_kwargs["tool_choice"] = {
-            "type": "function",
-            "function": {"name": tool_types[0]._name()},
-        }
-    call_kwargs |= {"model": model, "messages": messages}
-    if client is None:
-        client = AsyncGroq() if inspect.iscoroutinefunction(fn) else Groq()
-
-    create = (
-        get_async_create_fn(client.chat.completions.create)
-        if isinstance(client, AsyncGroq)
-        else get_create_fn(client.chat.completions.create)
-    )
-
-    return create, prompt_template, messages, tool_types, call_kwargs

mirascope/core/groq/call_params.py

@@ -1,52 +0,0 @@
-"""usage docs: learn/calls.md#provider-specific-parameters"""
-
-from __future__ import annotations
-
-from groq.types.chat.chat_completion_tool_choice_option_param import (
-    ChatCompletionToolChoiceOptionParam,
-)
-from groq.types.chat.completion_create_params import ResponseFormat
-from typing_extensions import NotRequired
-
-from ..base import BaseCallParams
-
-
-class GroqCallParams(BaseCallParams):
-    """The parameters to use when calling the Groq API.
-
-    [Groq API Reference](https://console.groq.com/docs/api-reference#chat-create)
-
-    Attributes:
-        frequency_penalty: ...
-        logit_bias: ...
-        logprobs: ...
-        max_tokens: ...
-        n: ...
-        parallel_tool_calls: ...
-        presence_penalty: ...
-        response_format: ...
-        seed: ...
-        stop: ...
-        temperature: ...
-        tool_choice: ...
-        top_logprobs: ...
-        top_p: ...
-        user: ...
-    """
-
-    extra_headers: NotRequired[dict[str, str] | None]
-    frequency_penalty: NotRequired[float | None]
-    logit_bias: NotRequired[dict[str, int] | None]
-    logprobs: NotRequired[bool | None]
-    max_tokens: NotRequired[int | None]
-    n: NotRequired[int | None]
-    parallel_tool_calls: NotRequired[bool]
-    presence_penalty: NotRequired[float | None]
-    response_format: NotRequired[ResponseFormat]
-    seed: NotRequired[int | None]
-    stop: NotRequired[str | list[str] | None]
-    temperature: NotRequired[float | None]
-    tool_choice: NotRequired[ChatCompletionToolChoiceOptionParam]
-    top_logprobs: NotRequired[int | None]
-    top_p: NotRequired[float | None]
-    user: NotRequired[str]

mirascope/core/groq/call_response.py

@@ -1,213 +0,0 @@
-"""This module contains the `GroqCallResponse` class.
-
-usage docs: learn/calls.md#handling-responses
-"""
-
-from collections.abc import Sequence
-from functools import cached_property
-from typing import cast
-
-from groq.types.chat import (
-    ChatCompletion,
-    ChatCompletionAssistantMessageParam,
-    ChatCompletionMessageParam,
-    ChatCompletionToolMessageParam,
-    ChatCompletionToolParam,
-    ChatCompletionUserMessageParam,
-)
-from groq.types.completion_usage import CompletionUsage
-from pydantic import SerializeAsAny, computed_field
-
-from .. import BaseMessageParam
-from ..base import BaseCallResponse, transform_tool_outputs
-from ..base.types import CostMetadata, FinishReason, ImageMetadata
-from ._utils._message_param_converter import GroqMessageParamConverter
-from .call_params import GroqCallParams
-from .dynamic_config import AsyncGroqDynamicConfig, GroqDynamicConfig
-from .tool import GroqTool
-
-
-class GroqCallResponse(
-    BaseCallResponse[
-        ChatCompletion,
-        GroqTool,
-        ChatCompletionToolParam,
-        AsyncGroqDynamicConfig | GroqDynamicConfig,
-        ChatCompletionMessageParam,
-        GroqCallParams,
-        ChatCompletionUserMessageParam,
-        GroqMessageParamConverter,
-    ]
-):
-    """A convenience wrapper around the Groq `ChatCompletion` response.
-
-    When calling the Groq API using a function decorated with `groq_call`, the
-    response will be an `GroqCallResponse` instance with properties that allow for
-    more convenience access to commonly used attributes.
-
-    Example:
-
-    ```python
-    from mirascope.core import prompt_template
-    from mirascope.core.groq import groq_call
-
-
-    @groq_call("llama-3.1-8b-instant")
-    def recommend_book(genre: str) -> str:
-        return f"Recommend a {genre} book"
-
-    response = recommend_book("fantasy")  # response is an `GroqCallResponse` instance
-    print(response.content)
-    ```
-    """
-
-    _message_converter: type[GroqMessageParamConverter] = GroqMessageParamConverter
-
-    _provider = "groq"
-
-    @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 0
-
-    @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"}
-        )
-        return ChatCompletionAssistantMessageParam(**message_param)
-
-    @cached_property
-    def tools(self) -> list[GroqTool] | None:
-        """Returns any available tool calls as their `GroqTool` definition.
-
-        Raises:
-            ValidationError: if a 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) -> GroqTool | 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[GroqTool, 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
-        ]
-
-    @property
-    def common_finish_reasons(self) -> list[FinishReason] | None:
-        return cast(list[FinishReason], self.finish_reasons)
-
-    @property
-    def common_message_param(self) -> BaseMessageParam:
-        return GroqMessageParamConverter.from_provider([self.message_param])[0]
-
-    @property
-    def common_user_message_param(self) -> BaseMessageParam | None:
-        if not self.user_message_param:
-            return None
-        return GroqMessageParamConverter.from_provider([self.user_message_param])[0]
-
-    @property
-    def cost_metadata(self) -> CostMetadata:
-        cost_metadata = super().cost_metadata
-        image_metadata = []
-
-        for message in self.messages:
-            if "content" not in message:
-                continue
-            content = message["content"]
-
-            if not isinstance(content, list):
-                continue
-            for part in content:
-                # Check if this part is an image_url
-                if isinstance(part, dict) and part.get("type") == "image_url":
-                    # Only count the image if it has a URL
-                    image_metadata.append(ImageMetadata(width=0, height=0))
-
-        cost_metadata.images = image_metadata
-        return cost_metadata