索引

AsyncBaseTool

基础：BaseTool

基础工具类，向后兼容旧的工具规范，同时也支持异步。

源代码位于 llama-index-core/llama_index/core/tools/types.py

class AsyncBaseTool(BaseTool):
    """
    Base-level tool class that is backwards compatible with the old tool spec but also
    supports async.
    """

    def __call__(self, *args: Any, **kwargs: Any) -> ToolOutput:
        return self.call(*args, **kwargs)

    @abstractmethod
    def call(self, input: Any) -> ToolOutput:
        """
        This is the method that should be implemented by the tool developer.
        """

    @abstractmethod
    async def acall(self, input: Any) -> ToolOutput:
        """
        This is the async version of the call method.
        Should also be implemented by the tool developer as an
        async-compatible implementation.
        """

call abstractmethod

call(input: Any) -> ToolOutput

这是工具开发者应该实现的方法。

源代码位于 llama-index-core/llama_index/core/tools/types.py

@abstractmethod
def call(self, input: Any) -> ToolOutput:
    """
    This is the method that should be implemented by the tool developer.
    """

acall abstractmethod async

acall(input: Any) -> ToolOutput

这是 call 方法的异步版本。工具开发者也应该实现一个异步兼容的版本。

源代码位于 llama-index-core/llama_index/core/tools/types.py

@abstractmethod
async def acall(self, input: Any) -> ToolOutput:
    """
    This is the async version of the call method.
    Should also be implemented by the tool developer as an
    async-compatible implementation.
    """

BaseToolAsyncAdapter

基础：AsyncBaseTool

适配器类，允许将同步工具用作异步工具。

源代码位于 llama-index-core/llama_index/core/tools/types.py

class BaseToolAsyncAdapter(AsyncBaseTool):
    """
    Adapter class that allows a synchronous tool to be used as an async tool.
    """

    def __init__(self, tool: BaseTool):
        self.base_tool = tool

    @property
    def metadata(self) -> ToolMetadata:
        return self.base_tool.metadata

    def call(self, input: Any) -> ToolOutput:
        return self.base_tool(input)

    async def acall(self, input: Any) -> ToolOutput:
        return await asyncio.to_thread(self.call, input)

BaseTool

基础：DispatcherSpanMixin

源代码位于 llama-index-core/llama_index/core/tools/types.py

class BaseTool(DispatcherSpanMixin):
    @property
    @abstractmethod
    def metadata(self) -> ToolMetadata:
        pass

    @abstractmethod
    def __call__(self, input: Any) -> ToolOutput:
        pass

    def _process_langchain_tool_kwargs(
        self,
        langchain_tool_kwargs: Any,
    ) -> Dict[str, Any]:
        """Process langchain tool kwargs."""
        if "name" not in langchain_tool_kwargs:
            langchain_tool_kwargs["name"] = self.metadata.name or ""
        if "description" not in langchain_tool_kwargs:
            langchain_tool_kwargs["description"] = self.metadata.description
        if "fn_schema" not in langchain_tool_kwargs:
            langchain_tool_kwargs["args_schema"] = self.metadata.fn_schema

        # Callback dont exist on langchain
        if "_callback" in langchain_tool_kwargs:
            del langchain_tool_kwargs["_callback"]
        if "_async_callback" in langchain_tool_kwargs:
            del langchain_tool_kwargs["_async_callback"]

        return langchain_tool_kwargs

    def to_langchain_tool(
        self,
        **langchain_tool_kwargs: Any,
    ) -> "Tool":
        """To langchain tool."""
        from llama_index.core.bridge.langchain import Tool

        langchain_tool_kwargs = self._process_langchain_tool_kwargs(
            langchain_tool_kwargs
        )
        return Tool.from_function(
            func=self.__call__,
            **langchain_tool_kwargs,
        )

    def to_langchain_structured_tool(
        self,
        **langchain_tool_kwargs: Any,
    ) -> "StructuredTool":
        """To langchain structured tool."""
        from llama_index.core.bridge.langchain import StructuredTool

        langchain_tool_kwargs = self._process_langchain_tool_kwargs(
            langchain_tool_kwargs
        )
        return StructuredTool.from_function(
            func=self.__call__,
            **langchain_tool_kwargs,
        )

to_langchain_tool

to_langchain_tool(**langchain_tool_kwargs: Any) -> Tool

转换为 LangChain 工具。

源代码位于 llama-index-core/llama_index/core/tools/types.py

def to_langchain_tool(
    self,
    **langchain_tool_kwargs: Any,
) -> "Tool":
    """To langchain tool."""
    from llama_index.core.bridge.langchain import Tool

    langchain_tool_kwargs = self._process_langchain_tool_kwargs(
        langchain_tool_kwargs
    )
    return Tool.from_function(
        func=self.__call__,
        **langchain_tool_kwargs,
    )

to_langchain_structured_tool

to_langchain_structured_tool(**langchain_tool_kwargs: Any) -> StructuredTool

转换为 LangChain 结构化工具。

