instructor 1.2.0__tar.gz → 1.2.2__tar.gz

{instructor-1.2.0 → instructor-1.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: instructor
-Version: 1.2.0
+Version: 1.2.2
 Summary: structured outputs for llm
 Home-page: https://github.com/jxnl/instructor
 License: MIT
@@ -16,15 +16,17 @@ Classifier: Programming Language :: Python :: 3.12
 Provides-Extra: anthropic
 Provides-Extra: cohere
 Provides-Extra: groq
+Provides-Extra: mistralai
 Provides-Extra: test-docs
 Requires-Dist: aiohttp (>=3.9.1,<4.0.0)
 Requires-Dist: anthropic (>=0.23.1,<0.24.0) ; extra == "anthropic" or extra == "test-docs"
 Requires-Dist: cohere (>=5.1.8,<6.0.0) ; extra == "cohere" or extra == "test-docs"
 Requires-Dist: diskcache (>=5.6.3,<6.0.0) ; extra == "test-docs"
-Requires-Dist: docstring-parser (>=0.15,<0.16)
+Requires-Dist: docstring-parser (>=0.16,<0.17)
 Requires-Dist: fastapi (>=0.109.2,<0.110.0) ; extra == "test-docs"
 Requires-Dist: groq (>=0.4.2,<0.5.0) ; extra == "groq" or extra == "test-docs"
 Requires-Dist: litellm (>=1.0.0,<2.0.0) ; extra == "test-docs"
+Requires-Dist: mistralai (>=0.1.8,<0.2.0) ; extra == "test-docs" or extra == "mistralai"
 Requires-Dist: openai (>=1.1.0,<2.0.0)
 Requires-Dist: pandas (>=2.2.0,<3.0.0) ; extra == "test-docs"
 Requires-Dist: pydantic (==2.7.0)

{instructor-1.2.0 → instructor-1.2.2}/instructor/__init__.py

@@ -57,6 +57,11 @@ if importlib.util.find_spec("groq") is not None:
 
     __all__ += ["from_groq"]
 
+if importlib.util.find_spec("mistralai") is not None:
+    from .client_mistral import from_mistral
+
+    __all__ += ["from_mistral"]
+
 if importlib.util.find_spec("cohere") is not None:
     from .client_cohere import from_cohere
 

{instructor-1.2.0 → instructor-1.2.2}/instructor/cli/usage.py

@@ -114,11 +114,11 @@ def calculate_cost(
 
 def group_and_sum_by_date_and_snapshot(usage_data: List[Dict[str, Any]]) -> Table:
     """Group and sum the usage data by date and snapshot, including costs."""
-    summary: DefaultDict[str, DefaultDict[str, Dict[str, Union[int, float]]]] = (
-        defaultdict(
-            lambda: defaultdict(
-                lambda: {"total_requests": 0, "total_tokens": 0, "total_cost": 0.0}
-            )
+    summary: DefaultDict[
+        str, DefaultDict[str, Dict[str, Union[int, float]]]
+    ] = defaultdict(
+        lambda: defaultdict(
+            lambda: {"total_requests": 0, "total_tokens": 0, "total_cost": 0.0}
         )
     )
 

{instructor-1.2.0 → instructor-1.2.2}/instructor/client.py

@@ -280,6 +280,7 @@ def from_openai(
             instructor.Mode.TOOLS,
             instructor.Mode.JSON,
             instructor.Mode.JSON_SCHEMA,
+            instructor.Mode.MD_JSON,
         }
 
     if provider in {Provider.OPENAI}:
@@ -315,7 +316,8 @@ def from_litellm(
     completion: Callable,
     mode: instructor.Mode = instructor.Mode.TOOLS,
     **kwargs,
-) -> Instructor: ...
+) -> Instructor:
+    ...
 
 
 @overload

{instructor-1.2.0 → instructor-1.2.2}/instructor/client_anthropic.py

@@ -13,7 +13,8 @@ def from_anthropic(
     | anthropic.AnthropicVertex,
     mode: instructor.Mode = instructor.Mode.ANTHROPIC_JSON,
     **kwargs,
-) -> instructor.Instructor: ...
+) -> instructor.Instructor:
+    ...
 
 
 @overload
@@ -23,7 +24,8 @@ def from_anthropic(
     | anthropic.AsyncAnthropicVertex,
     mode: instructor.Mode = instructor.Mode.ANTHROPIC_JSON,
     **kwargs,
-) -> instructor.Instructor: ...
+) -> instructor.Instructor:
+    ...
 
 
 def from_anthropic(

{instructor-1.2.0 → instructor-1.2.2}/instructor/client_cohere.py

@@ -23,7 +23,8 @@ def from_cohere(
     client: cohere.Client,
     mode: instructor.Mode = instructor.Mode.COHERE_TOOLS,
     **kwargs,
-) -> instructor.Instructor: ...
+) -> instructor.Instructor:
+    ...
 
 
 @overload
@@ -31,7 +32,8 @@ def from_cohere(
     client: cohere.AsyncClient,
     mode: instructor.Mode = instructor.Mode.COHERE_TOOLS,
     **kwargs,
-) -> instructor.AsyncInstructor: ...
+) -> instructor.AsyncInstructor:
+    ...
 
 
 def from_cohere(

{instructor-1.2.0 → instructor-1.2.2}/instructor/client_groq.py

@@ -11,7 +11,8 @@ def from_groq(
     client: groq.Groq,
     mode: instructor.Mode = instructor.Mode.TOOLS,
     **kwargs,
-) -> instructor.Instructor: ...
+) -> instructor.Instructor:
+    ...
 
 
 @overload
