The agent engineering platform.
Python agentsaiai-agentsanthropicchatgptdeepagentsenterpriseframeworkgeminigenerative-ailangchainlanggraphllmmultiagentopen-sourceopenaipydanticpythonragtypescript
docs: clean up tool how to titles (#24373)
Bagaturf9baaae3ec99
diff --git a/docs/docs/how_to/convert_runnable_to_tool.ipynb b/docs/docs/how_to/convert_runnable_to_tool.ipynbindex 467bafe736..a0451e8d05 100644--- a/docs/docs/how_to/convert_runnable_to_tool.ipynb+++ b/docs/docs/how_to/convert_runnable_to_tool.ipynb@@ -5,7 +5,7 @@"id": "9a8bceb3-95bd-4496-bb9e-57655136e070","metadata": {},"source": [- "# How to use Runnables as Tools\n",+ "# How to convert Runnables as Tools\n","\n",":::info Prerequisites\n","\n",@@ -541,7 +541,7 @@"name": "python","nbconvert_exporter": "python","pygments_lexer": "ipython3",- "version": "3.10.4"+ "version": "3.11.9"}},"nbformat": 4,diff --git a/docs/docs/how_to/custom_tools.ipynb b/docs/docs/how_to/custom_tools.ipynbindex 2dd172e3a7..3d6561aa92 100644--- a/docs/docs/how_to/custom_tools.ipynb+++ b/docs/docs/how_to/custom_tools.ipynb@@ -5,7 +5,7 @@"id": "5436020b","metadata": {},"source": [- "# How to create custom tools\n",+ "# How to create tools\n","\n","When constructing an agent, you will need to provide it with a list of `Tool`s that it can use. Besides the actual function that is called, the Tool consists of several components:\n","\n",diff --git a/docs/docs/how_to/index.mdx b/docs/docs/how_to/index.mdxindex 6b21b0af5e..2c9f8d51c6 100644--- a/docs/docs/how_to/index.mdx+++ b/docs/docs/how_to/index.mdx@@ -185,19 +185,20 @@ Indexing is the process of keeping your vectorstore in-sync with the underlyingLangChain [Tools](/docs/concepts/#tools) contain a description of the tool (to pass to the language model) as well as the implementation of the function to call. Refer [here](/docs/integrations/tools/) for a list of pre-buit tools.-- [How to: create custom tools](/docs/how_to/custom_tools)-- [How to: use built-in tools and built-in toolkits](/docs/how_to/tools_builtin)-- [How to: convert Runnables to tools](/docs/how_to/convert_runnable_to_tool)-- [How to: use chat model to call tools](/docs/how_to/tool_calling)-- [How to: pass tool results back to model](/docs/how_to/tool_results_pass_to_model)-- [How to: add ad-hoc tool calling capability to LLMs and chat models](/docs/how_to/tools_prompting)+- [How to: create tools](/docs/how_to/custom_tools)+- [How to: use built-in tools and toolkits](/docs/how_to/tools_builtin)+- [How to: use chat models to call tools](/docs/how_to/tool_calling)+- [How to: pass tool outputs to chat models](/docs/how_to/tool_results_pass_to_model)- [How to: pass run time values to tools](/docs/how_to/tool_runtime)-- [How to: add a human in the loop to tool usage](/docs/how_to/tools_human)-- [How to: handle errors when calling tools](/docs/how_to/tools_error)-- [How to: disable parallel tool calling](/docs/how_to/tool_choice)-- [How to: access the `RunnableConfig` object within a custom tool](/docs/how_to/tool_configure)-- [How to: stream events from child runs within a custom tool](/docs/how_to/tool_stream_events)-- [How to: return extra artifacts from a tool](/docs/how_to/tool_artifacts/)+- [How to: add a human-in-the-loop for tools](/docs/how_to/tools_human)+- [How to: handle tool errors](/docs/how_to/tools_error)+- [How to: force models to call a tool](/docs/how_to/tool_choice)+- [How to: disable parallel tool calling](/docs/how_to/tool_calling_parallel)+- [How to: access the `RunnableConfig` from a tool](/docs/how_to/tool_configure)+- [How to: stream events from a tool](/docs/how_to/tool_stream_events)+- [How to: return artifacts from a tool](/docs/how_to/tool_artifacts/)+- [How to: convert Runnables to tools](/docs/how_to/convert_runnable_to_tool)+- [How to: add ad-hoc tool calling capability to models](/docs/how_to/tools_prompting)### Multimodaldiff --git a/docs/docs/how_to/tool_artifacts.ipynb b/docs/docs/how_to/tool_artifacts.ipynbindex a2cc492116..ee4d4b711e 100644--- a/docs/docs/how_to/tool_artifacts.ipynb+++ b/docs/docs/how_to/tool_artifacts.ipynb@@ -5,11 +5,12 @@"id": "503e36ae-ca62-4f8a-880c-4fe78ff5df93","metadata": {},"source": [- "# How to return extra artifacts from a tool\n",+ "# How to return artifacts from a tool\n","\n",":::info Prerequisites\n","This guide assumes familiarity with the following concepts:\n","\n",+ "- [ToolMessage](/docs/concepts/#toolmessage)\n","- [Tools](/docs/concepts/#tools)\n","- [Function/tool calling](/docs/concepts/#functiontool-calling)\n","\n",diff --git a/docs/docs/how_to/tool_calling.ipynb b/docs/docs/how_to/tool_calling.ipynbindex da80facf36..d9e35bbd51 100644--- a/docs/docs/how_to/tool_calling.ipynb+++ b/docs/docs/how_to/tool_calling.ipynb@@ -17,7 +17,7 @@"cell_type": "markdown","metadata": {},"source": [- "# How to use a model to call tools\n",+ "# How to use chat models to call tools\n","\n",":::info Prerequisites\n","\n",@@ -343,7 +343,7 @@"name": "python","nbconvert_exporter": "python","pygments_lexer": "ipython3",- "version": "3.10.5"+ "version": "3.11.9"}},"nbformat": 4,diff --git a/docs/docs/how_to/tool_calling_parallel.ipynb b/docs/docs/how_to/tool_calling_parallel.ipynbindex dab5744039..7c1175035a 100644--- a/docs/docs/how_to/tool_calling_parallel.ipynb+++ b/docs/docs/how_to/tool_calling_parallel.ipynb@@ -4,7 +4,13 @@"cell_type": "markdown","metadata": {},"source": [- "### Disabling parallel tool calling (OpenAI only)\n",+ "# How to disable parallel tool calling\n",+ "\n",+ ":::info OpenAI-specific\n",+ "\n",+ "This API is currently only supported by OpenAI.\n",+ "\n",+ ":::\n","\n","OpenAI tool calling performs tool calling in parallel by default. That means that if we ask a question like \"What is the weather in Tokyo, New York, and Chicago?\" and we have a tool for getting the weather, it will call the tool 3 times in parallel. We can force it to call only a single tool once by using the ``parallel_tool_call`` parameter."]@@ -99,10 +105,24 @@}],"metadata": {+ "kernelspec": {+ "display_name": "Python 3 (ipykernel)",+ "language": "python",+ "name": "python3"+ },"language_info": {- "name": "python"+ "codemirror_mode": {+ "name": "ipython",+ "version": 3+ },+ "file_extension": ".py",+ "mimetype": "text/x-python",+ "name": "python",+ "nbconvert_exporter": "python",+ "pygments_lexer": "ipython3",+ "version": "3.11.9"}},"nbformat": 4,- "nbformat_minor": 2+ "nbformat_minor": 4}diff --git a/docs/docs/how_to/tool_choice.ipynb b/docs/docs/how_to/tool_choice.ipynbindex 6aae687b77..aa9841cd48 100644--- a/docs/docs/how_to/tool_choice.ipynb+++ b/docs/docs/how_to/tool_choice.ipynb@@ -4,7 +4,7 @@"cell_type": "markdown","metadata": {},"source": [- "# How to force tool calling behavior\n",+ "# How to force models to call a tool\n","\n",":::info Prerequisites\n","\n",@@ -125,10 +125,24 @@}],"metadata": {+ "kernelspec": {+ "display_name": "Python 3 (ipykernel)",+ "language": "python",+ "name": "python3"+ },"language_info": {- "name": "python"+ "codemirror_mode": {+ "name": "ipython",+ "version": 3+ },+ "file_extension": ".py",+ "mimetype": "text/x-python",+ "name": "python",+ "nbconvert_exporter": "python",+ "pygments_lexer": "ipython3",+ "version": "3.11.9"}},"nbformat": 4,- "nbformat_minor": 2+ "nbformat_minor": 4}diff --git a/docs/docs/how_to/tool_configure.ipynb b/docs/docs/how_to/tool_configure.ipynbindex dd4e9e6ed5..741199355c 100644--- a/docs/docs/how_to/tool_configure.ipynb+++ b/docs/docs/how_to/tool_configure.ipynb@@ -4,7 +4,7 @@"cell_type": "markdown","metadata": {},"source": [- "# How to access the RunnableConfig object within a custom tool\n",+ "# How to access the RunnableConfig from a tool\n","\n",":::info Prerequisites\n","\n",@@ -110,7 +110,7 @@],"metadata": {"kernelspec": {- "display_name": "Python 3",+ "display_name": "Python 3 (ipykernel)","language": "python","name": "python3"},@@ -124,9 +124,9 @@"name": "python","nbconvert_exporter": "python","pygments_lexer": "ipython3",- "version": "3.10.5"+ "version": "3.11.9"}},"nbformat": 4,- "nbformat_minor": 2+ "nbformat_minor": 4}diff --git a/docs/docs/how_to/tool_results_pass_to_model.ipynb b/docs/docs/how_to/tool_results_pass_to_model.ipynbindex d5ef8a9ed1..07e116b7cd 100644--- a/docs/docs/how_to/tool_results_pass_to_model.ipynb+++ b/docs/docs/how_to/tool_results_pass_to_model.ipynb@@ -4,7 +4,7 @@"cell_type": "markdown","metadata": {},"source": [- "# How to pass tool outputs to the model\n",+ "# How to pass tool outputs to chat models\n","\n",":::info Prerequisites\n","This guide assumes familiarity with the following concepts:\n",diff --git a/docs/docs/how_to/tool_runtime.ipynb b/docs/docs/how_to/tool_runtime.ipynbindex 81ee8943b1..71ce83e886 100644--- a/docs/docs/how_to/tool_runtime.ipynb+++ b/docs/docs/how_to/tool_runtime.ipynb@@ -4,7 +4,7 @@"cell_type": "markdown","metadata": {},"source": [- "# How to pass run time values to a tool\n",+ "# How to pass run time values to tools\n","\n",":::info Prerequisites\n","\n",diff --git a/docs/docs/how_to/tool_stream_events.ipynb b/docs/docs/how_to/tool_stream_events.ipynbindex 498593e9e6..3cf3f1ae21 100644--- a/docs/docs/how_to/tool_stream_events.ipynb+++ b/docs/docs/how_to/tool_stream_events.ipynb@@ -4,7 +4,7 @@"cell_type": "markdown","metadata": {},"source": [- "# How to stream events from child runs within a custom tool\n",+ "# How to stream events from a tool\n","\n",":::info Prerequisites\n","\n",@@ -294,7 +294,7 @@"name": "python","nbconvert_exporter": "python","pygments_lexer": "ipython3",- "version": "3.11.4"+ "version": "3.11.9"}},"nbformat": 4,diff --git a/docs/docs/how_to/tools_builtin.ipynb b/docs/docs/how_to/tools_builtin.ipynbindex 7d4f05a7d4..4eaf033531 100644--- a/docs/docs/how_to/tools_builtin.ipynb+++ b/docs/docs/how_to/tools_builtin.ipynb@@ -228,7 +228,7 @@"name": "python","nbconvert_exporter": "python","pygments_lexer": "ipython3",- "version": "3.11.4"+ "version": "3.11.9"}},"nbformat": 4,