mirascope.core.base.tool

Module tool

This module defines the base class for tools used in LLM calls.

Class ToolConfig

A base class for tool configurations.

Bases:

Class GenerateJsonSchemaNoTitles

Bases:

Function generate

Class BaseTool

A class for defining tools for LLM calls.

Example:

from mirascope.core import BaseTool
from pydantic import Field


class FormatBook(BaseTool):
    """Returns a nicely formatted book recommendation."""

    title: str = Field(..., description="The title of the book.")
    author: str = Field(..., description="The author of the book.")

    def call(self) -> str:
        return f"{self.title} by {self.author}"

from mirascope.core import BaseTool
from pydantic import Field


class FormatBook(BaseTool):
    """Returns a nicely formatted book recommendation."""

    title: str = Field(..., description="The title of the book.")
    author: str = Field(..., description="The author of the book.")

    def call(self) -> str:
        return f"{self.title} by {self.author}"

Bases: BaseModel, ABC

Function call

The method to call the tool.

Function type_from_fn

Returns this tool type converted from a function.

Function type_from_base_model_type

Returns this tool type converted from a given base tool type.

Function type_from_base_type

Returns this tool type converted from a base type.

Function tool_schema

Function model_json_schema

Returns the generated JSON schema for the class.

Function warn_for_unsupported_configurations

Warns when a specific provider does not support provided config options.