mirascope 2.0.2__py3-none-any.whl → 2.1.0__py3-none-any.whl

mirascope/llm/providers/mirascope/provider.py

@@ -8,7 +8,7 @@ from typing import TYPE_CHECKING
 from typing_extensions import Unpack
 
 from ...context import Context, DepsT
-from ...formatting import Format, FormattableT, OutputParser
+from ...formatting import FormatSpec, FormattableT
 from ...messages import Message
 from ...responses import (
     AsyncContextResponse,
@@ -21,13 +21,9 @@ from ...responses import (
     StreamResponse,
 )
 from ...tools import (
-    AsyncContextTool,
     AsyncContextToolkit,
-    AsyncTool,
     AsyncToolkit,
-    ContextTool,
     ContextToolkit,
-    Tool,
     Toolkit,
 )
 from ..base import BaseProvider, Provider
@@ -156,11 +152,8 @@ class MirascopeProvider(BaseProvider[None]):
         *,
         model_id: str,
         messages: Sequence[Message],
-        tools: Sequence[Tool] | Toolkit | None = None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None = None,
+        toolkit: Toolkit,
+        format: FormatSpec[FormattableT] | None = None,
         **params: Unpack[Params],
     ) -> Response | Response[FormattableT]:
         """Generate an `llm.Response` by calling through the Mirascope Router."""
@@ -168,7 +161,7 @@ class MirascopeProvider(BaseProvider[None]):
         return provider.call(
             model_id=model_id,
             messages=messages,
-            tools=tools,
+            toolkit=toolkit,
             format=format,
             **params,
         )
@@ -179,13 +172,8 @@ class MirascopeProvider(BaseProvider[None]):
         ctx: Context[DepsT],
         model_id: str,
         messages: Sequence[Message],
-        tools: Sequence[Tool | ContextTool[DepsT]]
-        | ContextToolkit[DepsT]
-        | None = None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None = None,
+        toolkit: ContextToolkit[DepsT],
+        format: FormatSpec[FormattableT] | None = None,
         **params: Unpack[Params],
     ) -> ContextResponse[DepsT, None] | ContextResponse[DepsT, FormattableT]:
         """Generate an `llm.ContextResponse` by calling through the Mirascope Router."""
@@ -194,7 +182,7 @@ class MirascopeProvider(BaseProvider[None]):
             ctx=ctx,
             model_id=model_id,
             messages=messages,
-            tools=tools,
+            toolkit=toolkit,
             format=format,
             **params,
         )
@@ -204,11 +192,8 @@ class MirascopeProvider(BaseProvider[None]):
         *,
         model_id: str,
         messages: Sequence[Message],
-        tools: Sequence[AsyncTool] | AsyncToolkit | None = None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None = None,
+        toolkit: AsyncToolkit,
+        format: FormatSpec[FormattableT] | None = None,
         **params: Unpack[Params],
     ) -> AsyncResponse | AsyncResponse[FormattableT]:
         """Generate an `llm.AsyncResponse` by calling through the Mirascope Router."""
@@ -216,7 +201,7 @@ class MirascopeProvider(BaseProvider[None]):
         return await provider.call_async(
             model_id=model_id,
             messages=messages,
-            tools=tools,
+            toolkit=toolkit,
             format=format,
             **params,
         )
@@ -227,13 +212,8 @@ class MirascopeProvider(BaseProvider[None]):
         ctx: Context[DepsT],
         model_id: str,
         messages: Sequence[Message],
-        tools: Sequence[AsyncTool | AsyncContextTool[DepsT]]
-        | AsyncContextToolkit[DepsT]
-        | None = None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None = None,
+        toolkit: AsyncContextToolkit[DepsT],
+        format: FormatSpec[FormattableT] | None = None,
         **params: Unpack[Params],
     ) -> AsyncContextResponse[DepsT, None] | AsyncContextResponse[DepsT, FormattableT]:
         """Generate an `llm.AsyncContextResponse` by calling through the Mirascope Router."""
@@ -242,7 +222,7 @@ class MirascopeProvider(BaseProvider[None]):
             ctx=ctx,
             model_id=model_id,
             messages=messages,
-            tools=tools,
+            toolkit=toolkit,
             format=format,
             **params,
         )
@@ -252,11 +232,8 @@ class MirascopeProvider(BaseProvider[None]):
         *,
         model_id: str,
         messages: Sequence[Message],
