Skip to content

Building AI agents, atomically

update docs

KennyVaneetvelde3332a3964f37
diff --git a/docs/api/README.md b/docs/api/README.md
index bc75962..e7a9563 100644
--- a/docs/api/README.md
+++ b/docs/api/README.md
@@ -15,11 +15,11 @@ A full list of `Atomic_agents` project modules.
- [Models](atomic_agents/lib/models/index.md#models)
- [WebDocument](atomic_agents/lib/models/web_document.md#webdocument)
- [Tools](atomic_agents/lib/tools/index.md#tools)
- - [Base](atomic_agents/lib/tools/base.md#base)
+ - [BaseTool](atomic_agents/lib/tools/base_tool.md#basetool)
- [CalculatorTool](atomic_agents/lib/tools/calculator_tool.md#calculatortool)
- [ContentScrapingTool](atomic_agents/lib/tools/content_scraping_tool.md#contentscrapingtool)
- [Yelp Restaurant Finder Tool](atomic_agents/lib/tools/yelp_restaurant_finder_tool.md#yelp-restaurant-finder-tool)
- - [Yt Transcript Scraper](atomic_agents/lib/tools/yt_transcript_scraper_tool.md#yt-transcript-scraper)
+ - [Yt Transcript Scraper Tool](atomic_agents/lib/tools/yt_transcript_scraper_tool.md#yt-transcript-scraper-tool)
- [Utils](atomic_agents/lib/utils/index.md#utils)
- [Format Tool Message](atomic_agents/lib/utils/format_tool_message.md#format-tool-message)
- [Scraping](atomic_agents/lib/utils/scraping/index.md#scraping)
diff --git a/docs/api/atomic_agents/agents/base_agent.md b/docs/api/atomic_agents/agents/base_agent.md
index ab50752..29ac9c6 100644
--- a/docs/api/atomic_agents/agents/base_agent.md
+++ b/docs/api/atomic_agents/agents/base_agent.md
@@ -13,9 +13,9 @@
- [BaseAgent().run](#baseagent()run)
- [BaseAgent().unregister_context_provider](#baseagent()unregister_context_provider)
- [BaseAgentConfig](#baseagentconfig)
- - [BaseIOSchema](#baseagentio)
- [BaseAgentInputSchema](#baseagentinputschema)
- [BaseAgentOutputSchema](#baseagentoutputschema)
+ - [BaseIOSchema](#baseioschema)
## BaseAgent
@@ -155,7 +155,7 @@ def run(self, user_input: Optional[Type[BaseIOSchema]] = None) -> Type[BaseIOSch
#### See also
-- [BaseIOSchema](#baseagentio)
+- [BaseIOSchema](#baseioschema)
### BaseAgent().unregister_context_provider
@@ -187,20 +187,6 @@ class BaseAgentConfig(BaseModel): ...
-## BaseIOSchema
-
-[Show source in base_agent.py:11](../../../../atomic_agents/agents/base_agent.py#L11)
-
-Base class for input and output schemas for chat agents.
-
-#### Signature
-
-```python
-class BaseIOSchema(BaseModel): ...
-```
-
-
-
## BaseAgentInputSchema
[Show source in base_agent.py:24](../../../../atomic_agents/agents/base_agent.py#L24)
@@ -213,7 +199,7 @@ class BaseAgentInputSchema(BaseIOSchema): ...
#### See also
-- [BaseIOSchema](#baseagentio)
+- [BaseIOSchema](#baseioschema)
@@ -229,4 +215,18 @@ class BaseAgentOutputSchema(BaseIOSchema): ...
#### See also
-- [BaseIOSchema](#baseagentio)
\ No newline at end of file
+- [BaseIOSchema](#baseioschema)
+
+
+
+## BaseIOSchema
+
+[Show source in base_agent.py:11](../../../../atomic_agents/agents/base_agent.py#L11)
+
+Base class for input and output schemas for chat agents.
+
+#### Signature
+
+```python
+class BaseIOSchema(BaseModel): ...
+```
\ No newline at end of file
diff --git a/docs/api/atomic_agents/agents/tool_interface_agent.md b/docs/api/atomic_agents/agents/tool_interface_agent.md
index b999711..609d6fc 100644
--- a/docs/api/atomic_agents/agents/tool_interface_agent.md
+++ b/docs/api/atomic_agents/agents/tool_interface_agent.md
@@ -5,30 +5,13 @@
> Auto-generated documentation for [atomic_agents.agents.tool_interface_agent](../../../../atomic_agents/agents/tool_interface_agent.py) module.
- [ToolInterfaceAgent](#toolinterfaceagent)
- - [ToolInputModel](#toolinputmodel)
- [ToolInterfaceAgent](#toolinterfaceagent-1)
- - [ToolInterfaceAgent()._get_and_handle_response](#toolinterfaceagent()_get_and_handle_response)
+ - [ToolInterfaceAgent().get_response](#toolinterfaceagent()get_response)
- [ToolInterfaceAgentConfig](#toolinterfaceagentconfig)
-## ToolInputModel
-
-[Show source in tool_interface_agent.py:16](../../../../atomic_agents/agents/tool_interface_agent.py#L16)
-
-#### Signature
-
-```python
-class ToolInputModel(BaseIOSchema): ...
-```
-
-#### See also
-
-- [BaseIOSchema](./base_agent.md#baseagentio)
-
-
-
## ToolInterfaceAgent
-[Show source in tool_interface_agent.py:28](../../../../atomic_agents/agents/tool_interface_agent.py#L28)
+[Show source in tool_interface_agent.py:16](../../../../atomic_agents/agents/tool_interface_agent.py#L16)
A specialized chat agent designed to interact with a specific tool.
@@ -52,9 +35,9 @@ class ToolInterfaceAgent(BaseAgent):
- [BaseAgent](./base_agent.md#baseagent)
- [ToolInterfaceAgentConfig](#toolinterfaceagentconfig)
-### ToolInterfaceAgent()._get_and_handle_response
+### ToolInterfaceAgent().get_response
-[Show source in tool_interface_agent.py:104](../../../../atomic_agents/agents/tool_interface_agent.py#L104)
+[Show source in tool_interface_agent.py:90](../../../../atomic_agents/agents/tool_interface_agent.py#L90)
Handles obtaining and processing the response from the tool.
@@ -69,7 +52,7 @@ the raw tool output; otherwise, it processes the output and returns the response
#### Signature
```python
-def _get_and_handle_response(self): ...
+def get_response(self, response_model=None): ...
```
diff --git a/docs/api/atomic_agents/lib/components/system_prompt_generator.md b/docs/api/atomic_agents/lib/components/system_prompt_generator.md
index 1eb4ba6..465afc3 100644
--- a/docs/api/atomic_agents/lib/components/system_prompt_generator.md
+++ b/docs/api/atomic_agents/lib/components/system_prompt_generator.md
@@ -9,11 +9,10 @@
- [SystemPromptContextProviderBase().get_info](#systempromptcontextproviderbase()get_info)
- [SystemPromptGenerator](#systempromptgenerator-1)
- [SystemPromptGenerator().generate_prompt](#systempromptgenerator()generate_prompt)
- - [SystemPromptInfo](#systempromptinfo)
## SystemPromptContextProviderBase
-[Show source in system_prompt_generator.py:6](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L6)
+[Show source in system_prompt_generator.py:5](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L5)
#### Signature
@@ -24,7 +23,7 @@ class SystemPromptContextProviderBase(ABC):
### SystemPromptContextProviderBase().get_info
-[Show source in system_prompt_generator.py:10](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L10)
+[Show source in system_prompt_generator.py:9](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L9)
#### Signature
@@ -37,37 +36,31 @@ def get_info(self) -> str: ...
## SystemPromptGenerator
-[Show source in system_prompt_generator.py:26](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L26)
+[Show source in system_prompt_generator.py:17](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L17)
#### Signature
```python
class SystemPromptGenerator:
- def __init__(self, system_prompt_info: Optional[SystemPromptInfo] = None): ...
+ def __init__(
+ self,
+ background: Optional[List[str]] = None,
+ steps: Optional[List[str]] = None,
+ output_instructions: Optional[List[str]] = None,
+ context_providers: Optional[Dict[str, SystemPromptContextProviderBase]] = None,
+ ): ...
```
#### See also
-- [SystemPromptInfo](#systempromptinfo)
+- [SystemPromptContextProviderBase](#systempromptcontextproviderbase)
### SystemPromptGenerator().generate_prompt
-[Show source in system_prompt_generator.py:39](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L39)
+[Show source in system_prompt_generator.py:37](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L37)
#### Signature
```python
def generate_prompt(self) -> str: ...
-```
-
-
-
-## SystemPromptInfo
-
-[Show source in system_prompt_generator.py:19](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L19)
-
-#### Signature
-
-```python
-class SystemPromptInfo: ...
```
\ No newline at end of file
diff --git a/docs/api/atomic_agents/lib/models/web_document.md b/docs/api/atomic_agents/lib/models/web_document.md
index a3b6ac1..157149e 100644
--- a/docs/api/atomic_agents/lib/models/web_document.md
+++ b/docs/api/atomic_agents/lib/models/web_document.md
@@ -20,7 +20,7 @@ class WebDocument(BaseIOSchema): ...
#### See also
-- [BaseIOSchema](../../agents/base_agent.md#baseagentio)
+- [BaseIOSchema](../../agents/base_agent.md#baseioschema)
diff --git a/docs/api/atomic_agents/lib/tools/base.md b/docs/api/atomic_agents/lib/tools/base_tool.md
similarity index 74%
rename from docs/api/atomic_agents/lib/tools/base.md
rename to docs/api/atomic_agents/lib/tools/base_tool.md
index 7287245..b7e5365 100644
--- a/docs/api/atomic_agents/lib/tools/base.md
+++ b/docs/api/atomic_agents/lib/tools/base_tool.md
@@ -1,17 +1,17 @@
-# Base
+# BaseTool
-[Atomic_agents Index](../../../README.md#atomic_agents-index) / [Atomic Agents](../../index.md#atomic-agents) / [Lib](../index.md#lib) / [Tools](./index.md#tools) / Base
+[Atomic_agents Index](../../../README.md#atomic_agents-index) / [Atomic Agents](../../index.md#atomic-agents) / [Lib](../index.md#lib) / [Tools](./index.md#tools) / BaseTool
-> Auto-generated documentation for [atomic_agents.lib.tools.base](../../../../../atomic_agents/lib/tools/base.py) module.
+> Auto-generated documentation for [atomic_agents.lib.tools.base_tool](../../../../../atomic_agents/lib/tools/base_tool.py) module.
-- [Base](#base)
- - [BaseTool](#basetool)
+- [BaseTool](#basetool)
+ - [BaseTool](#basetool-1)
- [BaseTool().run](#basetool()run)
- [BaseToolConfig](#basetoolconfig)
## BaseTool
-[Show source in base.py:13](../../../../../atomic_agents/lib/tools/base.py#L13)
+[Show source in base_tool.py:13](../../../../../atomic_agents/lib/tools/base_tool.py#L13)
Base class for all tools in the Atomic Agents framework.
@@ -36,7 +36,7 @@ class BaseTool:
### BaseTool().run
-[Show source in base.py:38](../../../../../atomic_agents/lib/tools/base.py#L38)
+[Show source in base_tool.py:38](../../../../../atomic_agents/lib/tools/base_tool.py#L38)
Runs the tool with the given parameters. This method should be implemented by subclasses.
@@ -60,13 +60,13 @@ def run(self, params: Type[BaseIOSchema]) -> BaseIOSchema: ...
#### See also
-- [BaseIOSchema](../../agents/base_agent.md#baseagentio)
+- [BaseIOSchema](../../agents/base_agent.md#baseioschema)
## BaseToolConfig
-[Show source in base.py:8](../../../../../atomic_agents/lib/tools/base.py#L8)
+[Show source in base_tool.py:8](../../../../../atomic_agents/lib/tools/base_tool.py#L8)
#### Signature
diff --git a/docs/api/atomic_agents/lib/tools/calculator_tool.md b/docs/api/atomic_agents/lib/tools/calculator_tool.md
index c3123d2..cbd0f6a 100644
--- a/docs/api/atomic_agents/lib/tools/calculator_tool.md
+++ b/docs/api/atomic_agents/lib/tools/calculator_tool.md
@@ -8,12 +8,12 @@
- [CalculatorTool](#calculatortool-1)
- [CalculatorTool().run](#calculatortool()run)
- [CalculatorToolConfig](#calculatortoolconfig)
+ - [CalculatorToolInputSchema](#calculatortoolinputschema)
- [CalculatorToolOutputSchema](#calculatortooloutputschema)
- - [CalculatorToolInputSchema](#CalculatorToolInputSchema)
## CalculatorTool
-[Show source in calculator_tool.py:43](../../../../../atomic_agents/lib/tools/calculator_tool.py#L43)
+[Show source in calculator_tool.py:40](../../../../../atomic_agents/lib/tools/calculator_tool.py#L40)
Tool for performing calculations based on the provided mathematical expression.
@@ -31,12 +31,12 @@ class CalculatorTool(BaseTool):
#### See also
-- [BaseTool](./base.md#basetool)
+- [BaseTool](./base_tool.md#basetool)
- [CalculatorToolConfig](#calculatortoolconfig)
### CalculatorTool().run
-[Show source in calculator_tool.py:64](../../../../../atomic_agents/lib/tools/calculator_tool.py#L64)
+[Show source in calculator_tool.py:61](../../../../../atomic_agents/lib/tools/calculator_tool.py#L61)
Runs the CalculatorTool with the given parameters.
@@ -56,14 +56,14 @@ def run(self, params: CalculatorToolInputSchema) -> CalculatorToolOutputSchema:
#### See also
+- [CalculatorToolInputSchema](#calculatortoolinputschema)
- [CalculatorToolOutputSchema](#calculatortooloutputschema)
-- [CalculatorToolInputSchema](#CalculatorToolInputSchema)
## CalculatorToolConfig
-[Show source in calculator_tool.py:39](../../../../../atomic_agents/lib/tools/calculator_tool.py#L39)
+[Show source in calculator_tool.py:36](../../../../../atomic_agents/lib/tools/calculator_tool.py#L36)
#### Signature
@@ -73,36 +73,36 @@ class CalculatorToolConfig(BaseToolConfig): ...
#### See also
-- [BaseToolConfig](./base.md#basetoolconfig)
+- [BaseToolConfig](./base_tool.md#basetoolconfig)
-## CalculatorToolOutputSchema
+## CalculatorToolInputSchema
-[Show source in calculator_tool.py:32](../../../../../atomic_agents/lib/tools/calculator_tool.py#L32)
+[Show source in calculator_tool.py:12](../../../../../atomic_agents/lib/tools/calculator_tool.py#L12)
#### Signature
```python
-class CalculatorToolOutputSchema(BaseIOSchema): ...
+class CalculatorToolInputSchema(BaseIOSchema): ...
```
#### See also
-- [BaseIOSchema](../../agents/base_agent.md#baseagentio)
+- [BaseIOSchema](../../agents/base_agent.md#baseioschema)
-## CalculatorToolInputSchema
+## CalculatorToolOutputSchema
-[Show source in calculator_tool.py:13](../../../../../atomic_agents/lib/tools/calculator_tool.py#L13)
+[Show source in calculator_tool.py:29](../../../../../atomic_agents/lib/tools/calculator_tool.py#L29)
#### Signature
```python
-class CalculatorToolInputSchema(BaseIOSchema): ...
+class CalculatorToolOutputSchema(BaseIOSchema): ...
```
#### See also
-- [BaseIOSchema](../../agents/base_agent.md#baseagentio)
\ No newline at end of file
+- [BaseIOSchema](../../agents/base_agent.md#baseioschema)
\ No newline at end of file
diff --git a/docs/api/atomic_agents/lib/tools/content_scraping_tool.md b/docs/api/atomic_agents/lib/tools/content_scraping_tool.md
index 3d2cb47..1f28584 100644
--- a/docs/api/atomic_agents/lib/tools/content_scraping_tool.md
+++ b/docs/api/atomic_agents/lib/tools/content_scraping_tool.md
@@ -19,8 +19,8 @@
- [ContentScrapingTool](#contentscrapingtool-1)
- [ContentScrapingTool().run](#contentscrapingtool()run)
- [ContentScrapingToolConfig](#contentscrapingtoolconfig)
+ - [ContentScrapingToolInputSchema](#contentscrapingtoolinputschema)
- [ContentScrapingToolOutputSchema](#contentscrapingtooloutputschema)
- - [ContentScrapingToolInputSchema](#ContentScrapingToolInputSchema)
## ContentScrapingTool
@@ -44,7 +44,7 @@ class ContentScrapingTool(BaseTool):
#### See also
-- [BaseTool](./base.md#basetool)
+- [BaseTool](./base_tool.md#basetool)
- [ContentScrapingToolConfig](#contentscrapingtoolconfig)
### ContentScrapingTool().run
@@ -64,13 +64,15 @@ Runs the ContentScrapingTool with the given parameters.
#### Signature
```python
-def run(self, params: ContentScrapingToolInputSchema) -> ContentScrapingToolOutputSchema: ...
+def run(
+ self, params: ContentScrapingToolInputSchema
+) -> ContentScrapingToolOutputSchema: ...
```
#### See also
+- [ContentScrapingToolInputSchema](#contentscrapingtoolinputschema)
- [ContentScrapingToolOutputSchema](#contentscrapingtooloutputschema)
-- [ContentScrapingToolInputSchema](#ContentScrapingToolInputSchema)
@@ -86,36 +88,36 @@ class ContentScrapingToolConfig(BaseToolConfig): ...
#### See also
-- [BaseToolConfig](./base.md#basetoolconfig)
+- [BaseToolConfig](./base_tool.md#basetoolconfig)
-## ContentScrapingToolOutputSchema
+## ContentScrapingToolInputSchema
-[Show source in content_scraping_tool.py:38](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L38)
+[Show source in content_scraping_tool.py:21](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L21)
#### Signature
```python
-class ContentScrapingToolOutputSchema(BaseIOSchema): ...
+class ContentScrapingToolInputSchema(BaseIOSchema): ...
```
#### See also
-- [BaseIOSchema](../../agents/base_agent.md#baseagentio)
+- [BaseIOSchema](../../agents/base_agent.md#baseioschema)
-## ContentScrapingToolInputSchema
+## ContentScrapingToolOutputSchema
-[Show source in content_scraping_tool.py:21](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L21)
+[Show source in content_scraping_tool.py:38](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L38)
#### Signature
```python
-class ContentScrapingToolInputSchema(BaseIOSchema): ...
+class ContentScrapingToolOutputSchema(BaseIOSchema): ...
```
#### See also
-- [BaseIOSchema](../../agents/base_agent.md#baseagentio)
\ No newline at end of file
+- [BaseIOSchema](../../agents/base_agent.md#baseioschema)
\ No newline at end of file
diff --git a/docs/api/atomic_agents/lib/tools/index.md b/docs/api/atomic_agents/lib/tools/index.md
index c2c25f2..17fc170 100644
--- a/docs/api/atomic_agents/lib/tools/index.md
+++ b/docs/api/atomic_agents/lib/tools/index.md
@@ -9,8 +9,8 @@
## Modules
-- [Base](./base.md)
+- [BaseTool](./base_tool.md)
- [CalculatorTool](./calculator_tool.md)
- [ContentScrapingTool](./content_scraping_tool.md)
- [Yelp Restaurant Finder Tool](./yelp_restaurant_finder_tool.md)
-- [Yt Transcript Scraper](./yt_transcript_scraper_tool.md)
\ No newline at end of file
+- [Yt Transcript Scraper Tool](./yt_transcript_scraper_tool.md)
\ No newline at end of file
diff --git a/docs/api/atomic_agents/lib/tools/yelp_restaurant_finder_tool.md b/docs/api/atomic_agents/lib/tools/yelp_restaurant_finder_tool.md
index 35f0e75..ac052d9 100644
--- a/docs/api/atomic_agents/lib/tools/yelp_restaurant_finder_tool.md
+++ b/docs/api/atomic_agents/lib/tools/yelp_restaurant_finder_tool.md
@@ -11,8 +11,8 @@
- [YelpSearchTool](#yelpsearchtool)
- [YelpSearchTool().run](#yelpsearchtool()run)
- [YelpSearchToolConfig](#yelpsearchtoolconfig)
+ - [YelpSearchToolInputSchema](#yelpsearchtoolinputschema)
- [YelpSearchToolOutputSchema](#yelpsearchtooloutputschema)
- - [YelpSearchToolInputSchema](#YelpSearchToolInputSchema)
## PriceRange
@@ -50,7 +50,7 @@ class YelpSearchResultSchema(BaseIOSchema): ...
#### See also
-- [BaseIOSchema](../../agents/base_agent.md#baseagentio)
+- [BaseIOSchema](../../agents/base_agent.md#baseioschema)
@@ -76,7 +76,7 @@ class YelpSearchTool(BaseTool):
#### See also
-- [BaseTool](./base.md#basetool)
+- [BaseTool](./base_tool.md#basetool)
- [YelpSearchToolConfig](#yelpsearchtoolconfig)
### YelpSearchTool().run
@@ -107,8 +107,8 @@ def run(self, params: YelpSearchToolInputSchema) -> YelpSearchToolOutputSchema:
#### See also
+- [YelpSearchToolInputSchema](#yelpsearchtoolinputschema)
- [YelpSearchToolOutputSchema](#yelpsearchtooloutputschema)
-- [YelpSearchToolInputSchema](#YelpSearchToolInputSchema)
@@ -124,36 +124,36 @@ class YelpSearchToolConfig(BaseToolConfig): ...
#### See also
-- [BaseToolConfig](./base.md#basetoolconfig)
+- [BaseToolConfig](./base_tool.md#basetoolconfig)
-## YelpSearchToolOutputSchema
+## YelpSearchToolInputSchema
-[Show source in yelp_restaurant_finder_tool.py:88](../../../../../atomic_agents/lib/tools/yelp_restaurant_finder_tool.py#L88)
+[Show source in yelp_restaurant_finder_tool.py:46](../../../../../atomic_agents/lib/tools/yelp_restaurant_finder_tool.py#L46)
#### Signature
```python
-class YelpSearchToolOutputSchema(BaseIOSchema): ...
+class YelpSearchToolInputSchema(BaseIOSchema): ...
```
#### See also
-- [BaseIOSchema](../../agents/base_agent.md#baseagentio)
+- [BaseIOSchema](../../agents/base_agent.md#baseioschema)
-## YelpSearchToolInputSchema
+## YelpSearchToolOutputSchema
-[Show source in yelp_restaurant_finder_tool.py:46](../../../../../atomic_agents/lib/tools/yelp_restaurant_finder_tool.py#L46)
+[Show source in yelp_restaurant_finder_tool.py:88](../../../../../atomic_agents/lib/tools/yelp_restaurant_finder_tool.py#L88)
#### Signature
```python
-class YelpSearchToolInputSchema(BaseIOSchema): ...
+class YelpSearchToolOutputSchema(BaseIOSchema): ...
```
#### See also
-- [BaseIOSchema](../../agents/base_agent.md#baseagentio)
\ No newline at end of file
+- [BaseIOSchema](../../agents/base_agent.md#baseioschema)
\ No newline at end of file
diff --git a/docs/api/atomic_agents/lib/tools/yt_transcript_scraper.md b/docs/api/atomic_agents/lib/tools/yt_transcript_scraper_tool.md
similarity index 85%
rename from docs/api/atomic_agents/lib/tools/yt_transcript_scraper.md
rename to docs/api/atomic_agents/lib/tools/yt_transcript_scraper_tool.md
index 2c8b9b4..e918f70 100644
--- a/docs/api/atomic_agents/lib/tools/yt_transcript_scraper.md
+++ b/docs/api/atomic_agents/lib/tools/yt_transcript_scraper_tool.md
@@ -1,17 +1,17 @@
-# Yt Transcript Scraper
+# Yt Transcript Scraper Tool
-[Atomic_agents Index](../../../README.md#atomic_agents-index) / [Atomic Agents](../../index.md#atomic-agents) / [Lib](../index.md#lib) / [Tools](./index.md#tools) / Yt Transcript Scraper
+[Atomic_agents Index](../../../README.md#atomic_agents-index) / [Atomic Agents](../../index.md#atomic-agents) / [Lib](../index.md#lib) / [Tools](./index.md#tools) / Yt Transcript Scraper Tool
-> Auto-generated documentation for [atomic_agents.lib.tools.yt_transcript_scraper](../../../../../atomic_agents/lib/tools/yt_transcript_scraper_tool.py) module.
+> Auto-generated documentation for [atomic_agents.lib.tools.yt_transcript_scraper_tool](../../../../../atomic_agents/lib/tools/yt_transcript_scraper_tool.py) module.
-- [Yt Transcript Scraper](#yt-transcript-scraper)
+- [Yt Transcript Scraper Tool](#yt-transcript-scraper-tool)
- [YouTubeTranscriptTool](#youtubetranscripttool)
- [YouTubeTranscriptTool.extract_video_id](#youtubetranscripttoolextract_video_id)
- [YouTubeTranscriptTool().fetch_video_metadata](#youtubetranscripttool()fetch_video_metadata)
- [YouTubeTranscriptTool().run](#youtubetranscripttool()run)
- [YouTubeTranscriptToolConfig](#youtubetranscripttoolconfig)
+ - [YouTubeTranscriptToolInputSchema](#youtubetranscripttoolinputschema)
- [YouTubeTranscriptToolOutputSchema](#youtubetranscripttooloutputschema)
- - [YouTubeTranscriptToolInputSchema](#YouTubeTranscriptToolInputSchema)
## YouTubeTranscriptTool
@@ -33,7 +33,7 @@ class YouTubeTranscriptTool(BaseTool):
#### See also
-- [BaseTool](./base.md#basetool)
+- [BaseTool](./base_tool.md#basetool)
- [YouTubeTranscriptToolConfig](#youtubetranscripttoolconfig)
### YouTubeTranscriptTool.extract_video_id
@@ -105,8 +105,8 @@ def run(
#### See also
+- [YouTubeTranscriptToolInputSchema](#youtubetranscripttoolinputschema)
- [YouTubeTranscriptToolOutputSchema](#youtubetranscripttooloutputschema)
-- [YouTubeTranscriptToolInputSchema](#YouTubeTranscriptToolInputSchema)
@@ -122,36 +122,36 @@ class YouTubeTranscriptToolConfig(BaseToolConfig): ...
#### See also
-- [BaseToolConfig](./base.md#basetoolconfig)
+- [BaseToolConfig](./base_tool.md#basetoolconfig)
-## YouTubeTranscriptToolOutputSchema
+## YouTubeTranscriptToolInputSchema
-[Show source in yt_transcript_scraper_tool.py:35](../../../../../atomic_agents/lib/tools/yt_transcript_scraper_tool.py#L35)
+[Show source in yt_transcript_scraper_tool.py:17](../../../../../atomic_agents/lib/tools/yt_transcript_scraper_tool.py#L17)
#### Signature
```python
-class YouTubeTranscriptToolOutputSchema(BaseIOSchema): ...
+class YouTubeTranscriptToolInputSchema(BaseIOSchema): ...
```
#### See also
-- [BaseIOSchema](../../agents/base_agent.md#baseagentio)
+- [BaseIOSchema](../../agents/base_agent.md#baseioschema)
-## YouTubeTranscriptToolInputSchema
+## YouTubeTranscriptToolOutputSchema
-[Show source in yt_transcript_scraper_tool.py:17](../../../../../atomic_agents/lib/tools/yt_transcript_scraper_tool.py#L17)
+[Show source in yt_transcript_scraper_tool.py:35](../../../../../atomic_agents/lib/tools/yt_transcript_scraper_tool.py#L35)
#### Signature
```python
-class YouTubeTranscriptToolInputSchema(BaseIOSchema): ...
+class YouTubeTranscriptToolOutputSchema(BaseIOSchema): ...
```
#### See also
-- [BaseIOSchema](../../agents/base_agent.md#baseagentio)
\ No newline at end of file
+- [BaseIOSchema](../../agents/base_agent.md#baseioschema)
\ No newline at end of file
diff --git a/docs/api/atomic_agents/lib/utils/format_tool_message.md b/docs/api/atomic_agents/lib/utils/format_tool_message.md
index a34734f..b3f21cc 100644
--- a/docs/api/atomic_agents/lib/utils/format_tool_message.md
+++ b/docs/api/atomic_agents/lib/utils/format_tool_message.md
@@ -9,14 +9,13 @@
## format_tool_message
-[Show source in format_tool_message.py:7](../../../../../atomic_agents/lib/utils/format_tool_message.py#L7)
+[Show source in format_tool_message.py:8](../../../../../atomic_agents/lib/utils/format_tool_message.py#L8)
Formats a message for a tool call.
#### Arguments
-- `tool_name` *str* - The type of the tool.
-- `tool_calls` *Dict* - A dictionary containing the tool calls.
+- `tool_call` *Type[BaseModel]* - The Pydantic model instance representing the tool call.
- `tool_id` *str, optional* - The unique identifier for the tool call. If not provided, a random UUID will be generated.
#### Returns