From d6a1c88ca776c856d806d6c78e2b4db77d7fb841 Mon Sep 17 00:00:00 2001
From: jiangzf93 <75068635+jiangzf93@users.noreply.github.com>
Date: Mon, 12 Feb 2024 13:19:40 +0800
Subject: [PATCH] docs: update documentation for file system tool integration
 (#17377)

- **Description:** Update the docs for the tool integration module `file
system`
- **Issue:** [For New Contributors: Update Integration Documentation
#15664](https://github.com/langchain-ai/langchain/issues/15664#top)
  - **Dependencies:** N/A
---
 docs/docs/integrations/tools/filesystem.ipynb | 26 +++++++++----------
 1 file changed, 13 insertions(+), 13 deletions(-)

diff --git a/docs/docs/integrations/tools/filesystem.ipynb b/docs/docs/integrations/tools/filesystem.ipynb
index c7599a0019..56bf91b4c3 100644
--- a/docs/docs/integrations/tools/filesystem.ipynb
+++ b/docs/docs/integrations/tools/filesystem.ipynb
@@ -56,13 +56,13 @@
     {
      "data": {
       "text/plain": [
-       "[CopyFileTool(name='copy_file', description='Create a copy of a file in a specified location', args_schema=<class 'langchain_community.tools.file_management.copy.FileCopyInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug'),\n",
-       " DeleteFileTool(name='file_delete', description='Delete a file', args_schema=<class 'langchain_community.tools.file_management.delete.FileDeleteInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug'),\n",
-       " FileSearchTool(name='file_search', description='Recursively search for files in a subdirectory that match the regex pattern', args_schema=<class 'langchain_community.tools.file_management.file_search.FileSearchInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug'),\n",
-       " MoveFileTool(name='move_file', description='Move or rename a file from one location to another', args_schema=<class 'langchain_community.tools.file_management.move.FileMoveInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug'),\n",
-       " ReadFileTool(name='read_file', description='Read file from disk', args_schema=<class 'langchain_community.tools.file_management.read.ReadFileInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug'),\n",
-       " WriteFileTool(name='write_file', description='Write file to disk', args_schema=<class 'langchain_community.tools.file_management.write.WriteFileInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug'),\n",
-       " ListDirectoryTool(name='list_directory', description='List files and directories in a specified folder', args_schema=<class 'langchain_community.tools.file_management.list_dir.DirectoryListingInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug')]"
+       "[CopyFileTool(root_dir='/tmp/tmprdvsw3tg'),\n",
+       " DeleteFileTool(root_dir='/tmp/tmprdvsw3tg'),\n",
+       " FileSearchTool(root_dir='/tmp/tmprdvsw3tg'),\n",
+       " MoveFileTool(root_dir='/tmp/tmprdvsw3tg'),\n",
+       " ReadFileTool(root_dir='/tmp/tmprdvsw3tg'),\n",
+       " WriteFileTool(root_dir='/tmp/tmprdvsw3tg'),\n",
+       " ListDirectoryTool(root_dir='/tmp/tmprdvsw3tg')]"
       ]
      },
      "execution_count": 2,
@@ -96,9 +96,9 @@
     {
      "data": {
       "text/plain": [
-       "[ReadFileTool(name='read_file', description='Read file from disk', args_schema=<class 'langchain_community.tools.file_management.read.ReadFileInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug'),\n",
-       " WriteFileTool(name='write_file', description='Write file to disk', args_schema=<class 'langchain_community.tools.file_management.write.WriteFileInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug'),\n",
-       " ListDirectoryTool(name='list_directory', description='List files and directories in a specified folder', args_schema=<class 'langchain_community.tools.file_management.list_dir.DirectoryListingInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug')]"
+       "[ReadFileTool(root_dir='/tmp/tmprdvsw3tg'),\n",
+       " WriteFileTool(root_dir='/tmp/tmprdvsw3tg'),\n",
+       " ListDirectoryTool(root_dir='/tmp/tmprdvsw3tg')]"
       ]
      },
      "execution_count": 3,
@@ -132,7 +132,7 @@
    ],
    "source": [
     "read_tool, write_tool, list_tool = tools\n",
-    "write_tool.run({\"file_path\": \"example.txt\", \"text\": \"Hello World!\"})"
+    "write_tool.invoke({\"file_path\": \"example.txt\", \"text\": \"Hello World!\"})"
    ]
   },
   {
@@ -153,7 +153,7 @@
    ],
    "source": [
     "# List files in the working directory\n",
-    "list_tool.run({})"
+    "list_tool.invoke({})"
    ]
   },
   {
@@ -180,7 +180,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.12"
+   "version": "3.9.18"
   }
  },
  "nbformat": 4,