-        tools: Sequence[Tool] | Toolkit | None = None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None = None,
+        toolkit: Toolkit,
+        format: FormatSpec[FormattableT] | None = None,
         **params: Unpack[Params],
     ) -> StreamResponse | StreamResponse[FormattableT]:
         """Stream an `llm.StreamResponse` by calling through the Mirascope Router."""
@@ -264,7 +241,7 @@ class MirascopeProvider(BaseProvider[None]):
         return provider.stream(
             model_id=model_id,
             messages=messages,
-            tools=tools,
+            toolkit=toolkit,
             format=format,
             **params,
         )
@@ -275,13 +252,8 @@ class MirascopeProvider(BaseProvider[None]):
         ctx: Context[DepsT],
         model_id: str,
         messages: Sequence[Message],
-        tools: Sequence[Tool | ContextTool[DepsT]]
-        | ContextToolkit[DepsT]
-        | None = None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None = None,
+        toolkit: ContextToolkit[DepsT],
+        format: FormatSpec[FormattableT] | None = None,
         **params: Unpack[Params],
     ) -> (
         ContextStreamResponse[DepsT, None] | ContextStreamResponse[DepsT, FormattableT]
@@ -292,7 +264,7 @@ class MirascopeProvider(BaseProvider[None]):
             ctx=ctx,
             model_id=model_id,
             messages=messages,
-            tools=tools,
+            toolkit=toolkit,
             format=format,
             **params,
         )
@@ -302,11 +274,8 @@ class MirascopeProvider(BaseProvider[None]):
         *,
         model_id: str,
         messages: Sequence[Message],
-        tools: Sequence[AsyncTool] | AsyncToolkit | None = None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None = None,
+        toolkit: AsyncToolkit,
+        format: FormatSpec[FormattableT] | None = None,
         **params: Unpack[Params],
     ) -> AsyncStreamResponse | AsyncStreamResponse[FormattableT]:
         """Stream an `llm.AsyncStreamResponse` by calling through the Mirascope Router."""
@@ -314,7 +283,7 @@ class MirascopeProvider(BaseProvider[None]):
         return await provider.stream_async(
             model_id=model_id,
             messages=messages,
-            tools=tools,
+            toolkit=toolkit,
             format=format,
             **params,
         )
@@ -325,13 +294,8 @@ class MirascopeProvider(BaseProvider[None]):
         ctx: Context[DepsT],
         model_id: str,
         messages: Sequence[Message],
-        tools: Sequence[AsyncTool | AsyncContextTool[DepsT]]
-        | AsyncContextToolkit[DepsT]
-        | None = None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None = None,
+        toolkit: AsyncContextToolkit[DepsT],
+        format: FormatSpec[FormattableT] | None = None,
         **params: Unpack[Params],
     ) -> (
         AsyncContextStreamResponse[DepsT, None]
@@ -343,7 +307,7 @@ class MirascopeProvider(BaseProvider[None]):
             ctx=ctx,
             model_id=model_id,
             messages=messages,
-            tools=tools,
+            toolkit=toolkit,
             format=format,
             **params,
         )

mirascope/llm/providers/mlx/encoding/base.py

@@ -6,7 +6,7 @@ from typing import TypeAlias
 
 from mlx_lm.generate import GenerationResponse
 
-from ....formatting import Format, FormattableT, OutputParser
+from ....formatting import Format, FormatSpec, FormattableT
 from ....messages import AssistantContent, Message
 from ....responses import ChunkIterator
 from ....tools import AnyToolSchema, BaseToolkit
