mirascope.core.mistral.tool¶
The MistralTool
class for easy tool usage with Mistral LLM calls.
Usage Documentation
MistralTool
¶
Bases: BaseTool[dict[str, Any]]
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
¶
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
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 |