@@ -19,7 +20,8 @@ def from_groq(
     client: groq.AsyncGroq,
     mode: instructor.Mode = instructor.Mode.TOOLS,
     **kwargs,
-) -> instructor.Instructor: ...
+) -> instructor.Instructor:
+    ...
 
 
 def from_groq(

instructor-1.2.2/instructor/client_mistral.py

@@ -0,0 +1,57 @@
+# Future imports to ensure compatibility with Python 3.9
+from __future__ import annotations
+
+import mistralai.client
+import mistralai.async_client as mistralaiasynccli
+import instructor
+from typing import overload
+
+
+@overload
+def from_mistral(
+    client: mistralai.client.MistralClient,
+    mode: instructor.Mode = instructor.Mode.MISTRAL_TOOLS,
+    **kwargs,
+) -> instructor.Instructor: ...
+
+
+@overload
+def from_mistral(
+    client: mistralaiasynccli.MistralAsyncClient,
+    mode: instructor.Mode = instructor.Mode.MISTRAL_TOOLS,
+    **kwargs,
+) -> instructor.AsyncInstructor: ...
+
+
+def from_mistral(
+    client: mistralai.client.MistralClient | mistralaiasynccli.MistralAsyncClient,
+    mode: instructor.Mode = instructor.Mode.MISTRAL_TOOLS,
+    **kwargs,
+) -> instructor.Instructor | instructor.AsyncInstructor:
+    assert mode in {
+        instructor.Mode.MISTRAL_TOOLS,
+    }, "Mode be one of {instructor.Mode.MISTRAL_TOOLS}"
+
+    assert isinstance(
+        client, (mistralai.client.MistralClient, mistralaiasynccli.MistralAsyncClient)
+    ), "Client must be an instance of mistralai.client.MistralClient or mistralai.async_cli.MistralAsyncClient"
+
+    if isinstance(client, mistralai.client.MistralClient):
+
+        return instructor.Instructor(
+            client=client,
+            create=instructor.patch(create=client.chat, mode=mode),
+            provider=instructor.Provider.MISTRAL,
+            mode=mode,
+            **kwargs,
+        )
+
+    else:
+
+        return instructor.AsyncInstructor(
+            client=client,
+            create=instructor.patch(create=client.chat, mode=mode),
+            provider=instructor.Provider.MISTRAL,
+            mode=mode,
+            **kwargs,
+        )

{instructor-1.2.0 → instructor-1.2.2}/instructor/patch.py

@@ -36,7 +36,8 @@ class InstructorChatCompletionCreate(Protocol):
         max_retries: int = 1,
         *args: T_ParamSpec.args,
         **kwargs: T_ParamSpec.kwargs,
-    ) -> T_Model: ...
+    ) -> T_Model:
+        ...
 
 
 class AsyncInstructorChatCompletionCreate(Protocol):
@@ -47,35 +48,40 @@ class AsyncInstructorChatCompletionCreate(Protocol):
         max_retries: int = 1,
         *args: T_ParamSpec.args,
         **kwargs: T_ParamSpec.kwargs,