@@ -21,11 +21,8 @@ class BaseEncoder(abc.ABC):
     def encode_request(
         self,
         messages: Sequence[Message],
-        tools: Sequence[AnyToolSchema] | BaseToolkit[AnyToolSchema] | None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None,
+        tools: BaseToolkit[AnyToolSchema],
+        format: FormatSpec[FormattableT] | None,
     ) -> tuple[Sequence[Message], Format[FormattableT] | None, TokenIds]:
         """Encode the request messages into a format suitable for the model.
 

mirascope/llm/providers/mlx/encoding/transformers.py

@@ -8,7 +8,7 @@ from mlx_lm.generate import GenerationResponse
 from transformers import PreTrainedTokenizer
 
 from ....content import ContentPart, TextChunk, TextEndChunk, TextStartChunk
-from ....formatting import Format, FormattableT, OutputParser
+from ....formatting import Format, FormatSpec, FormattableT
 from ....messages import AssistantContent, Message
 from ....responses import (
     ChunkIterator,
@@ -80,15 +80,11 @@ class TransformersEncoder(BaseEncoder):
     def encode_request(
         self,
         messages: Sequence[Message],
-        tools: Sequence[AnyToolSchema] | BaseToolkit[AnyToolSchema] | None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None,
+        tools: BaseToolkit[AnyToolSchema],
+        format: FormatSpec[FormattableT] | None,
     ) -> tuple[Sequence[Message], Format[FormattableT] | None, TokenIds]:
         """Encode a request into a format suitable for the model."""
-        tool_schemas = tools.tools if isinstance(tools, BaseToolkit) else tools or []
-        if len(tool_schemas) > 0:
+        if tools.tools:
             raise NotImplementedError("Tool usage is not supported.")
         if format is not None:
             raise NotImplementedError("Formatting is not supported.")

mirascope/llm/providers/mlx/mlx.py

@@ -13,7 +13,7 @@ from mlx_lm import stream_generate  # type: ignore[reportPrivateImportUsage]
 from mlx_lm.generate import GenerationResponse
 from transformers import PreTrainedTokenizer
 
-from ...formatting import Format, FormattableT, OutputParser
+from ...formatting import Format, FormatSpec, FormattableT
 from ...messages import AssistantMessage, Message, assistant
 from ...responses import AsyncChunkIterator, ChunkIterator, StreamResponseChunk
 from ...tools import AnyToolSchema, BaseToolkit
@@ -137,11 +137,8 @@ class MLX:
     def stream(
         self,
         messages: Sequence[Message],
-        tools: Sequence[AnyToolSchema] | BaseToolkit[AnyToolSchema] | None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None,
+        tools: BaseToolkit[AnyToolSchema],
+        format: FormatSpec[FormattableT] | None,
         params: Params,
     ) -> tuple[Sequence[Message], Format[FormattableT] | None, ChunkIterator]:
         """Stream response chunks synchronously.
@@ -163,11 +160,8 @@ class MLX:
     async def stream_async(
         self,
         messages: Sequence[Message],
-        tools: Sequence[AnyToolSchema] | BaseToolkit[AnyToolSchema] | None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None,
+        tools: BaseToolkit[AnyToolSchema],
+        format: FormatSpec[FormattableT] | None,
         params: Params,
     ) -> tuple[Sequence[Message], Format[FormattableT] | None, AsyncChunkIterator]:
         """Stream response chunks asynchronously.
@@ -190,11 +184,8 @@ class MLX:
     def generate(
         self,
         messages: Sequence[Message],
-        tools: Sequence[AnyToolSchema] | BaseToolkit[AnyToolSchema] | None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None,
+        tools: BaseToolkit[AnyToolSchema],
+        format: FormatSpec[FormattableT] | None,
         params: Params,
     ) -> tuple[
         Sequence[Message],
@@ -229,11 +220,8 @@ class MLX:
     async def generate_async(
         self,
         messages: Sequence[Message],
-        tools: Sequence[AnyToolSchema] | BaseToolkit[AnyToolSchema] | None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None,
+        tools: BaseToolkit[AnyToolSchema],
+        format: FormatSpec[FormattableT] | None,
         params: Params,
     ) -> tuple[
         Sequence[Message],

mirascope/llm/providers/mlx/provider.py

@@ -10,7 +10,7 @@ from mlx_lm import load as mlx_load
 from transformers import PreTrainedTokenizer
 
 from ...context import Context, DepsT
-from ...formatting import Format, FormattableT, OutputParser
+from ...formatting import FormatSpec, FormattableT
 from ...messages import Message
 from ...responses import (
     AsyncContextResponse,
@@ -23,13 +23,9 @@ from ...responses import (
     StreamResponse,
 )
 from ...tools import (
-    AsyncContextTool,
     AsyncContextToolkit,
-    AsyncTool,
     AsyncToolkit,
-    ContextTool,
     ContextToolkit,
-    Tool,
     Toolkit,
 )
 from ..base import BaseProvider
@@ -89,11 +85,8 @@ class MLXProvider(BaseProvider[None]):
         *,
         model_id: MLXModelId,
         messages: Sequence[Message],
-        tools: Sequence[Tool] | Toolkit | None = None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None = None,
+        toolkit: Toolkit,
+        format: FormatSpec[FormattableT] | None = None,
         **params: Unpack[Params],
     ) -> Response | Response[FormattableT]:
         """Generate an `llm.Response` using MLX model.