源代码位于 llama-index-core/llama_index/core/tools/types.py

def to_langchain_structured_tool(
    self,
    **langchain_tool_kwargs: Any,
) -> "StructuredTool":
    """To langchain structured tool."""
    from llama_index.core.bridge.langchain import StructuredTool

    langchain_tool_kwargs = self._process_langchain_tool_kwargs(
        langchain_tool_kwargs
    )
    return StructuredTool.from_function(
        func=self.__call__,
        **langchain_tool_kwargs,
    )

ToolMetadata dataclass

ToolMetadata(description: str, name: Optional[str] = None, fn_schema: Optional[Type[pydantic.main.BaseModel]] =, return_direct: bool = False)

参数

名称	类型	描述	默认值
description	str		必需
name	str | None		无
fn_schema	Type[BaseModel] | None		<class 'llama_index.core.tools.types.DefaultToolFnSchema'>
return_direct	bool		False

源代码位于 llama-index-core/llama_index/core/tools/types.py

@dataclass
class ToolMetadata:
    description: str
    name: Optional[str] = None
    fn_schema: Optional[Type[BaseModel]] = DefaultToolFnSchema
    return_direct: bool = False

    def get_parameters_dict(self) -> dict:
        if self.fn_schema is None:
            parameters = {
                "type": "object",
                "properties": {
                    "input": {"title": "input query string", "type": "string"},
                },
                "required": ["input"],
            }
        else:
            parameters = self.fn_schema.model_json_schema()
            parameters = {
                k: v
                for k, v in parameters.items()
                if k in ["type", "properties", "required", "definitions", "$defs"]
            }
        return parameters

    @property
    def fn_schema_str(self) -> str:
        """Get fn schema as string."""
        if self.fn_schema is None:
            raise ValueError("fn_schema is None.")
        parameters = self.get_parameters_dict()
        return json.dumps(parameters, ensure_ascii=False)

    def get_name(self) -> str:
        """Get name."""
        if self.name is None:
            raise ValueError("name is None.")
        return self.name

    @deprecated(
        "Deprecated in favor of `to_openai_tool`, which should be used instead."
    )
    def to_openai_function(self) -> Dict[str, Any]:
        """
        Deprecated and replaced by `to_openai_tool`.
        The name and arguments of a function that should be called, as generated by the
        model.
        """
        return {
            "name": self.name,
            "description": self.description,
            "parameters": self.get_parameters_dict(),
        }

    def to_openai_tool(self, skip_length_check: bool = False) -> Dict[str, Any]:
        """To OpenAI tool."""
        if not skip_length_check and len(self.description) > 1024:
            raise ValueError(
                "Tool description exceeds maximum length of 1024 characters. "
                "Please shorten your description or move it to the prompt."
            )
        return {
            "type": "function",
            "function": {
                "name": self.name,
                "description": self.description,
                "parameters": self.get_parameters_dict(),
            },
        }

fn_schema_str property

fn_schema_str: str

将 fn 模式作为字符串获取。

get_name

get_name() -> str

获取名称。

源代码位于 llama-index-core/llama_index/core/tools/types.py

def get_name(self) -> str:
    """Get name."""
    if self.name is None:
        raise ValueError("name is None.")
    return self.name

to_openai_function

to_openai_function() -> Dict[str, Any]

已弃用并由 to_openai_tool 替代。模型生成的应调用的函数的名称和参数。

源代码位于 llama-index-core/llama_index/core/tools/types.py

@deprecated(
    "Deprecated in favor of `to_openai_tool`, which should be used instead."
)
def to_openai_function(self) -> Dict[str, Any]:
    """
    Deprecated and replaced by `to_openai_tool`.
    The name and arguments of a function that should be called, as generated by the
    model.
    """
    return {
        "name": self.name,
        "description": self.description,
        "parameters": self.get_parameters_dict(),
    }

to_openai_tool

to_openai_tool(skip_length_check: bool = False) -> Dict[str, Any]

转换为 OpenAI 工具。

源代码位于 llama-index-core/llama_index/core/tools/types.py

def to_openai_tool(self, skip_length_check: bool = False) -> Dict[str, Any]:
    """To OpenAI tool."""
    if not skip_length_check and len(self.description) > 1024:
        raise ValueError(
            "Tool description exceeds maximum length of 1024 characters. "
            "Please shorten your description or move it to the prompt."
        )
    return {
        "type": "function",
        "function": {
            "name": self.name,
            "description": self.description,
            "parameters": self.get_parameters_dict(),
        },
    }

ToolOutput

基础：BaseModel

工具输出。

参数

名称	类型	描述	默认值
内容	str		必需
tool_name	str		必需
raw_input	Dict[str, Any]		必需
raw_output	Any		必需
is_error	bool		False

源代码位于 llama-index-core/llama_index/core/tools/types.py

class ToolOutput(BaseModel):
    """Tool output."""

    content: str
    tool_name: str
    raw_input: Dict[str, Any]
    raw_output: Any
    is_error: bool = False

    def __str__(self) -> str:
        """String."""
        return str(self.content)