Skip to content

Commit 955739f

Browse files
Split Built-in Tools from Tools in Reference docs (#1520)
1 parent 0e1d95d commit 955739f

File tree

3 files changed

+72
-37
lines changed

3 files changed

+72
-37
lines changed

docs/source/en/_toctree.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,5 +46,9 @@
4646
title: Agent-related objects
4747
- local: reference/models
4848
title: Model-related objects
49-
- local: reference/tools
50-
title: Tool-related objects
49+
- title: Tools
50+
sections:
51+
- title: Tool-related objects
52+
local: reference/tools
53+
- title: Built-in Tools
54+
local: reference/default_tools
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Built-in Tools
2+
3+
Ready-to-use tool implementations provided by the `smolagents` library.
4+
5+
These built-in tools are concrete implementations of the [`Tool`] base class, each designed for specific tasks such as web searching, Python code execution, webpage retrieval, and user interaction.
6+
You can use these tools directly in your agents without having to implement the underlying functionality yourself.
7+
Each tool handles a particular capability and follows a consistent interface, making it easy to compose them into powerful agent workflows.
8+
9+
The built-in tools can be categorized by their primary functions:
10+
- **Information Retrieval**: Search and retrieve information from the web and specific knowledge sources.
11+
- [`ApiWebSearchTool`]
12+
- [`DuckDuckGoSearchTool`]
13+
- [`GoogleSearchTool`]
14+
- [`WebSearchTool`]
15+
- [`WikipediaSearchTool`]
16+
- **Web Interaction**: Fetch and process content from specific web pages.
17+
- [`VisitWebpageTool`]
18+
- **Code Execution**: Dynamic execution of Python code for computational tasks.
19+
- [`PythonInterpreterTool`]
20+
- **User Interaction**: Enable Human-in-the-Loop collaboration between agents and users.
21+
- [`UserInputTool`]: Collect input from users.
22+
- **Speech Processing**: Convert audio to textual data.
23+
- [`SpeechToTextTool`]
24+
- **Workflow Control**: Manage and direct the flow of agent operations.
25+
- [`FinalAnswerTool`]: Conclude agent workflow with final response.
26+
27+
## ApiWebSearchTool
28+
29+
[[autodoc]] smolagents.default_tools.ApiWebSearchTool
30+
31+
## DuckDuckGoSearchTool
32+
33+
[[autodoc]] smolagents.default_tools.DuckDuckGoSearchTool
34+
35+
## FinalAnswerTool
36+
37+
[[autodoc]] smolagents.default_tools.FinalAnswerTool
38+
39+
## GoogleSearchTool
40+
41+
[[autodoc]] smolagents.default_tools.GoogleSearchTool
42+
43+
## PythonInterpreterTool
44+
45+
[[autodoc]] smolagents.default_tools.PythonInterpreterTool
46+
47+
## SpeechToTextTool
48+
49+
[[autodoc]] smolagents.default_tools.SpeechToTextTool
50+
51+
## UserInputTool
52+
53+
[[autodoc]] smolagents.default_tools.UserInputTool
54+
55+
## VisitWebpageTool
56+
57+
[[autodoc]] smolagents.default_tools.VisitWebpageTool
58+
59+
## WebSearchTool
60+
61+
[[autodoc]] smolagents.default_tools.WebSearchTool
62+
63+
## WikipediaSearchTool
64+
65+
[[autodoc]] smolagents.default_tools.WikipediaSearchTool

docs/source/en/reference/tools.md

Lines changed: 1 addition & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ can vary as the APIs or underlying models are prone to change.
1010
To learn more about agents and tools make sure to read the [introductory guide](../index). This page
1111
contains the API docs for the underlying classes.
1212

13-
## Tools
13+
## Tool Base Classes
1414

1515
### load_tool
1616

@@ -28,40 +28,6 @@ contains the API docs for the underlying classes.
2828

2929
[[autodoc]] launch_gradio_demo
3030

31-
## Default tools
32-
33-
### PythonInterpreterTool
34-
35-
[[autodoc]] PythonInterpreterTool
36-
37-
### FinalAnswerTool
38-
39-
[[autodoc]] FinalAnswerTool
40-
41-
### UserInputTool
42-
43-
[[autodoc]] UserInputTool
44-
45-
### WebSearchTool
46-
47-
[[autodoc]] WebSearchTool
48-
49-
### DuckDuckGoSearchTool
50-
51-
[[autodoc]] DuckDuckGoSearchTool
52-
53-
### GoogleSearchTool
54-
55-
[[autodoc]] GoogleSearchTool
56-
57-
### VisitWebpageTool
58-
59-
[[autodoc]] VisitWebpageTool
60-
61-
### SpeechToTextTool
62-
63-
[[autodoc]] SpeechToTextTool
64-
6531
## ToolCollection
6632

6733
[[autodoc]] ToolCollection

0 commit comments

Comments
 (0)