@@ -111,7 +104,7 @@ class MLXProvider(BaseProvider[None]):
         mlx = _get_mlx(model_id)
 
         input_messages, format, assistant_message, response = mlx.generate(
-            messages, tools, format, params
+            messages, toolkit, format, params
         )
 
         return Response(
@@ -120,7 +113,7 @@ class MLXProvider(BaseProvider[None]):
             model_id=model_id,
             provider_model_name=model_id,
             params=params,
-            tools=tools,
+            tools=toolkit,
             input_messages=input_messages,
             assistant_message=assistant_message,
             finish_reason=_utils.extract_finish_reason(response),
@@ -134,13 +127,8 @@ class MLXProvider(BaseProvider[None]):
         ctx: Context[DepsT],
         model_id: MLXModelId,
         messages: Sequence[Message],
-        tools: Sequence[Tool | ContextTool[DepsT]]
-        | ContextToolkit[DepsT]
-        | None = None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None = None,
+        toolkit: ContextToolkit[DepsT],
+        format: FormatSpec[FormattableT] | None = None,
         **params: Unpack[Params],
     ) -> ContextResponse[DepsT, None] | ContextResponse[DepsT, FormattableT]:
         """Generate an `llm.ContextResponse` using MLX model.
@@ -159,7 +147,7 @@ class MLXProvider(BaseProvider[None]):
         mlx = _get_mlx(model_id)
 
         input_messages, format, assistant_message, response = mlx.generate(
-            messages, tools, format, params
+            messages, toolkit, format, params
         )
 
         return ContextResponse(
@@ -168,7 +156,7 @@ class MLXProvider(BaseProvider[None]):
             model_id=model_id,
             provider_model_name=model_id,
             params=params,
-            tools=tools,
+            tools=toolkit,
             input_messages=input_messages,
             assistant_message=assistant_message,
             finish_reason=_utils.extract_finish_reason(response),
@@ -181,11 +169,8 @@ class MLXProvider(BaseProvider[None]):
         *,
         model_id: MLXModelId,
         messages: Sequence[Message],
-        tools: Sequence[AsyncTool] | AsyncToolkit | None = None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None = None,
+        toolkit: AsyncToolkit,
+        format: FormatSpec[FormattableT] | None = None,
         **params: Unpack[Params],
     ) -> AsyncResponse | AsyncResponse[FormattableT]:
         """Generate an `llm.AsyncResponse` using MLX model by asynchronously calloing
@@ -208,7 +193,7 @@ class MLXProvider(BaseProvider[None]):
             format,
             assistant_message,
             response,
-        ) = await mlx.generate_async(messages, tools, format, params)
+        ) = await mlx.generate_async(messages, toolkit, format, params)
 
         return AsyncResponse(
             raw=response,
@@ -216,7 +201,7 @@ class MLXProvider(BaseProvider[None]):
             model_id=model_id,
             provider_model_name=model_id,
             params=params,
-            tools=tools,
+            tools=toolkit,
             input_messages=input_messages,
             assistant_message=assistant_message,
             finish_reason=_utils.extract_finish_reason(response),
@@ -230,13 +215,8 @@ class MLXProvider(BaseProvider[None]):
         ctx: Context[DepsT],
         model_id: MLXModelId,
         messages: Sequence[Message],
-        tools: Sequence[AsyncTool | AsyncContextTool[DepsT]]
-        | AsyncContextToolkit[DepsT]
-        | None = None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None = None,
+        toolkit: AsyncContextToolkit[DepsT],
+        format: FormatSpec[FormattableT] | None = None,
         **params: Unpack[Params],
     ) -> AsyncContextResponse[DepsT, None] | AsyncContextResponse[DepsT, FormattableT]:
         """Generate an `llm.AsyncResponse` using MLX model by asynchronously calloing
@@ -260,7 +240,7 @@ class MLXProvider(BaseProvider[None]):
             format,
             assistant_message,
             response,
-        ) = await mlx.generate_async(messages, tools, format, params)
+        ) = await mlx.generate_async(messages, toolkit, format, params)
 
         return AsyncContextResponse(
             raw=response,
@@ -268,7 +248,7 @@ class MLXProvider(BaseProvider[None]):
             model_id=model_id,
             provider_model_name=model_id,
             params=params,
-            tools=tools,
+            tools=toolkit,
             input_messages=input_messages,
             assistant_message=assistant_message,
             finish_reason=_utils.extract_finish_reason(response),
@@ -281,11 +261,8 @@ class MLXProvider(BaseProvider[None]):
         *,
         model_id: MLXModelId,
         messages: Sequence[Message],
-        tools: Sequence[Tool] | Toolkit | None = None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None = None,
+        toolkit: Toolkit,
+        format: FormatSpec[FormattableT] | None = None,
         **params: Unpack[Params],
     ) -> StreamResponse | StreamResponse[FormattableT]:
         """Generate an `llm.StreamResponse` by synchronously streaming from MLX model output.
