mirascope.core.mistral.tool

The MistralTool class for easy tool usage with Mistral LLM calls.

Usage Documentation

Tools

MistralTool

Bases: BaseTool

A class for defining tools for Mistral LLM calls.

Example:

from mirascope.core import prompt_template
from mirascope.core.mistral import mistral_call


def format_book(title: str, author: str) -> str:
    return f"{title} by {author}"


@mistral_call("mistral-large-latest", tools=[format_book])
def recommend_book(genre: str) -> str:
    return f"Recommend a {genre} book"

response = recommend_book("fantasy")
if tool := response.tool:  # returns a `MistralTool` instance
    print(tool.call())

tool_schema classmethod

tool_schema() -> dict[str, Any]

Constructs a JSON Schema tool schema from the BaseModel schema defined.

Example:

from mirascope.core.mistral import MistralTool


def format_book(title: str, author: str) -> str:
    return f"{title} by {author}"


tool_type = MistralTool.type_from_fn(format_book)
print(tool_type.tool_schema())  # prints the Mistral-specific tool schema

Source code in mirascope/core/mistral/tool.py

@classmethod
def tool_schema(cls) -> dict[str, Any]:
    """Constructs a JSON Schema tool schema from the `BaseModel` schema defined.

    Example:
    ```python
    from mirascope.core.mistral import MistralTool


    def format_book(title: str, author: str) -> str:
        return f"{title} by {author}"


    tool_type = MistralTool.type_from_fn(format_book)
    print(tool_type.tool_schema())  # prints the Mistral-specific tool schema
    ```
    """
    fn: dict[str, Any] = {"name": cls._name(), "description": cls._description()}
    model_schema = cls.model_json_schema()
    if model_schema["properties"]:
        fn["parameters"] = model_schema
    return {"function": fn, "type": "function"}

from_tool_call classmethod

from_tool_call(tool_call: ToolCall) -> MistralTool

Constructs an MistralTool instance from a tool_call.

Parameters:

Name	Type	Description	Default
tool_call	ToolCall	The Mistral tool call from which to construct this tool instance.	required

Source code in mirascope/core/mistral/tool.py

@classmethod
def from_tool_call(cls, tool_call: ToolCall) -> MistralTool:
    """Constructs an `MistralTool` instance from a `tool_call`.

    Args:
        tool_call: The Mistral tool call from which to construct this tool instance.
    """
    model_json = jiter.from_json(tool_call.function.arguments.encode())
    model_json["tool_call"] = tool_call.model_dump()
    return cls.model_validate(model_json)