community[patch]: Release 0.0.2 (#14610)

libs/langchain/langchain/tools/render.py

@@ -1,13 +1,52 @@
-from langchain_community.tools.render import (
+"""Different methods for rendering Tools to be passed to LLMs.
+
+Depending on the LLM you are using and the prompting strategy you are using,
+you may want Tools to be rendered in a different way.
+This module contains various ways to render tools.
+"""
+from typing import List
+
+# For backwards compatibility
+from langchain_community.tools.convert_to_openai import (
     format_tool_to_openai_function,
     format_tool_to_openai_tool,
-    render_text_description,
-    render_text_description_and_args,
 )
+from langchain_core.tools import BaseTool
 
 __all__ = [
     "render_text_description",
     "render_text_description_and_args",
-    "format_tool_to_openai_function",
     "format_tool_to_openai_tool",
+    "format_tool_to_openai_function",
 ]
+
+
+def render_text_description(tools: List[BaseTool]) -> str:
+    """Render the tool name and description in plain text.
+
+    Output will be in the format of:
+
+    .. code-block:: markdown
+
+        search: This tool is used for search
+        calculator: This tool is used for math
+    """
+    return "\n".join([f"{tool.name}: {tool.description}" for tool in tools])
+
+
+def render_text_description_and_args(tools: List[BaseTool]) -> str:
+    """Render the tool name, description, and args in plain text.
+
+    Output will be in the format of:
+
+    .. code-block:: markdown
+
+        search: This tool is used for search, args: {"query": {"type": "string"}}
+        calculator: This tool is used for math, \
+args: {"expression": {"type": "string"}}
+    """
+    tool_strings = []
+    for tool in tools:
+        args_schema = str(tool.args)
+        tool_strings.append(f"{tool.name}: {tool.description}, args: {args_schema}")
+    return "\n".join(tool_strings)

libs/langchain/tests/unit_tests/tools/test_render.py

@@ -0,0 +1,42 @@
+from typing import List
+
+import pytest
+from langchain_core.tools import BaseTool, tool
+
+from langchain.tools.render import (
+    render_text_description,
+    render_text_description_and_args,
+)
+
+
+@tool
+def search(query: str) -> str:
+    """Lookup things online."""
+    return "foo"
+
+
+@tool
+def calculator(expression: str) -> str:
+    """Do math."""
+    return "bar"
+
+
+@pytest.fixture
+def tools() -> List[BaseTool]:
+    return [search, calculator]  # type: ignore
+
+
+def test_render_text_description(tools: List[BaseTool]) -> None:
+    tool_string = render_text_description(tools)
+    expected_string = """search: search(query: str) -> str - Lookup things online.
+calculator: calculator(expression: str) -> str - Do math."""
+    assert tool_string == expected_string
+
+
+def test_render_text_description_and_args(tools: List[BaseTool]) -> None:
+    tool_string = render_text_description_and_args(tools)
+    expected_string = """search: search(query: str) -> str - Lookup things online., \
+args: {'query': {'title': 'Query', 'type': 'string'}}
+calculator: calculator(expression: str) -> str - Do math., \
+args: {'expression': {'title': 'Expression', 'type': 'string'}}"""
+    assert tool_string == expected_string