@@ -303,7 +280,7 @@ class MLXProvider(BaseProvider[None]):
         mlx = _get_mlx(model_id)
 
         input_messages, format, chunk_iterator = mlx.stream(
-            messages, tools, format, params
+            messages, toolkit, format, params
         )
 
         return StreamResponse(
@@ -311,7 +288,7 @@ class MLXProvider(BaseProvider[None]):
             model_id=model_id,
             provider_model_name=model_id,
             params=params,
-            tools=tools,
+            tools=toolkit,
             input_messages=input_messages,
             chunk_iterator=chunk_iterator,
             format=format,
@@ -323,13 +300,8 @@ class MLXProvider(BaseProvider[None]):
         ctx: Context[DepsT],
         model_id: MLXModelId,
         messages: Sequence[Message],
-        tools: Sequence[Tool | ContextTool[DepsT]]
-        | ContextToolkit[DepsT]
-        | None = None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None = None,
+        toolkit: ContextToolkit[DepsT],
+        format: FormatSpec[FormattableT] | None = None,
         **params: Unpack[Params],
     ) -> ContextStreamResponse[DepsT] | ContextStreamResponse[DepsT, FormattableT]:
         """Generate an `llm.ContextStreamResponse` by synchronously streaming from MLX model output.
@@ -348,7 +320,7 @@ class MLXProvider(BaseProvider[None]):
         mlx = _get_mlx(model_id)
 
         input_messages, format, chunk_iterator = mlx.stream(
-            messages, tools, format, params
+            messages, toolkit, format, params
         )
 
         return ContextStreamResponse(
@@ -356,7 +328,7 @@ class MLXProvider(BaseProvider[None]):
             model_id=model_id,
             provider_model_name=model_id,
             params=params,
-            tools=tools,
+            tools=toolkit,
             input_messages=input_messages,
             chunk_iterator=chunk_iterator,
             format=format,
@@ -367,11 +339,8 @@ class MLXProvider(BaseProvider[None]):
         *,
         model_id: MLXModelId,
         messages: Sequence[Message],
-        tools: Sequence[AsyncTool] | AsyncToolkit | None = None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None = None,
+        toolkit: AsyncToolkit,
+        format: FormatSpec[FormattableT] | None = None,
         **params: Unpack[Params],
     ) -> AsyncStreamResponse | AsyncStreamResponse[FormattableT]:
         """Generate an `llm.AsyncStreamResponse` by asynchronously streaming from MLX model output.
@@ -389,7 +358,7 @@ class MLXProvider(BaseProvider[None]):
         mlx = _get_mlx(model_id)
 
         input_messages, format, chunk_iterator = await mlx.stream_async(
-            messages, tools, format, params
+            messages, toolkit, format, params
         )
 
         return AsyncStreamResponse(
@@ -397,7 +366,7 @@ class MLXProvider(BaseProvider[None]):
             model_id=model_id,
             provider_model_name=model_id,
             params=params,
-            tools=tools,
+            tools=toolkit,
             input_messages=input_messages,
             chunk_iterator=chunk_iterator,
             format=format,
@@ -409,13 +378,8 @@ class MLXProvider(BaseProvider[None]):
         ctx: Context[DepsT],
         model_id: MLXModelId,
         messages: Sequence[Message],
-        tools: Sequence[AsyncTool | AsyncContextTool[DepsT]]
-        | AsyncContextToolkit[DepsT]
-        | None = None,
-        format: type[FormattableT]
-        | Format[FormattableT]
-        | OutputParser[FormattableT]
-        | None = None,
+        toolkit: AsyncContextToolkit[DepsT],
+        format: FormatSpec[FormattableT] | None = None,
         **params: Unpack[Params],
     ) -> (
         AsyncContextStreamResponse[DepsT]
@@ -437,7 +401,7 @@ class MLXProvider(BaseProvider[None]):
         mlx = _get_mlx(model_id)
 
         input_messages, format, chunk_iterator = await mlx.stream_async(
-            messages, tools, format, params
+            messages, toolkit, format, params
         )
 
         return AsyncContextStreamResponse(
@@ -445,7 +409,7 @@ class MLXProvider(BaseProvider[None]):
             model_id=model_id,
             provider_model_name=model_id,
             params=params,
-            tools=tools,
+            tools=toolkit,
             input_messages=input_messages,
             chunk_iterator=chunk_iterator,
             format=format,