-    ) -> T_Model: ...
+    ) -> T_Model:
+        ...
 
 
 @overload
 def patch(
     client: OpenAI,
     mode: Mode = Mode.TOOLS,
-) -> OpenAI: ...
+) -> OpenAI:
+    ...
 
 
 @overload
 def patch(
     client: AsyncOpenAI,
     mode: Mode = Mode.TOOLS,
-) -> AsyncOpenAI: ...
+) -> AsyncOpenAI:
+    ...
 
 
 @overload
 def patch(
     create: Callable[T_ParamSpec, T_Retval],
     mode: Mode = Mode.TOOLS,
-) -> InstructorChatCompletionCreate: ...
+) -> InstructorChatCompletionCreate:
+    ...
 
 
 @overload
 def patch(
     create: Awaitable[T_Retval],
     mode: Mode = Mode.TOOLS,
-) -> InstructorChatCompletionCreate: ...
+) -> InstructorChatCompletionCreate:
+    ...
 
 
 def patch(

{instructor-1.2.0 → instructor-1.2.2}/instructor/retry.py

@@ -30,6 +30,23 @@ T_ParamSpec = ParamSpec("T_ParamSpec")
 T = TypeVar("T")
 
 
+class InstructorRetryException(Exception):
+    def __init__(
+        self,
+        *args,
+        last_completion,
+        messages: list,
+        n_attempts: int,
+        total_usage,
+        **kwargs,
+    ):
+        self.last_completion = last_completion
+        self.messages = messages
+        self.n_attempts = n_attempts
+        self.total_usage = total_usage
+        super().__init__(*args, **kwargs)
+
+
 def reask_messages(response: ChatCompletion, mode: Mode, exception: Exception):
     if mode == Mode.ANTHROPIC_TOOLS:
         # The original response
@@ -144,10 +161,21 @@ def retry_sync(
                         kwargs["messages"] = merge_consecutive_messages(
                             kwargs["messages"]
                         )
-                    raise e
+                    raise InstructorRetryException(
+                        e,
+                        last_completion=response,
+                        n_attempts=attempt.retry_state.attempt_number,
+                        messages=kwargs["messages"],
+                        total_usage=total_usage,
+                    ) from e
     except RetryError as e:
-        logger.exception(f"Failed after retries: {e.last_attempt.exception}")
-        raise e.last_attempt.exception from e
+        raise InstructorRetryException(
+            e,
+            last_completion=response,
+            n_attempts=attempt.retry_state.attempt_number,
+            messages=kwargs["messages"],
+            total_usage=total_usage,
+        ) from e
 
 
 async def retry_async(
@@ -161,7 +189,6 @@ async def retry_async(
     mode: Mode = Mode.TOOLS,
 ) -> T:
     total_usage = CompletionUsage(completion_tokens=0, prompt_tokens=0, total_tokens=0)
-
     # If max_retries is int, then create a AsyncRetrying object
     if isinstance(max_retries, int):
         logger.debug(f"max_retries: {max_retries}")
@@ -197,7 +224,19 @@ async def retry_async(
                         kwargs["messages"] = merge_consecutive_messages(
                             kwargs["messages"]
                         )
-                    raise e
+                    raise InstructorRetryException(
+                        e,
+                        last_completion=response,
+                        n_attempts=e.attempt_number,
+                        messages=kwargs["messages"],
+                        total_usage=total_usage,
+                    ) from e
     except RetryError as e:
         logger.exception(f"Failed after retries: {e.last_attempt.exception}")
-        raise e.last_attempt.exception from e
+        raise InstructorRetryException(
+            e,
+            last_completion=response,
+            n_attempts=e.attempt_number,
+            messages=kwargs["messages"],
+            total_usage=total_usage,
+        ) from e

{instructor-1.2.0 → instructor-1.2.2}/instructor/utils.py

@@ -23,6 +23,7 @@ class Provider(Enum):
     ANYSCALE = "anyscale"
     TOGETHER = "together"
     GROQ = "groq"
+    MISTRAL = "mistral"
     COHERE = "cohere"
     UNKNOWN = "unknown"
 
@@ -38,6 +39,8 @@ def get_provider(base_url: str) -> Provider:
         return Provider.GROQ
     elif "openai" in str(base_url):
         return Provider.OPENAI
+    elif "mistral" in str(base_url):
+        return Provider.MISTRAL
     elif "cohere" in str(base_url):
         return Provider.COHERE
     return Provider.UNKNOWN

{instructor-1.2.0 → instructor-1.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "instructor"
-version = "1.2.0"
+version = "1.2.2"
 description = "structured outputs for llm"
 authors = ["Jason Liu <jason@jxnl.co>"]
 license = "MIT"
@@ -12,7 +12,7 @@ repository = "https://github.com/jxnl/instructor"
 python = "^3.9"
 openai = "^1.1.0"
 pydantic = "2.7.0"
-docstring-parser = "^0.15"
+docstring-parser = "^0.16"
 typer = ">=0.9.0,<1.0.0"
 rich = "^13.7.0"
 aiohttp = "^3.9.1"
@@ -31,12 +31,14 @@ anthropic = { version = "^0.23.1", optional = true }
 xmltodict = { version = "^0.13.0", optional = true }
 groq = { version = "^0.4.2", optional = true }
 cohere = { version = "^5.1.8", optional = true }
+mistralai = { version = "^0.1.8", optional = true }
 
 [tool.poetry.extras]
 anthropic = ["anthropic", "xmltodict"]
 groq = ["groq"]
 cohere = ["cohere"]
-test-docs = ["fastapi", "redis", "diskcache", "pandas", "tabulate", "pydantic_extra_types", "litellm", "anthropic", "groq", "cohere"]
+test-docs = ["fastapi", "redis", "diskcache", "pandas", "tabulate", "pydantic_extra_types", "litellm", "anthropic", "groq", "cohere", "mistralai"]
+mistralai = ["mistralai"]
 
 [tool.poetry.scripts]
 instructor = "instructor.cli.cli:app"
@@ -74,6 +76,7 @@ xmltodict = "^0.13.0"
 groq = "^0.4.2"
 phonenumbers = "^8.13.33"
 cohere = "^5.1.8"
+mistralai = "^0.1.8"
 
 [build-system]
 requires = ["poetry-core"]