Skip to content

Building AI agents, atomically

improve docs

KennyVaneetvelde8c5a3be8d462
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 0000000..b154190
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,51 @@
+name: Documentation
+
+on:
+ push:
+ branches: [ main ]
+ pull_request:
+ branches: [ main ]
+ workflow_dispatch:
+
+permissions:
+ contents: read
+ pages: write
+ id-token: write
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+
+ - name: Set up Python
+ uses: actions/setup-python@v4
+ with:
+ python-version: '3.10'
+
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ pip install -e .
+ pip install sphinx sphinx-rtd-theme sphinx-copybutton sphinx-design myst-parser
+
+ - name: Build documentation
+ run: |
+ cd docs
+ make html
+
+ - name: Upload artifact
+ uses: actions/upload-pages-artifact@v2
+ with:
+ path: docs/_build/html
+
+ deploy:
+ needs: build
+ runs-on: ubuntu-latest
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ steps:
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v3
diff --git a/atomic-forge/README.md b/atomic-forge/README.md
index 444970b..3eb010d 100644
--- a/atomic-forge/README.md
+++ b/atomic-forge/README.md
@@ -15,7 +15,9 @@ The Atomic Forge project includes the following tools:
- [Calculator](/atomic-forge/tools/calculator/README.md)
- [SearxNG Search](/atomic-forge/tools/searxng_search/README.md)
+- [Tavily Search](/atomic-forge/tools/tavily_search/README.md)
- [YouTube Transcript Scraper](/atomic-forge/tools/youtube_transcript_scraper/README.md)
+- [Webpage Scraper](/atomic-forge/tools/webpage_scraper/README.md)
## Creating Custom Tools
Creating your own tools is easy! See the [Creating Tools](/atomic-forge/guides/tool_structure.md) guide for more information.
diff --git a/docs/_static/logo.png b/docs/_static/logo.png
new file mode 100644
index 0000000..e5e638b
Binary files /dev/null and b/docs/_static/logo.png differ
diff --git a/docs/agents/base_agent.html b/docs/agents/base_agent.html
deleted file mode 100644
index 5c5d16a..0000000
--- a/docs/agents/base_agent.html
+++ /dev/null
@@ -1,690 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
-<meta name="generator" content="pdoc3 0.11.1">
-<title>atomic_agents.agents.base_agent API documentation</title>
-<meta name="description" content="">
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
-<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
-<script>window.addEventListener('DOMContentLoaded', () => {
-hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
-hljs.highlightAll();
-})</script>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>atomic_agents.agents.base_agent</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="atomic_agents.agents.base_agent.model_from_chunks_async_patched"><code class="name flex">
-<span>async def <span class="ident">model_from_chunks_async_patched</span></span>(<span>cls, json_chunks, **kwargs)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt id="atomic_agents.agents.base_agent.model_from_chunks_patched"><code class="name flex">
-<span>def <span class="ident">model_from_chunks_patched</span></span>(<span>cls, json_chunks, **kwargs)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-</dl>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="atomic_agents.agents.base_agent.BaseAgent"><code class="flex name class">
-<span>class <span class="ident">BaseAgent</span></span>
-<span>(</span><span>config: <a title="atomic_agents.agents.base_agent.BaseAgentConfig" href="#atomic_agents.agents.base_agent.BaseAgentConfig">BaseAgentConfig</a>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Base class for chat agents.</p>
-<p>This class provides the core functionality for handling chat interactions, including managing memory,
-generating system prompts, and obtaining responses from a language model.</p>
-<h2 id="attributes">Attributes</h2>
-<dl>
-<dt><strong><code>input_schema</code></strong> :&ensp;<code>Type[BaseIOSchema]</code></dt>
-<dd>Schema for the input data.</dd>
-<dt><strong><code>output_schema</code></strong> :&ensp;<code>Type[BaseIOSchema]</code></dt>
-<dd>Schema for the output data.</dd>
-<dt><strong><code>client</code></strong></dt>
-<dd>Client for interacting with the language model.</dd>
-<dt><strong><code>model</code></strong> :&ensp;<code>str</code></dt>
-<dd>The model to use for generating responses.</dd>
-<dt><strong><code>memory</code></strong> :&ensp;<code>AgentMemory</code></dt>
-<dd>Memory component for storing chat history.</dd>
-<dt><strong><code>system_prompt_generator</code></strong> :&ensp;<code>SystemPromptGenerator</code></dt>
-<dd>Component for generating system prompts.</dd>
-<dt><strong><code>initial_memory</code></strong> :&ensp;<code>AgentMemory</code></dt>
-<dd>Initial state of the memory.</dd>
-<dt><strong><code>max_tokens</code></strong> :&ensp;<code>int</code></dt>
-<dd>Maximum number of tokens allowed in the response</dd>
-</dl>
-<p>Initializes the BaseAgent.</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>config</code></strong> :&ensp;<code><a title="atomic_agents.agents.base_agent.BaseAgentConfig" href="#atomic_agents.agents.base_agent.BaseAgentConfig">BaseAgentConfig</a></code></dt>
-<dd>Configuration for the chat agent.</dd>
-</dl></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class BaseAgent:
- &#34;&#34;&#34;
- Base class for chat agents.
-
- This class provides the core functionality for handling chat interactions, including managing memory,
- generating system prompts, and obtaining responses from a language model.
-
- Attributes:
- input_schema (Type[BaseIOSchema]): Schema for the input data.
- output_schema (Type[BaseIOSchema]): Schema for the output data.
- client: Client for interacting with the language model.
- model (str): The model to use for generating responses.
- memory (AgentMemory): Memory component for storing chat history.
- system_prompt_generator (SystemPromptGenerator): Component for generating system prompts.
- initial_memory (AgentMemory): Initial state of the memory.
- max_tokens (int): Maximum number of tokens allowed in the response
- &#34;&#34;&#34;
-
- input_schema = BaseAgentInputSchema
- output_schema = BaseAgentOutputSchema
-
- def __init__(self, config: BaseAgentConfig):
- &#34;&#34;&#34;
- Initializes the BaseAgent.
-
- Args:
- config (BaseAgentConfig): Configuration for the chat agent.
- &#34;&#34;&#34;
- self.input_schema = config.input_schema or self.input_schema
- self.output_schema = config.output_schema or self.output_schema
- self.client = config.client
- self.model = config.model
- self.memory = config.memory or AgentMemory()
- self.system_prompt_generator = config.system_prompt_generator or SystemPromptGenerator()
- self.initial_memory = self.memory.copy()
- self.current_user_input = None
- self.temperature = config.temperature
- self.max_tokens = config.max_tokens
-
- def reset_memory(self):
- &#34;&#34;&#34;
- Resets the memory to its initial state.
- &#34;&#34;&#34;
- self.memory = self.initial_memory.copy()
-
- def get_response(self, response_model=None) -&gt; Type[BaseModel]:
- &#34;&#34;&#34;
- Obtains a response from the language model synchronously.
-
- Args:
- response_model (Type[BaseModel], optional):
- The schema for the response data. If not set, self.output_schema is used.
-
- Returns:
- Type[BaseModel]: The response from the language model.
- &#34;&#34;&#34;
- if response_model is None:
- response_model = self.output_schema
-
- messages = [
- {
- &#34;role&#34;: &#34;system&#34;,
- &#34;content&#34;: self.system_prompt_generator.generate_prompt(),
- }
- ] + self.memory.get_history()
-
- response = self.client.chat.completions.create(
- messages=messages,
- model=self.model,
- response_model=response_model,
- temperature=self.temperature,
- max_tokens=self.max_tokens,
- )
-
- return response
-
- def run(self, user_input: Optional[BaseIOSchema] = None) -&gt; BaseIOSchema:
- &#34;&#34;&#34;
- Runs the chat agent with the given user input synchronously.
-
- Args:
- user_input (Optional[BaseIOSchema]): The input from the user. If not provided, skips adding to memory.
-
- Returns:
- BaseIOSchema: The response from the chat agent.
- &#34;&#34;&#34;
- if user_input:
- self.memory.initialize_turn()
- self.current_user_input = user_input
- self.memory.add_message(&#34;user&#34;, user_input)
-
- response = self.get_response(response_model=self.output_schema)
- self.memory.add_message(&#34;assistant&#34;, response)
-
- return response
-
- async def run_async(self, user_input: Optional[BaseIOSchema] = None):
- &#34;&#34;&#34;
- Runs the chat agent with the given user input, supporting streaming output asynchronously.
-
- Args:
- user_input (Optional[BaseIOSchema]): The input from the user. If not provided, skips adding to memory.
-
- Yields:
- BaseModel: Partial responses from the chat agent.
- &#34;&#34;&#34;
- if user_input:
- self.memory.initialize_turn()
- self.current_user_input = user_input
- self.memory.add_message(&#34;user&#34;, user_input)
-
- messages = [
- {
- &#34;role&#34;: &#34;system&#34;,
- &#34;content&#34;: self.system_prompt_generator.generate_prompt(),
- }
- ] + self.memory.get_history()
-
- response_stream = self.client.chat.completions.create_partial(
- model=self.model,
- messages=messages,
- response_model=self.output_schema,
- temperature=self.temperature,
- max_tokens=self.max_tokens,
- stream=True,
- )
-
- async for partial_response in response_stream:
- yield partial_response
-
- full_response_content = self.output_schema(**partial_response.model_dump())
- self.memory.add_message(&#34;assistant&#34;, full_response_content)
-
- async def stream_response_async(self, user_input: Optional[Type[BaseIOSchema]] = None):
- &#34;&#34;&#34;
- Deprecated method for streaming responses asynchronously. Use run_async instead.
-
- Args:
- user_input (Optional[Type[BaseIOSchema]]): The input from the user. If not provided, skips adding to memory.
-
- Yields:
- BaseModel: Partial responses from the chat agent.
- &#34;&#34;&#34;
- warnings.warn(
- &#34;stream_response_async is deprecated and will be removed in version 1.1. Use run_async instead which can be used in the exact same way.&#34;,
- DeprecationWarning,
- stacklevel=2,
- )
- async for response in self.run_async(user_input):
- yield response
-
- def get_context_provider(self, provider_name: str) -&gt; Type[SystemPromptContextProviderBase]:
- &#34;&#34;&#34;
- Retrieves a context provider by name.
-
- Args:
- provider_name (str): The name of the context provider.
-
- Returns:
- SystemPromptContextProviderBase: The context provider if found.
-
- Raises:
- KeyError: If the context provider is not found.
- &#34;&#34;&#34;
- if provider_name not in self.system_prompt_generator.context_providers:
- raise KeyError(f&#34;Context provider &#39;{provider_name}&#39; not found.&#34;)
- return self.system_prompt_generator.context_providers[provider_name]
-
- def register_context_provider(self, provider_name: str, provider: SystemPromptContextProviderBase):
- &#34;&#34;&#34;
- Registers a new context provider.
-
- Args:
- provider_name (str): The name of the context provider.
- provider (SystemPromptContextProviderBase): The context provider instance.
- &#34;&#34;&#34;
- self.system_prompt_generator.context_providers[provider_name] = provider
-
- def unregister_context_provider(self, provider_name: str):
- &#34;&#34;&#34;
- Unregisters an existing context provider.
-
- Args:
- provider_name (str): The name of the context provider to remove.
- &#34;&#34;&#34;
- if provider_name in self.system_prompt_generator.context_providers:
- del self.system_prompt_generator.context_providers[provider_name]
- else:
- raise KeyError(f&#34;Context provider &#39;{provider_name}&#39; not found.&#34;)</code></pre>
-</details>
-<h3>Class variables</h3>
-<dl>
-<dt id="atomic_agents.agents.base_agent.BaseAgent.input_schema"><code class="name">var <span class="ident">input_schema</span></code></dt>
-<dd>
-<div class="desc"><p>This schema represents the input from the user to the AI agent.</p></div>
-</dd>
-<dt id="atomic_agents.agents.base_agent.BaseAgent.output_schema"><code class="name">var <span class="ident">output_schema</span></code></dt>
-<dd>
-<div class="desc"><p>This schema represents the response generated by the chat agent.</p></div>
-</dd>
-</dl>
-<h3>Methods</h3>
-<dl>
-<dt id="atomic_agents.agents.base_agent.BaseAgent.get_context_provider"><code class="name flex">
-<span>def <span class="ident">get_context_provider</span></span>(<span>self, provider_name: str) ‑> Type[<a title="atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase" href="../lib/components/system_prompt_generator.html#atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase">SystemPromptContextProviderBase</a>]</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Retrieves a context provider by name.</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>provider_name</code></strong> :&ensp;<code>str</code></dt>
-<dd>The name of the context provider.</dd>
-</dl>
-<h2 id="returns">Returns</h2>
-<dl>
-<dt><code>SystemPromptContextProviderBase</code></dt>
-<dd>The context provider if found.</dd>
-</dl>
-<h2 id="raises">Raises</h2>
-<dl>
-<dt><code>KeyError</code></dt>
-<dd>If the context provider is not found.</dd>
-</dl></div>
-</dd>
-<dt id="atomic_agents.agents.base_agent.BaseAgent.get_response"><code class="name flex">
-<span>def <span class="ident">get_response</span></span>(<span>self, response_model=None) ‑> Type[pydantic.main.BaseModel]</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Obtains a response from the language model synchronously.</p>
-<h2 id="args">Args</h2>
-<p>response_model (Type[BaseModel], optional):
-The schema for the response data. If not set, self.output_schema is used.</p>
-<h2 id="returns">Returns</h2>
-<dl>
-<dt><code>Type[BaseModel]</code></dt>
-<dd>The response from the language model.</dd>
-</dl></div>
-</dd>
-<dt id="atomic_agents.agents.base_agent.BaseAgent.register_context_provider"><code class="name flex">
-<span>def <span class="ident">register_context_provider</span></span>(<span>self, provider_name: str, provider: <a title="atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase" href="../lib/components/system_prompt_generator.html#atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase">SystemPromptContextProviderBase</a>)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Registers a new context provider.</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>provider_name</code></strong> :&ensp;<code>str</code></dt>
-<dd>The name of the context provider.</dd>
-<dt><strong><code>provider</code></strong> :&ensp;<code>SystemPromptContextProviderBase</code></dt>
-<dd>The context provider instance.</dd>
-</dl></div>
-</dd>
-<dt id="atomic_agents.agents.base_agent.BaseAgent.reset_memory"><code class="name flex">
-<span>def <span class="ident">reset_memory</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Resets the memory to its initial state.</p></div>
-</dd>
-<dt id="atomic_agents.agents.base_agent.BaseAgent.run"><code class="name flex">
-<span>def <span class="ident">run</span></span>(<span>self, user_input: Optional[<a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a>] = None) ‑> <a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a></span>
-</code></dt>
-<dd>
-<div class="desc"><p>Runs the chat agent with the given user input synchronously.</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>user_input</code></strong> :&ensp;<code>Optional[BaseIOSchema]</code></dt>
-<dd>The input from the user. If not provided, skips adding to memory.</dd>
-</dl>
-<h2 id="returns">Returns</h2>
-<dl>
-<dt><code>BaseIOSchema</code></dt>
-<dd>The response from the chat agent.</dd>
-</dl></div>
-</dd>
-<dt id="atomic_agents.agents.base_agent.BaseAgent.run_async"><code class="name flex">
-<span>async def <span class="ident">run_async</span></span>(<span>self, user_input: Optional[<a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a>] = None)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Runs the chat agent with the given user input, supporting streaming output asynchronously.</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>user_input</code></strong> :&ensp;<code>Optional[BaseIOSchema]</code></dt>
-<dd>The input from the user. If not provided, skips adding to memory.</dd>
-</dl>
-<h2 id="yields">Yields</h2>
-<dl>
-<dt><code>BaseModel</code></dt>
-<dd>Partial responses from the chat agent.</dd>
-</dl></div>
-</dd>
-<dt id="atomic_agents.agents.base_agent.BaseAgent.stream_response_async"><code class="name flex">
-<span>async def <span class="ident">stream_response_async</span></span>(<span>self, user_input: Optional[Type[<a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a>]] = None)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Deprecated method for streaming responses asynchronously. Use run_async instead.</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>user_input</code></strong> :&ensp;<code>Optional[Type[BaseIOSchema]]</code></dt>
-<dd>The input from the user. If not provided, skips adding to memory.</dd>
-</dl>
-<h2 id="yields">Yields</h2>
-<dl>
-<dt><code>BaseModel</code></dt>
-<dd>Partial responses from the chat agent.</dd>
-</dl></div>
-</dd>
-<dt id="atomic_agents.agents.base_agent.BaseAgent.unregister_context_provider"><code class="name flex">
-<span>def <span class="ident">unregister_context_provider</span></span>(<span>self, provider_name: str)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Unregisters an existing context provider.</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>provider_name</code></strong> :&ensp;<code>str</code></dt>
-<dd>The name of the context provider to remove.</dd>
-</dl></div>
-</dd>
-</dl>
-</dd>
-<dt id="atomic_agents.agents.base_agent.BaseAgentConfig"><code class="flex name class">
-<span>class <span class="ident">BaseAgentConfig</span></span>
-<span>(</span><span>**data: Any)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Usage docs: <a href="https://docs.pydantic.dev/2.10/concepts/models/">https://docs.pydantic.dev/2.10/concepts/models/</a></p>
-<p>A base class for creating Pydantic models.</p>
-<h2 id="attributes">Attributes</h2>
-<dl>
-<dt><strong><code>__class_vars__</code></strong></dt>
-<dd>The names of the class variables defined on the model.</dd>
-<dt><strong><code>__private_attributes__</code></strong></dt>
-<dd>Metadata about the private attributes of the model.</dd>
-<dt><strong><code>__signature__</code></strong></dt>
-<dd>The synthesized <code>__init__</code> [<code>Signature</code>][inspect.Signature] of the model.</dd>
-<dt><strong><code>__pydantic_complete__</code></strong></dt>
-<dd>Whether model building is completed, or if there are still undefined fields.</dd>
-<dt><strong><code>__pydantic_core_schema__</code></strong></dt>
-<dd>The core schema of the model.</dd>
-<dt><strong><code>__pydantic_custom_init__</code></strong></dt>
-<dd>Whether the model has a custom <code>__init__</code> function.</dd>
-<dt><strong><code>__pydantic_decorators__</code></strong></dt>
-<dd>Metadata containing the decorators defined on the model.
-This replaces <code>Model.__validators__</code> and <code>Model.__root_validators__</code> from Pydantic V1.</dd>
-<dt><strong><code>__pydantic_generic_metadata__</code></strong></dt>
-<dd>Metadata for generic models; contains data used for a similar purpose to
-<strong>args</strong>, <strong>origin</strong>, <strong>parameters</strong> in typing-module generics. May eventually be replaced by these.</dd>
-<dt><strong><code>__pydantic_parent_namespace__</code></strong></dt>
-<dd>Parent namespace of the model, used for automatic rebuilding of models.</dd>
-<dt><strong><code>__pydantic_post_init__</code></strong></dt>
-<dd>The name of the post-init method for the model, if defined.</dd>
-<dt><strong><code>__pydantic_root_model__</code></strong></dt>
-<dd>Whether the model is a [<code>RootModel</code>][pydantic.root_model.RootModel].</dd>
-<dt><strong><code>__pydantic_serializer__</code></strong></dt>
-<dd>The <code>pydantic-core</code> <code>SchemaSerializer</code> used to dump instances of the model.</dd>
-<dt><strong><code>__pydantic_validator__</code></strong></dt>
-<dd>The <code>pydantic-core</code> <code>SchemaValidator</code> used to validate instances of the model.</dd>
-<dt><strong><code>__pydantic_fields__</code></strong></dt>
-<dd>A dictionary of field names and their corresponding [<code>FieldInfo</code>][pydantic.fields.FieldInfo] objects.</dd>
-<dt><strong><code>__pydantic_computed_fields__</code></strong></dt>
-<dd>A dictionary of computed field names and their corresponding [<code>ComputedFieldInfo</code>][pydantic.fields.ComputedFieldInfo] objects.</dd>
-<dt><strong><code>__pydantic_extra__</code></strong></dt>
-<dd>A dictionary containing extra values, if [<code>extra</code>][pydantic.config.ConfigDict.extra]
-is set to <code>'allow'</code>.</dd>
-<dt><strong><code>__pydantic_fields_set__</code></strong></dt>
-<dd>The names of fields explicitly set during instantiation.</dd>
-<dt><strong><code>__pydantic_private__</code></strong></dt>
-<dd>Values of private attributes set on the model instance.</dd>
-</dl>
-<p>Create a new model by parsing and validating input data from keyword arguments.</p>
-<p>Raises [<code>ValidationError</code>][pydantic_core.ValidationError] if the input data cannot be
-validated to form a valid model.</p>
-<p><code>self</code> is explicitly positional-only to allow <code>self</code> as a field name.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class BaseAgentConfig(BaseModel):
- client: instructor.client.Instructor = Field(..., description=&#34;Client for interacting with the language model.&#34;)
- model: str = Field(&#34;gpt-4o-mini&#34;, description=&#34;The model to use for generating responses.&#34;)
- memory: Optional[AgentMemory] = Field(None, description=&#34;Memory component for storing chat history.&#34;)
- system_prompt_generator: Optional[SystemPromptGenerator] = Field(
- None, description=&#34;Component for generating system prompts.&#34;
- )
- input_schema: Optional[Type[BaseModel]] = Field(None, description=&#34;The schema for the input data.&#34;)
- output_schema: Optional[Type[BaseModel]] = Field(None, description=&#34;The schema for the output data.&#34;)
- model_config = {&#34;arbitrary_types_allowed&#34;: True}
- temperature: Optional[float] = Field(
- 0,
- description=&#34;Temperature for response generation, typically ranging from 0 to 1.&#34;,
- )
- max_tokens: Optional[int] = Field(
- None,
- description=&#34;Maximum number of token allowed in the response generation.&#34;,
- )</code></pre>
-</details>
-<h3>Ancestors</h3>
-<ul class="hlist">
-<li>pydantic.main.BaseModel</li>
-</ul>
-<h3>Class variables</h3>
-<dl>
-<dt id="atomic_agents.agents.base_agent.BaseAgentConfig.client"><code class="name">var <span class="ident">client</span> : instructor.client.Instructor</code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-<dt id="atomic_agents.agents.base_agent.BaseAgentConfig.input_schema"><code class="name">var <span class="ident">input_schema</span> : Optional[Type[pydantic.main.BaseModel]]</code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-<dt id="atomic_agents.agents.base_agent.BaseAgentConfig.max_tokens"><code class="name">var <span class="ident">max_tokens</span> : Optional[int]</code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-<dt id="atomic_agents.agents.base_agent.BaseAgentConfig.memory"><code class="name">var <span class="ident">memory</span> : Optional[<a title="atomic_agents.lib.components.agent_memory.AgentMemory" href="../lib/components/agent_memory.html#atomic_agents.lib.components.agent_memory.AgentMemory">AgentMemory</a>]</code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-<dt id="atomic_agents.agents.base_agent.BaseAgentConfig.model"><code class="name">var <span class="ident">model</span> : str</code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-<dt id="atomic_agents.agents.base_agent.BaseAgentConfig.model_config"><code class="name">var <span class="ident">model_config</span></code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-<dt id="atomic_agents.agents.base_agent.BaseAgentConfig.output_schema"><code class="name">var <span class="ident">output_schema</span> : Optional[Type[pydantic.main.BaseModel]]</code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-<dt id="atomic_agents.agents.base_agent.BaseAgentConfig.system_prompt_generator"><code class="name">var <span class="ident">system_prompt_generator</span> : Optional[<a title="atomic_agents.lib.components.system_prompt_generator.SystemPromptGenerator" href="../lib/components/system_prompt_generator.html#atomic_agents.lib.components.system_prompt_generator.SystemPromptGenerator">SystemPromptGenerator</a>]</code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-<dt id="atomic_agents.agents.base_agent.BaseAgentConfig.temperature"><code class="name">var <span class="ident">temperature</span> : Optional[float]</code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-</dl>
-</dd>
-<dt id="atomic_agents.agents.base_agent.BaseAgentInputSchema"><code class="flex name class">
-<span>class <span class="ident">BaseAgentInputSchema</span></span>
-<span>(</span><span>**data: Any)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>This schema represents the input from the user to the AI agent.</p>
-<p>Create a new model by parsing and validating input data from keyword arguments.</p>
-<p>Raises [<code>ValidationError</code>][pydantic_core.ValidationError] if the input data cannot be
-validated to form a valid model.</p>
-<p><code>self</code> is explicitly positional-only to allow <code>self</code> as a field name.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class BaseAgentInputSchema(BaseIOSchema):
- &#34;&#34;&#34;This schema represents the input from the user to the AI agent.&#34;&#34;&#34;
-
- chat_message: str = Field(
- ...,
- description=&#34;The chat message sent by the user to the assistant.&#34;,
- )</code></pre>
-</details>
-<h3>Ancestors</h3>
-<ul class="hlist">
-<li><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a></li>
-<li>pydantic.main.BaseModel</li>
-</ul>
-<h3>Class variables</h3>
-<dl>
-<dt id="atomic_agents.agents.base_agent.BaseAgentInputSchema.chat_message"><code class="name">var <span class="ident">chat_message</span> : str</code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-</dl>
-<h3>Inherited members</h3>
-<ul class="hlist">
-<li><code><b><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a></b></code>:
-<ul class="hlist">
-<li><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_config" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_config">model_config</a></code></li>
-<li><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_json_schema" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_json_schema">model_json_schema</a></code></li>
-</ul>
-</li>
-</ul>
-</dd>
-<dt id="atomic_agents.agents.base_agent.BaseAgentOutputSchema"><code class="flex name class">
-<span>class <span class="ident">BaseAgentOutputSchema</span></span>
-<span>(</span><span>**data: Any)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>This schema represents the response generated by the chat agent.</p>
-<p>Create a new model by parsing and validating input data from keyword arguments.</p>
-<p>Raises [<code>ValidationError</code>][pydantic_core.ValidationError] if the input data cannot be
-validated to form a valid model.</p>
-<p><code>self</code> is explicitly positional-only to allow <code>self</code> as a field name.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class BaseAgentOutputSchema(BaseIOSchema):
- &#34;&#34;&#34;This schema represents the response generated by the chat agent.&#34;&#34;&#34;
-
- chat_message: str = Field(
- ...,
- description=(
- &#34;The chat message exchanged between the user and the chat agent. &#34;
- &#34;This contains the markdown-enabled response generated by the chat agent.&#34;
- ),
- )</code></pre>
-</details>
-<h3>Ancestors</h3>
-<ul class="hlist">
-<li><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a></li>
-<li>pydantic.main.BaseModel</li>
-</ul>
-<h3>Class variables</h3>
-<dl>
-<dt id="atomic_agents.agents.base_agent.BaseAgentOutputSchema.chat_message"><code class="name">var <span class="ident">chat_message</span> : str</code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-</dl>
-<h3>Inherited members</h3>
-<ul class="hlist">
-<li><code><b><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a></b></code>:
-<ul class="hlist">
-<li><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_config" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_config">model_config</a></code></li>
-<li><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_json_schema" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_json_schema">model_json_schema</a></code></li>
-</ul>
-</li>
-</ul>
-</dd>
-</dl>
-</section>
-</article>
-<nav id="sidebar">
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="atomic_agents.agents" href="index.html">atomic_agents.agents</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="atomic_agents.agents.base_agent.model_from_chunks_async_patched" href="#atomic_agents.agents.base_agent.model_from_chunks_async_patched">model_from_chunks_async_patched</a></code></li>
-<li><code><a title="atomic_agents.agents.base_agent.model_from_chunks_patched" href="#atomic_agents.agents.base_agent.model_from_chunks_patched">model_from_chunks_patched</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="atomic_agents.agents.base_agent.BaseAgent" href="#atomic_agents.agents.base_agent.BaseAgent">BaseAgent</a></code></h4>
-<ul class="">
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgent.get_context_provider" href="#atomic_agents.agents.base_agent.BaseAgent.get_context_provider">get_context_provider</a></code></li>
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgent.get_response" href="#atomic_agents.agents.base_agent.BaseAgent.get_response">get_response</a></code></li>
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgent.input_schema" href="#atomic_agents.agents.base_agent.BaseAgent.input_schema">input_schema</a></code></li>
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgent.output_schema" href="#atomic_agents.agents.base_agent.BaseAgent.output_schema">output_schema</a></code></li>
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgent.register_context_provider" href="#atomic_agents.agents.base_agent.BaseAgent.register_context_provider">register_context_provider</a></code></li>
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgent.reset_memory" href="#atomic_agents.agents.base_agent.BaseAgent.reset_memory">reset_memory</a></code></li>
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgent.run" href="#atomic_agents.agents.base_agent.BaseAgent.run">run</a></code></li>
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgent.run_async" href="#atomic_agents.agents.base_agent.BaseAgent.run_async">run_async</a></code></li>
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgent.stream_response_async" href="#atomic_agents.agents.base_agent.BaseAgent.stream_response_async">stream_response_async</a></code></li>
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgent.unregister_context_provider" href="#atomic_agents.agents.base_agent.BaseAgent.unregister_context_provider">unregister_context_provider</a></code></li>
-</ul>
-</li>
-<li>
-<h4><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig" href="#atomic_agents.agents.base_agent.BaseAgentConfig">BaseAgentConfig</a></code></h4>
-<ul class="">
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig.client" href="#atomic_agents.agents.base_agent.BaseAgentConfig.client">client</a></code></li>
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig.input_schema" href="#atomic_agents.agents.base_agent.BaseAgentConfig.input_schema">input_schema</a></code></li>
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig.max_tokens" href="#atomic_agents.agents.base_agent.BaseAgentConfig.max_tokens">max_tokens</a></code></li>
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig.memory" href="#atomic_agents.agents.base_agent.BaseAgentConfig.memory">memory</a></code></li>
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig.model" href="#atomic_agents.agents.base_agent.BaseAgentConfig.model">model</a></code></li>
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig.model_config" href="#atomic_agents.agents.base_agent.BaseAgentConfig.model_config">model_config</a></code></li>
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig.output_schema" href="#atomic_agents.agents.base_agent.BaseAgentConfig.output_schema">output_schema</a></code></li>
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig.system_prompt_generator" href="#atomic_agents.agents.base_agent.BaseAgentConfig.system_prompt_generator">system_prompt_generator</a></code></li>
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig.temperature" href="#atomic_agents.agents.base_agent.BaseAgentConfig.temperature">temperature</a></code></li>
-</ul>
-</li>
-<li>
-<h4><code><a title="atomic_agents.agents.base_agent.BaseAgentInputSchema" href="#atomic_agents.agents.base_agent.BaseAgentInputSchema">BaseAgentInputSchema</a></code></h4>
-<ul class="">
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgentInputSchema.chat_message" href="#atomic_agents.agents.base_agent.BaseAgentInputSchema.chat_message">chat_message</a></code></li>
-</ul>
-</li>
-<li>
-<h4><code><a title="atomic_agents.agents.base_agent.BaseAgentOutputSchema" href="#atomic_agents.agents.base_agent.BaseAgentOutputSchema">BaseAgentOutputSchema</a></code></h4>
-<ul class="">
-<li><code><a title="atomic_agents.agents.base_agent.BaseAgentOutputSchema.chat_message" href="#atomic_agents.agents.base_agent.BaseAgentOutputSchema.chat_message">chat_message</a></code></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
-</footer>
-</body>
-</html>
diff --git a/docs/agents/index.html b/docs/agents/index.html
deleted file mode 100644
index 9dcf756..0000000
--- a/docs/agents/index.html
+++ /dev/null
@@ -1,67 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
-<meta name="generator" content="pdoc3 0.11.1">
-<title>atomic_agents.agents API documentation</title>
-<meta name="description" content="">
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
-<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
-<script>window.addEventListener('DOMContentLoaded', () => {
-hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
-hljs.highlightAll();
-})</script>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>atomic_agents.agents</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="atomic_agents.agents.base_agent" href="base_agent.html">atomic_agents.agents.base_agent</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="atomic_agents" href="../index.html">atomic_agents</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="atomic_agents.agents.base_agent" href="base_agent.html">atomic_agents.agents.base_agent</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
-</footer>
-</body>
-</html>
diff --git a/docs/api/agents.rst b/docs/api/agents.rst
new file mode 100644
index 0000000..d1c1c8b
--- /dev/null
+++ b/docs/api/agents.rst
@@ -0,0 +1,369 @@
+Agents
+======
+
+Base Agent
+----------
+
+The BaseAgent class provides core functionality for building AI agents with structured input/output schemas,
+memory management, and streaming capabilities.
+
+Basic Usage
+^^^^^^^^^^
+
+.. code-block:: python
+
+ import instructor
+ from openai import OpenAI
+ from atomic_agents.agents.base_agent import BaseAgent, BaseAgentConfig
+ from atomic_agents.lib.components.agent_memory import AgentMemory
+
+ # Initialize with OpenAI
+ client = instructor.from_openai(OpenAI())
+
+ # Create basic configuration
+ config = BaseAgentConfig(
+ client=client,
+ model="gpt-4o-mini",
+ memory=AgentMemory()
+ )
+
+ # Initialize agent
+ agent = BaseAgent(config)
+
+Class Documentation
+^^^^^^^^^^^^^^^^^
+
+.. py:class:: BaseAgent
+
+ .. py:method:: __init__(config: BaseAgentConfig)
+
+ Initializes a new BaseAgent instance.
+
+ :param config: Configuration object containing client, model, memory, and other settings
+ :type config: BaseAgentConfig
+
+ Example:
+
+ .. code-block:: python
+
+ # Initialize with custom memory and system prompt
+ from atomic_agents.lib.components.system_prompt_generator import SystemPromptGenerator
+
+ agent = BaseAgent(
+ BaseAgentConfig(
+ client=client,
+ model="gpt-4o-mini",
+ memory=AgentMemory(),
+ system_prompt_generator=SystemPromptGenerator(
+ background=["You are a helpful AI assistant"],
+ steps=["1. Understand the user's request", "2. Provide a clear response"],
+ )
+ )
+ )
+
+ # Print agent configuration
+ print(f"Model: {agent.model}")
+ print(f"Memory: {type(agent.memory).__name__}")
+ print(f"System Prompt: {agent.system_prompt_generator.generate_prompt()}")
+
+ .. py:method:: run(user_input: Optional[BaseIOSchema] = None) -> BaseIOSchema
+
+ Runs the chat agent with the given user input synchronously.
+
+ :param user_input: The input from the user
+ :type user_input: Optional[BaseIOSchema]
+ :return: The response from the chat agent
+ :rtype: BaseIOSchema
+
+ Example:
+
+ .. code-block:: python
+
+ # Basic synchronous interaction
+ user_input = agent.input_schema(chat_message="Tell me about quantum computing")
+ response = agent.run(user_input)
+
+ # Print the response
+ print("\nUser: Tell me about quantum computing")
+ print(f"Assistant: {response.chat_message}")
+
+ .. py:method:: run_async(user_input: Optional[BaseIOSchema] = None)
+
+ Runs the chat agent with streaming output asynchronously.
+
+ :param user_input: The input from the user
+ :type user_input: Optional[BaseIOSchema]
+ :return: An async generator yielding partial responses
+ :rtype: AsyncGenerator[BaseIOSchema, None]
+
+ Example:
+
+ .. code-block:: python
+
+ import asyncio
+ import json
+
+ async def stream_chat():
+ # Initialize with AsyncOpenAI for streaming
+ client = instructor.from_openai(AsyncOpenAI())
+ agent = BaseAgent(BaseAgentConfig(client=client, model="gpt-4o-mini"))
+
+ # Create input and stream response
+ user_input = agent.input_schema(chat_message="Explain streaming")
+ print("\nUser: Explain streaming")
+ print("Assistant: ", end="", flush=True)
+
+ async for partial_response in agent.run_async(user_input):
+ # Print each new token as it arrives
+ if hasattr(partial_response, "chat_message"):
+ print(partial_response.chat_message, end="", flush=True)
+ print() # New line at end
+
+ asyncio.run(stream_chat())
+
+ .. py:method:: reset_memory()
+
+ Resets the agent's memory to its initial state.
+
+ Example:
+
+ .. code-block:: python
+
+ # Use agent for a conversation
+ response1 = agent.run(agent.input_schema(chat_message="Hello!"))
+ print(f"First response: {response1.chat_message}")
+
+ response2 = agent.run(agent.input_schema(chat_message="How are you?"))
+ print(f"Second response: {response2.chat_message}")
+
+ # Reset memory to start fresh
+ agent.reset_memory()
+ print("Memory reset to initial state")
+
+ .. py:method:: get_context_provider(provider_name: str) -> Type[SystemPromptContextProviderBase]
+
+ Retrieves a context provider by name.
+
+ :param provider_name: The name of the context provider
+ :type provider_name: str
+ :return: The context provider if found
+ :rtype: SystemPromptContextProviderBase
+ :raises KeyError: If the context provider is not found
+
+ Example:
+
+ .. code-block:: python
+
+ # Get a specific context provider
+ try:
+ provider = agent.get_context_provider("my_provider")
+ print(f"Found provider: {provider}")
+ except KeyError:
+ print("Provider not found")
+
+ .. py:method:: register_context_provider(provider_name: str, provider: SystemPromptContextProviderBase)
+
+ Registers a new context provider.
+
+ :param provider_name: The name of the context provider
+ :type provider_name: str
+ :param provider: The context provider instance
+ :type provider: SystemPromptContextProviderBase
+
+ Example:
+
+ .. code-block:: python
+
+ from atomic_agents.lib.components.system_prompt_generator import SystemPromptContextProviderBase
+
+ # Create and register a custom context provider
+ class MyContextProvider(SystemPromptContextProviderBase):
+ def get_context(self) -> str:
+ return "Custom context for the agent"
+
+ agent.register_context_provider("my_provider", MyContextProvider())
+ print("Custom context provider registered")
+
+ .. py:method:: unregister_context_provider(provider_name: str)
+
+ Unregisters an existing context provider.
+
+ :param provider_name: The name of the context provider to remove
+ :type provider_name: str
+ :raises KeyError: If the context provider is not found
+
+ Example:
+
+ .. code-block:: python
+
+ # Remove a context provider
+ try:
+ agent.unregister_context_provider("my_provider")
+ print("Provider unregistered")
+ except KeyError:
+ print("Provider not found")
+
+Advanced Usage
+^^^^^^^^^^^^
+
+Here's a complete example showing how to create an interactive chat interface with streaming support:
+
+.. code-block:: python
+
+ import asyncio
+ from openai import AsyncOpenAI, OpenAI
+ import instructor
+ from atomic_agents.agents.base_agent import BaseAgent, BaseAgentConfig
+
+ async def chat_loop(streaming: bool = False):
+ """Interactive chat loop with the AI agent."""
+ # Initialize agent based on streaming mode
+ if streaming:
+ client = instructor.from_openai(AsyncOpenAI())
+ else:
+ client = instructor.from_openai(OpenAI())
+
+ agent = BaseAgent(BaseAgentConfig(client=client, model="gpt-4o-mini"))
+ print("Chat initialized. Type 'exit' to quit.")
+
+ while True:
+ # Get user input
+ user_message = input("\nYou: ")
+ if user_message.lower() == "exit":
+ break
+
+ # Process message
+ user_input = agent.input_schema(chat_message=user_message)
+ print("\nAssistant: ", end="", flush=True)
+
+ if streaming:
+ # Stream response token by token
+ async for partial_response in agent.run_async(user_input):
+ if hasattr(partial_response, "chat_message"):
+ print(partial_response.chat_message, end="", flush=True)
+ print() # New line after response
+ else:
+ # Get complete response
+ response = agent.run(user_input)
+ print(response.chat_message)
+
+ # Run interactive chat with streaming
+ asyncio.run(chat_loop(streaming=True))
+
+Input/Output Schemas
+^^^^^^^^^^^^^^^^^
+
+The BaseAgent uses Pydantic models for input and output validation. You can use the default schemas or create custom ones.
+
+Default Schemas
+"""""""""""""
+
+.. py:class:: BaseAgentInputSchema
+
+ Schema for user input to the agent.
+
+ .. py:attribute:: chat_message
+ :type: str
+
+ The chat message sent by the user to the assistant.
+
+.. py:class:: BaseAgentOutputSchema
+
+ Schema for agent responses.
+
+ .. py:attribute:: chat_message
+ :type: str
+
+ The chat message generated by the agent, with markdown support.
+
+Custom Schema Example
+"""""""""""""""""""
+
+Here's an example of a custom input/output schema pair for an agent that provides suggested follow-up questions:
+
+.. code-block:: python
+
+ from typing import List
+ from pydantic import Field
+ from atomic_agents.lib.base.base_io_schema import BaseIOSchema
+
+ class CustomInputSchema(BaseIOSchema):
+ """Schema for user input with context."""
+ chat_message: str = Field(
+ ...,
+ description="The chat message sent by the user."
+ )
+ context: str = Field(
+ "",
+ description="Optional context for the message."
+ )
+
+ class CustomOutputSchema(BaseIOSchema):
+ """Schema for responses with suggested questions."""
+ chat_message: str = Field(
+ ...,
+ description="The chat message from the agent."
+ )
+ suggested_questions: List[str] = Field(
+ ...,
+ description="Follow-up questions the user could ask."
+ )
+
+ # Use custom schemas with agent
+ agent = BaseAgent(
+ config=BaseAgentConfig(
+ client=client,
+ model="gpt-4o-mini",
+ input_schema=CustomInputSchema,
+ output_schema=CustomOutputSchema
+ )
+ )
+
+ # Example usage
+ response = agent.run(
+ CustomInputSchema(
+ chat_message="Tell me about quantum computing",
+ context="The user is a beginner"
+ )
+ )
+ print(f"Response: {response.chat_message}")
+ print("\nSuggested questions:")
+ for question in response.suggested_questions:
+ print(f"- {question}")
+
+Configuration
+^^^^^^^^^^^
+
+.. py:class:: BaseAgentConfig
+
+ Configuration class for BaseAgent initialization.
+
+ .. py:attribute:: client
+ :type: instructor.client.Instructor
+
+ Client for interacting with the language model.
+
+ .. py:attribute:: model
+ :type: str
+
+ The model to use for generating responses.
+
+ .. py:attribute:: memory
+ :type: Optional[AgentMemory]
+
+ Memory component for storing chat history.
+
+ .. py:attribute:: system_prompt_generator
+ :type: Optional[SystemPromptGenerator]
+
+ Component for generating system prompts.
+
+ .. py:attribute:: temperature
+ :type: Optional[float]
+
+ Temperature for response generation (0 to 1).
+
+ .. py:attribute:: max_tokens
+ :type: Optional[int]
+
+ Maximum number of tokens in responses.
diff --git a/docs/api/components.rst b/docs/api/components.rst
new file mode 100644
index 0000000..f8c7675
--- /dev/null
+++ b/docs/api/components.rst
@@ -0,0 +1,33 @@
+Components
+==========
+
+Agent Memory
+------------
+
+.. automodule:: atomic_agents.lib.components.agent_memory
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :no-index: Message.role Message.content Message.turn_id
+
+System Prompt Generator
+-----------------------
+
+.. automodule:: atomic_agents.lib.components.system_prompt_generator
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Base Components
+---------------
+
+.. automodule:: atomic_agents.lib.base.base_tool
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :no-index: BaseToolConfig.title BaseToolConfig.description BaseTool.input_schema BaseTool.output_schema
+
+.. automodule:: atomic_agents.lib.base.base_io_schema
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/api/index.rst b/docs/api/index.rst
new file mode 100644
index 0000000..73efa32
--- /dev/null
+++ b/docs/api/index.rst
@@ -0,0 +1,28 @@
+API Reference
+=============
+
+This section contains the API reference for all public modules and classes in Atomic Agents.
+
+.. note::
+ Use the sidebar to navigate between different sections of the API reference.
+ You can return to the main documentation using the navigation menu on the left.
+
+.. toctree::
+ :maxdepth: 2
+ :caption: API Sections
+
+ agents
+ components
+ utils
+
+Core Components
+---------------
+
+.. automodule:: atomic_agents
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+.. seealso::
+ - :doc:`/guides/index` - Browse the user guides
+ - :doc:`/index` - Return to main documentation
diff --git a/docs/api/utils.rst b/docs/api/utils.rst
new file mode 100644
index 0000000..5f9c71d
--- /dev/null
+++ b/docs/api/utils.rst
@@ -0,0 +1,10 @@
+Utilities
+=========
+
+Tool Message Formatting
+-----------------------
+
+.. automodule:: atomic_agents.lib.utils.format_tool_message
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..fb12da5
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,47 @@
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath(".."))
+
+project = "Atomic Agents"
+copyright = "2024, Kenny Vaneetvelde"
+author = "Kenny Vaneetvelde"
+version = "1.0.19"
+release = "1.0.19"
+
+extensions = [
+ "sphinx.ext.autodoc",
+ "sphinx.ext.napoleon",
+ "sphinx.ext.viewcode",
+ "sphinx.ext.intersphinx",
+ "myst_parser",
+ "sphinx_copybutton",
+ "sphinx_design",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
+
+# Intersphinx configuration
+intersphinx_mapping = {
+ "python": ("https://docs.python.org/3", None),
+ "pydantic": ("https://docs.pydantic.dev/latest/", None),
+}
+
+# MyST configuration
+myst_enable_extensions = [
+ "colon_fence",
+ "deflist",
+]
+
+# Autodoc configuration
+autodoc_default_options = {
+ "members": True,
+ "member-order": "bysource",
+ "special-members": "__init__",
+ "undoc-members": True,
+ "exclude-members": "__weakref__",
+}
diff --git a/docs/guides/advanced_usage.rst b/docs/guides/advanced_usage.rst
new file mode 100644
index 0000000..7a815d5
--- /dev/null
+++ b/docs/guides/advanced_usage.rst
@@ -0,0 +1,273 @@
+Advanced Usage
+=============
+
+This guide covers advanced features and patterns in Atomic Agents.
+
+Custom Schemas
+------------
+
+You can create custom input/output schemas for specialized agents:
+
+.. code-block:: python
+
+ from typing import List
+ from pydantic import Field
+ from atomic_agents.lib.base.base_io_schema import BaseIOSchema
+ from atomic_agents.agents.base_agent import BaseAgent, BaseAgentConfig
+
+ # Custom output schema
+ class CustomOutputSchema(BaseIOSchema):
+ """Schema for responses with suggested follow-up questions."""
+
+ chat_message: str = Field(
+ ...,
+ description="The chat message exchanged between the user and the chat agent.",
+ )
+ suggested_user_questions: List[str] = Field(
+ ...,
+ description="A list of suggested follow-up questions the user could ask the agent.",
+ )
+
+ # Initialize memory with custom schema
+ initial_message = CustomOutputSchema(
+ chat_message="Hello! How can I assist you today?",
+ suggested_user_questions=[
+ "What can you do?",
+ "Tell me a joke",
+ "Tell me about how you were made"
+ ]
+ )
+ memory.add_message("assistant", initial_message)
+
+ # Create agent with custom schema
+ agent = BaseAgent(
+ config=BaseAgentConfig(
+ client=client,
+ model="gpt-4o-mini",
+ memory=memory,
+ output_schema=CustomOutputSchema
+ )
+ )
+
+RAG Implementation
+----------------
+
+Here's how to implement a Retrieval-Augmented Generation (RAG) system with two specialized agents:
+
+.. code-block:: python
+
+ import instructor
+ import openai
+ from pydantic import Field
+ from atomic_agents.agents.base_agent import BaseIOSchema, BaseAgent, BaseAgentConfig
+ from atomic_agents.lib.components.system_prompt_generator import SystemPromptGenerator
+
+ # Query Agent for generating semantic search queries
+ class RAGQueryAgentInputSchema(BaseIOSchema):
+ """Input schema for the RAG query agent."""
+ user_message: str = Field(
+ ...,
+ description="The user's question or message to generate a semantic search query for"
+ )
+
+ class RAGQueryAgentOutputSchema(BaseIOSchema):
+ """Output schema for the RAG query agent."""
+ query: str = Field(
+ ...,
+ description="The semantic search query to use for retrieving relevant chunks"
+ )
+
+ query_agent = BaseAgent(
+ BaseAgentConfig(
+ client=client,
+ model="gpt-4o-mini",
+ system_prompt_generator=SystemPromptGenerator(
+ background=[
+ "You are an expert at formulating semantic search queries for RAG systems.",
+ "Your role is to convert user questions into effective semantic search queries that will retrieve the most relevant text chunks.",
+ ],
+ steps=[
+ "1. Analyze the user's question to identify key concepts and information needs",
+ "2. Reformulate the question into a semantic search query that will match relevant content",
+ "3. Ensure the query captures the core meaning while being general enough to match similar content",
+ ],
+ output_instructions=[
+ "Generate a clear, concise semantic search query",
+ "Focus on key concepts and entities from the user's question",
+ "Avoid overly specific details that might miss relevant matches",
+ "Include synonyms or related terms when appropriate",
+ "Explain your reasoning for the query formulation",
+ ],
+ ),
+ input_schema=RAGQueryAgentInputSchema,
+ output_schema=RAGQueryAgentOutputSchema,
+ )
+ )
+
+ # QA Agent for answering questions using retrieved context
+ class RAGQuestionAnsweringAgentInputSchema(BaseIOSchema):
+ """Input schema for the RAG QA agent."""
+ question: str = Field(
+ ...,
+ description="The user's question to answer"
+ )
+
+ class RAGQuestionAnsweringAgentOutputSchema(BaseIOSchema):
+ """Output schema for the RAG QA agent."""
+ answer: str = Field(
+ ...,
+ description="The answer to the user's question based on the retrieved context"
+ )
+
+ qa_agent = BaseAgent(
+ BaseAgentConfig(
+ client=client,
+ model="gpt-4o-mini",
+ system_prompt_generator=SystemPromptGenerator(
+ background=[
+ "You are an expert at answering questions using retrieved context chunks from a RAG system.",
+ "Your role is to synthesize information from the chunks to provide accurate, well-supported answers.",
+ "You must explain your reasoning process before providing the answer.",
+ ],
+ steps=[
+ "1. Analyze the question and available context chunks",
+ "2. Identify the most relevant information in the chunks",
+ "3. Explain how you'll use this information to answer the question",
+ "4. Synthesize information into a coherent answer",
+ ],
+ output_instructions=[
+ "First explain your reasoning process clearly",
+ "Then provide a clear, direct answer based on the context",
+ "If context is insufficient, state this in your reasoning",
+ "Never make up information not present in the chunks",
+ "Focus on being accurate and concise",
+ ],
+ ),
+ input_schema=RAGQuestionAnsweringAgentInputSchema,
+ output_schema=RAGQuestionAnsweringAgentOutputSchema,
+ )
+ )
+
+Streaming with Rich Display
+------------------------
+
+Handle streaming responses with rich formatting:
+
+.. code-block:: python
+
+ from rich.live import Live
+ from rich.text import Text
+ from typing import List
+
+ async def process_stream():
+ with Live("", refresh_per_second=10, auto_refresh=True) as live:
+ current_response = ""
+ current_questions: List[str] = []
+
+ async for partial_response in agent.run_async(input_schema):
+ if hasattr(partial_response, "chat_message") and partial_response.chat_message:
+ # Update message if changed
+ if partial_response.chat_message != current_response:
+ current_response = partial_response.chat_message
+
+ # Update questions if available
+ if hasattr(partial_response, "suggested_user_questions"):
+ current_questions = partial_response.suggested_user_questions
+
+ # Build display text
+ display_text = Text.assemble(
+ ("Agent: ", "bold green"),
+ (current_response, "green")
+ )
+
+ # Add questions if we have them
+ if current_questions:
+ display_text.append("\n\n")
+ display_text.append(
+ "Suggested questions you could ask:\n",
+ style="bold cyan"
+ )
+ for i, question in enumerate(current_questions, 1):
+ display_text.append(f"{i}. {question}\n", style="cyan")
+
+ live.update(display_text)
+
+ # Run with asyncio
+ import asyncio
+ asyncio.run(process_stream())
+
+Best Practices
+------------
+
+Error Handling
+^^^^^^^^^^^^
+
+.. code-block:: python
+
+ try:
+ response = agent.run(input_schema)
+ except openai.APIError as e:
+ console.print(f"[red]API Error:[/red] {e}")
+ # Handle API-specific errors
+ except Exception as e:
+ console.print(f"[red]Error:[/red] {e}")
+ # Handle other errors appropriately
+
+Memory Management
+^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+ # Initialize memory with context
+ memory = AgentMemory()
+
+ # Add system context
+ memory.add_message(
+ "system",
+ "Important context or instructions for the agent..."
+ )
+
+ # Add initial message
+ memory.add_message("assistant", initial_message)
+
+ # Clear memory if needed
+ memory.clear()
+
+Security
+^^^^^^^
+
+.. code-block:: python
+
+ # Use environment variables for sensitive data
+ API_KEY = os.getenv("OPENAI_API_KEY")
+ if not API_KEY:
+ raise ValueError(
+ "API key is not set. Please set the API key as a static variable "
+ "or in the environment variable OPENAI_API_KEY."
+ )
+
+Troubleshooting
+-------------
+
+Common issues and solutions:
+
+Schema Validation
+^^^^^^^^^^^^^^^
+
+- Ensure all required fields are provided in schemas
+- Use proper Pydantic Field descriptions
+- Check that schema types match expected values
+
+Memory Issues
+^^^^^^^^^^^
+
+- Clear memory when needed using ``memory.clear()``
+- Use streaming for large responses
+- Monitor memory usage in long conversations
+
+API Issues
+^^^^^^^^^
+
+- Handle rate limits with exponential backoff
+- Use proper async/await patterns
+- Verify API key and model availability
diff --git a/docs/guides/basic_concepts.rst b/docs/guides/basic_concepts.rst
new file mode 100644
index 0000000..8c630dc
--- /dev/null
+++ b/docs/guides/basic_concepts.rst
@@ -0,0 +1,190 @@
+Basic Concepts
+=============
+
+This guide introduces the core concepts of Atomic Agents.
+
+What is an Agent?
+---------------
+
+In Atomic Agents, an agent is an autonomous entity that can:
+
+- Process input using natural language
+- Make decisions based on its configuration and context
+- Execute actions through defined tools and capabilities
+- Maintain state and history of interactions
+
+Core Components
+-------------
+
+BaseAgent
+^^^^^^^^
+
+The ``BaseAgent`` class is the foundation of all agents in the framework. It provides:
+
+- Input/output schema handling
+- Memory management
+- System prompt generation
+- Streaming capabilities
+- Tool integration
+
+Components
+^^^^^^^^^
+
+Components are modular pieces that can be added to agents to extend their functionality:
+
+AgentMemory
+""""""""""
+
+Manages conversation history and state:
+
+.. code-block:: python
+
+ from atomic_agents.lib.components.agent_memory import AgentMemory
+ from atomic_agents.agents.base_agent import BaseAgentOutputSchema
+ from rich.console import Console
+
+ # Initialize console for pretty outputs
+ console = Console()
+
+ # Initialize memory
+ memory = AgentMemory()
+
+ # Initialize with a greeting
+ initial_message = BaseAgentOutputSchema(
+ chat_message="Hello! How can I assist you today?"
+ )
+ memory.add_message("assistant", initial_message)
+
+ # Add system context if needed
+ memory.add_message(
+ "system",
+ "This agent has access to specific tools and capabilities..."
+ )
+
+ # Access conversation history
+ for message in memory.get_messages():
+ console.print(f"{message.role}: {message.content}")
+
+SystemPromptGenerator
+"""""""""""""""""""
+
+Customizes agent behavior through prompts:
+
+.. code-block:: python
+
+ from atomic_agents.lib.components.system_prompt_generator import SystemPromptGenerator
+
+ generator = SystemPromptGenerator(
+ background=[
+ "This assistant is a knowledgeable AI designed to be helpful, friendly, and informative.",
+ "It specializes in providing clear explanations and step-by-step guidance.",
+ "It maintains a professional yet approachable tone.",
+ ],
+ steps=[
+ "1. Carefully analyze the user's input to understand their needs and context.",
+ "2. Consider any relevant background information or previous conversation context.",
+ "3. Formulate a clear, structured response that directly addresses the query.",
+ "4. Include examples or analogies when they would help clarify the explanation.",
+ ],
+ output_instructions=[
+ "Always provide clear, actionable information.",
+ "Use markdown formatting for code blocks and technical terms.",
+ "Break down complex concepts into digestible parts.",
+ "Maintain a helpful and encouraging tone.",
+ ]
+ )
+
+ # Use in agent configuration
+ agent = BaseAgent(
+ config=BaseAgentConfig(
+ client=client,
+ model="gpt-4o-mini",
+ memory=memory,
+ system_prompt_generator=generator
+ )
+ )
+
+Basic Usage Patterns
+------------------
+
+Creating an Agent
+^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+ import os
+ import instructor
+ import openai
+ from rich.console import Console
+ from rich.panel import Panel
+ from atomic_agents.agents.base_agent import BaseAgent, BaseAgentConfig
+
+ # Initialize console for pretty outputs
+ console = Console()
+
+ # API Key setup
+ API_KEY = os.getenv("OPENAI_API_KEY")
+ if not API_KEY:
+ raise ValueError(
+ "API key is not set. Please set the API key as a static variable "
+ "or in the environment variable OPENAI_API_KEY."
+ )
+
+ # OpenAI client setup
+ client = instructor.from_openai(openai.OpenAI(api_key=API_KEY))
+
+ # Create agent with custom configuration
+ agent = BaseAgent(
+ config=BaseAgentConfig(
+ client=client,
+ model="gpt-4o-mini",
+ memory=memory,
+ system_prompt_generator=generator
+ )
+ )
+
+ # Display the system prompt
+ default_system_prompt = agent.system_prompt_generator.generate_prompt()
+ console.print(Panel(default_system_prompt, width=console.width, style="bold cyan"))
+
+Running Commands
+^^^^^^^^^^^^^
+
+.. code-block:: python
+
+ from atomic_agents.agents.base_agent import BaseAgentInputSchema
+ from rich.text import Text
+ from rich.live import Live
+
+ # Simple command
+ input_schema = BaseAgentInputSchema(chat_message="What is the weather?")
+ response = agent.run(input_schema)
+ console.print(Text("Agent:", style="bold green"), end=" ")
+ console.print(Text(response.chat_message, style="green"))
+
+ # Streaming response
+ async def process_stream():
+ with Live("", refresh_per_second=10, auto_refresh=True) as live:
+ current_response = ""
+ async for partial_response in agent.run_async(input_schema):
+ if hasattr(partial_response, "chat_message") and partial_response.chat_message:
+ if partial_response.chat_message != current_response:
+ current_response = partial_response.chat_message
+ display_text = Text.assemble(
+ ("Agent: ", "bold green"),
+ (current_response, "green")
+ )
+ live.update(display_text)
+
+ # Run with asyncio
+ import asyncio
+ asyncio.run(process_stream())
+
+Next Steps
+---------
+
+After understanding these basic concepts, you can:
+
+1. Explore :doc:`advanced usage patterns <advanced_usage>`
+2. Check out the :doc:`API Reference </api/index>` for detailed documentation
+3. Try building your own custom agents
diff --git a/docs/guides/index.rst b/docs/guides/index.rst
new file mode 100644
index 0000000..00ae55c
--- /dev/null
+++ b/docs/guides/index.rst
@@ -0,0 +1,128 @@
+User Guide
+==========
+
+This section contains detailed guides for working with Atomic Agents.
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Guide Sections
+
+ basic_concepts
+ advanced_usage
+
+.. note::
+ Use the sidebar to navigate between different sections of the guides.
+ You can return to the main documentation using the navigation menu on the left.
+
+Implementation Patterns
+---------------------
+
+The framework supports various implementation patterns and use cases:
+
+Chatbots and Assistants
+^^^^^^^^^^^^^^^^^^^^^^
+
+- Basic chat interfaces with any LLM provider
+- Streaming responses
+- Custom response schemas
+- Suggested follow-up questions
+- Memory management and context retention
+- Multi-turn conversations
+
+RAG Systems
+^^^^^^^^^^
+
+- Query generation and optimization
+- Context-aware responses
+- Document Q&A with source tracking
+- Information synthesis and summarization
+- Custom embedding and retrieval strategies
+- Hybrid search approaches
+
+Specialized Agents
+^^^^^^^^^^^^^^^^
+
+- YouTube video summarization and analysis
+- Web search and deep research
+- Recipe generation from various sources
+- Multimodal interactions (text, images, etc.)
+- Custom tool integration
+- Task orchestration
+
+Provider Integration Guide
+------------------------
+
+Atomic Agents is designed to be provider-agnostic. Here's how to work with different providers:
+
+Provider Selection
+^^^^^^^^^^^^^^^
+
+- Choose any provider supported by Instructor
+- Configure provider-specific settings
+- Handle rate limits and quotas
+- Implement fallback strategies
+
+Local Development
+^^^^^^^^^^^^^^^
+
+- Use Ollama for local testing
+- Mock responses for development
+- Debug provider interactions
+- Test provider switching
+
+Production Deployment
+^^^^^^^^^^^^^^^^^^
+
+- Load balancing between providers
+- Failover configurations
+- Cost optimization strategies
+- Performance monitoring
+
+Custom Provider Integration
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+- Extend Instructor for new providers
+- Implement custom client wrappers
+- Add provider-specific features
+- Handle unique response formats
+
+Best Practices
+------------
+
+Error Handling
+^^^^^^^^^^^^
+
+- Implement proper exception handling
+- Add retry mechanisms
+- Log provider errors
+- Handle rate limits gracefully
+
+Performance Optimization
+^^^^^^^^^^^^^^^^^^^^^
+
+- Use streaming for long responses
+- Implement caching strategies
+- Optimize prompt lengths
+- Batch operations when possible
+
+Security
+^^^^^^^
+
+- Secure API key management
+- Input validation and sanitization
+- Output filtering
+- Rate limiting and quotas
+
+Getting Help
+-----------
+
+If you need help, you can:
+
+1. Check our `GitHub Issues <https://github.com/BrainBlend-AI/atomic-agents/issues>`_
+2. Join our `Reddit community <https://www.reddit.com/r/AtomicAgents/>`_
+3. Read through our examples in the repository
+4. Review the example projects in ``atomic-examples/``
+
+.. seealso::
+ - :doc:`/api/index` - Browse the API reference
+ - :doc:`/index` - Return to main documentation
diff --git a/docs/index.html b/docs/index.html
deleted file mode 100644
index de14e9d..0000000
--- a/docs/index.html
+++ /dev/null
@@ -1,67 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
-<meta name="generator" content="pdoc3 0.11.1">
-<title>atomic_agents API documentation</title>
-<meta name="description" content="">
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
-<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
-<script>window.addEventListener('DOMContentLoaded', () => {
-hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
-hljs.highlightAll();
-})</script>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Namespace <code>atomic_agents</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="atomic_agents.agents" href="agents/index.html">atomic_agents.agents</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt><code class="name"><a title="atomic_agents.lib" href="lib/index.html">atomic_agents.lib</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="atomic_agents.agents" href="agents/index.html">atomic_agents.agents</a></code></li>
-<li><code><a title="atomic_agents.lib" href="lib/index.html">atomic_agents.lib</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
-</footer>
-</body>
-</html>
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..282c83a
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,128 @@
+Welcome to Atomic Agents Documentation
+======================================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Documentation
+
+ self
+ User Guide <guides/index>
+ API Reference <api/index>
+
+A Lightweight and Modular Framework for Building AI Agents
+==========================================================
+
+.. image:: _static/logo.png
+ :width: 350
+ :alt: Atomic Agents
+
+The Atomic Agents framework is designed around the concept of atomicity to be an extremely lightweight and modular framework for building Agentic AI pipelines and applications without sacrificing developer experience and maintainability. The framework provides a set of tools and agents that can be combined to create powerful applications. It is built on top of `Instructor <https://github.com/jxnl/instructor>`_ and leverages the power of `Pydantic <https://docs.pydantic.dev/latest/>`_ for data and schema validation and serialization.
+
+All logic and control flows are written in Python, enabling developers to apply familiar best practices and workflows from traditional software development without compromising flexibility or clarity.
+
+Key Features
+------------
+
+- **Modularity**: Build AI applications by combining small, reusable components
+- **Predictability**: Define clear input and output schemas using Pydantic
+- **Extensibility**: Easily swap out components or integrate new ones
+- **Control**: Fine-tune each part of the system individually
+- **Provider Agnostic**: Works with various LLM providers through Instructor
+- **Built for Production**: Robust error handling and async support
+
+Installation
+------------
+
+You can install Atomic Agents using pip:
+
+.. code-block:: bash
+
+ pip install atomic-agents
+
+Or using Poetry (recommended):
+
+.. code-block:: bash
+
+ poetry add atomic-agents
+
+Make sure you also install the provider you want to use. For example, to use OpenAI and Groq:
+
+.. code-block:: bash
+
+ pip install openai groq
+
+This also installs the CLI *Atomic Assembler*, which can be used to download Tools (and soon also Agents and Pipelines).
+
+.. note::
+ The framework supports multiple providers through Instructor, including **OpenAI**, **Anthropic**, **Groq**, **Ollama** (local models), **Gemini**, and more!
+ For a full list of all supported providers and their setup instructions, have a look at the `Instructor Integrations documentation <https://python.useinstructor.com/integrations/>`_.
+
+Quick Example
+-------------
+
+Here's a glimpse of how easy it is to create an agent:
+
+.. code-block:: python
+
+ import instructor
+ import openai
+ from atomic_agents.lib.components.agent_memory import AgentMemory
+ from atomic_agents.agents.base_agent import BaseAgent, BaseAgentConfig, BaseAgentInputSchema
+
+
+ # Set up your API key (either in environment or pass directly)
+ # os.environ["OPENAI_API_KEY"] = "your-api-key"
+ # or pass it to the client: openai.OpenAI(api_key="your-api-key")
+
+ # Initialize agent with memory
+ memory = AgentMemory()
+
+ # Set up client with your preferred provider
+ client = instructor.from_openai(openai.OpenAI()) # Pass your API key here if not in environment
+
+ # Create an agent
+ agent = BaseAgent(
+ config=BaseAgentConfig(
+ client=client,
+ model="gpt-4o-mini", # Use your provider's model
+ memory=memory
+ )
+ )
+
+ # Interact with your agent (using the agent's input schema)
+ response = agent.run(agent.input_schema(chat_message="Tell me about quantum computing"))
+
+ # Or more explicitly:
+ response = agent.run(
+ BaseAgentInputSchema(chat_message="Tell me about quantum computing")
+ )
+
+ print(response)
+
+Example Projects
+---------------
+
+Check out our example projects in our `GitHub repository <https://github.com/BrainBlend-AI/atomic-agents/tree/main/atomic-examples>`_:
+
+- `Quickstart Examples <https://github.com/BrainBlend-AI/atomic-agents/tree/main/atomic-examples/quickstart>`_: Simple examples to get started
+- `Basic Multimodal <https://github.com/BrainBlend-AI/atomic-agents/tree/main/atomic-examples/basic-multimodal>`_: Analyze images with text
+- `RAG Chatbot <https://github.com/BrainBlend-AI/atomic-agents/tree/main/atomic-examples/rag-chatbot>`_: Build context-aware chatbots
+- `Web Search Agent <https://github.com/BrainBlend-AI/atomic-agents/tree/main/atomic-examples/web-search-agent>`_: Create agents that perform web searches
+- `Deep Research <https://github.com/BrainBlend-AI/atomic-agents/tree/main/atomic-examples/deep-research>`_: Perform deep research tasks
+- `YouTube Summarizer <https://github.com/BrainBlend-AI/atomic-agents/tree/main/atomic-examples/youtube-summarizer>`_: Extract knowledge from videos
+- `YouTube to Recipe <https://github.com/BrainBlend-AI/atomic-agents/tree/main/atomic-examples/youtube-to-recipe>`_: Convert cooking videos into structured recipes
+- `Orchestration Agent <https://github.com/BrainBlend-AI/atomic-agents/tree/main/atomic-examples/orchestration-agent>`_: Coordinate multiple agents for complex tasks
+
+Community & Support
+-------------------
+
+- `GitHub Repository <https://github.com/BrainBlend-AI/atomic-agents>`_
+- `Issue Tracker <https://github.com/BrainBlend-AI/atomic-agents/issues>`_
+- `Reddit Community <https://www.reddit.com/r/AtomicAgents/>`_
+
+Indices and References
+======================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/lib/base/base_io_schema.html b/docs/lib/base/base_io_schema.html
deleted file mode 100644
index 99a4fe9..0000000
--- a/docs/lib/base/base_io_schema.html
+++ /dev/null
@@ -1,155 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
-<meta name="generator" content="pdoc3 0.11.1">
-<title>atomic_agents.lib.base.base_io_schema API documentation</title>
-<meta name="description" content="">
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
-<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
-<script>window.addEventListener('DOMContentLoaded', () => {
-hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
-hljs.highlightAll();
-})</script>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>atomic_agents.lib.base.base_io_schema</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="atomic_agents.lib.base.base_io_schema.BaseIOSchema"><code class="flex name class">
-<span>class <span class="ident">BaseIOSchema</span></span>
-<span>(</span><span>**data: Any)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Base schema for input/output in the Atomic Agents framework.</p>
-<p>Create a new model by parsing and validating input data from keyword arguments.</p>
-<p>Raises [<code>ValidationError</code>][pydantic_core.ValidationError] if the input data cannot be
-validated to form a valid model.</p>
-<p><code>self</code> is explicitly positional-only to allow <code>self</code> as a field name.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class BaseIOSchema(BaseModel):
- &#34;&#34;&#34;Base schema for input/output in the Atomic Agents framework.&#34;&#34;&#34;
-
- def __str__(self):
- return self.model_dump_json()
-
- def __rich__(self):
- json_str = self.model_dump_json()
- return JSON(json_str)
-
- @classmethod
- def __pydantic_init_subclass__(cls, **kwargs):
- super().__pydantic_init_subclass__(**kwargs)
- cls._validate_description()
-
- @classmethod
- def _validate_description(cls):
- description = cls.__doc__
-
- if not description or not description.strip():
- if cls.__module__ != &#34;instructor.function_calls&#34; and not hasattr(cls, &#34;from_streaming_response&#34;):
- raise ValueError(f&#34;{cls.__name__} must have a non-empty docstring to serve as its description&#34;)
-
- @classmethod
- def model_json_schema(cls, *args, **kwargs):
- schema = super().model_json_schema(*args, **kwargs)
- if &#34;description&#34; not in schema and cls.__doc__:
- schema[&#34;description&#34;] = inspect.cleandoc(cls.__doc__)
- if &#34;title&#34; not in schema:
- schema[&#34;title&#34;] = cls.__name__
- return schema</code></pre>
-</details>
-<h3>Ancestors</h3>
-<ul class="hlist">
-<li>pydantic.main.BaseModel</li>
-</ul>
-<h3>Subclasses</h3>
-<ul class="hlist">
-<li><a title="atomic_agents.agents.base_agent.BaseAgentInputSchema" href="../../agents/base_agent.html#atomic_agents.agents.base_agent.BaseAgentInputSchema">BaseAgentInputSchema</a></li>
-<li><a title="atomic_agents.agents.base_agent.BaseAgentOutputSchema" href="../../agents/base_agent.html#atomic_agents.agents.base_agent.BaseAgentOutputSchema">BaseAgentOutputSchema</a></li>
-</ul>
-<h3>Class variables</h3>
-<dl>
-<dt id="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_config"><code class="name">var <span class="ident">model_config</span></code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-</dl>
-<h3>Static methods</h3>
-<dl>
-<dt id="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_json_schema"><code class="name flex">
-<span>def <span class="ident">model_json_schema</span></span>(<span>*args, **kwargs)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Generates a JSON schema for a model class.</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>by_alias</code></strong></dt>
-<dd>Whether to use attribute aliases or not.</dd>
-<dt><strong><code>ref_template</code></strong></dt>
-<dd>The reference template.</dd>
-<dt><strong><code>schema_generator</code></strong></dt>
-<dd>To override the logic used to generate the JSON schema, as a subclass of
-<code>GenerateJsonSchema</code> with your desired modifications</dd>
-<dt><strong><code>mode</code></strong></dt>
-<dd>The mode in which to generate the schema.</dd>
-</dl>
-<h2 id="returns">Returns</h2>
-<p>The JSON schema for the given model class.</p></div>
-</dd>
-</dl>
-</dd>
-</dl>
-</section>
-</article>
-<nav id="sidebar">
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="atomic_agents.lib.base" href="index.html">atomic_agents.lib.base</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a></code></h4>
-<ul class="">
-<li><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_config" href="#atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_config">model_config</a></code></li>
-<li><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_json_schema" href="#atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_json_schema">model_json_schema</a></code></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
-</footer>
-</body>
-</html>
diff --git a/docs/lib/base/base_tool.html b/docs/lib/base/base_tool.html
deleted file mode 100644
index dda2aed..0000000
--- a/docs/lib/base/base_tool.html
+++ /dev/null
@@ -1,233 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
-<meta name="generator" content="pdoc3 0.11.1">
-<title>atomic_agents.lib.base.base_tool API documentation</title>
-<meta name="description" content="">
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
-<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
-<script>window.addEventListener('DOMContentLoaded', () => {
-hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
-hljs.highlightAll();
-})</script>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>atomic_agents.lib.base.base_tool</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="atomic_agents.lib.base.base_tool.BaseTool"><code class="flex name class">
-<span>class <span class="ident">BaseTool</span></span>
-<span>(</span><span>config: <a title="atomic_agents.lib.base.base_tool.BaseToolConfig" href="#atomic_agents.lib.base.base_tool.BaseToolConfig">BaseToolConfig</a> = BaseToolConfig(title=None, description=None))</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Base class for tools within the Atomic Agents framework.</p>
-<h2 id="attributes">Attributes</h2>
-<dl>
-<dt><strong><code>input_schema</code></strong> :&ensp;<code>Type[BaseIOSchema]</code></dt>
-<dd>Schema defining the input data.</dd>
-<dt><strong><code>output_schema</code></strong> :&ensp;<code>Type[BaseIOSchema]</code></dt>
-<dd>Schema defining the output data.</dd>
-<dt><strong><code>tool_name</code></strong> :&ensp;<code>str</code></dt>
-<dd>The name of the tool, derived from the input schema's title.</dd>
-<dt><strong><code>tool_description</code></strong> :&ensp;<code>str</code></dt>
-<dd>Description of the tool, derived from the input schema's description or overridden by the user.</dd>
-</dl>
-<p>Initializes the BaseTool with an optional configuration override.</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>config</code></strong> :&ensp;<code><a title="atomic_agents.lib.base.base_tool.BaseToolConfig" href="#atomic_agents.lib.base.base_tool.BaseToolConfig">BaseToolConfig</a></code>, optional</dt>
-<dd>Configuration for the tool, including optional title and description overrides.</dd>
-</dl></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class BaseTool:
- &#34;&#34;&#34;
- Base class for tools within the Atomic Agents framework.
-
- Attributes:
- input_schema (Type[BaseIOSchema]): Schema defining the input data.
- output_schema (Type[BaseIOSchema]): Schema defining the output data.
- tool_name (str): The name of the tool, derived from the input schema&#39;s title.
- tool_description (str): Description of the tool, derived from the input schema&#39;s description or overridden by the user.
- &#34;&#34;&#34;
-
- input_schema: Type[BaseIOSchema]
- output_schema: Type[BaseIOSchema]
-
- def __init__(self, config: BaseToolConfig = BaseToolConfig()):
- &#34;&#34;&#34;
- Initializes the BaseTool with an optional configuration override.
-
- Args:
- config (BaseToolConfig, optional): Configuration for the tool, including optional title and description overrides.
- &#34;&#34;&#34;
- self.tool_name = config.title or self.input_schema.model_json_schema()[&#34;title&#34;]
- self.tool_description = config.description or self.input_schema.model_json_schema()[&#34;description&#34;]
-
- def run(self, params: Type[BaseIOSchema]) -&gt; BaseIOSchema:
- &#34;&#34;&#34;
- Executes the tool with the provided parameters.
-
- Args:
- params (BaseIOSchema): Input parameters adhering to the input schema.
-
- Returns:
- BaseIOSchema: Output resulting from executing the tool, adhering to the output schema.
-
- Raises:
- NotImplementedError: If the method is not implemented by a subclass.
- &#34;&#34;&#34;
- raise NotImplementedError(&#34;Subclasses should implement this method&#34;)</code></pre>
-</details>
-<h3>Class variables</h3>
-<dl>
-<dt id="atomic_agents.lib.base.base_tool.BaseTool.input_schema"><code class="name">var <span class="ident">input_schema</span> : Type[<a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a>]</code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-<dt id="atomic_agents.lib.base.base_tool.BaseTool.output_schema"><code class="name">var <span class="ident">output_schema</span> : Type[<a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a>]</code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-</dl>
-<h3>Methods</h3>
-<dl>
-<dt id="atomic_agents.lib.base.base_tool.BaseTool.run"><code class="name flex">
-<span>def <span class="ident">run</span></span>(<span>self, params: Type[<a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a>]) ‑> <a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a></span>
-</code></dt>
-<dd>
-<div class="desc"><p>Executes the tool with the provided parameters.</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>params</code></strong> :&ensp;<code>BaseIOSchema</code></dt>
-<dd>Input parameters adhering to the input schema.</dd>
-</dl>
-<h2 id="returns">Returns</h2>
-<dl>
-<dt><code>BaseIOSchema</code></dt>
-<dd>Output resulting from executing the tool, adhering to the output schema.</dd>
-</dl>
-<h2 id="raises">Raises</h2>
-<dl>
-<dt><code>NotImplementedError</code></dt>
-<dd>If the method is not implemented by a subclass.</dd>
-</dl></div>
-</dd>
-</dl>
-</dd>
-<dt id="atomic_agents.lib.base.base_tool.BaseToolConfig"><code class="flex name class">
-<span>class <span class="ident">BaseToolConfig</span></span>
-<span>(</span><span>**data: Any)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Configuration for a tool.</p>
-<h2 id="attributes">Attributes</h2>
-<dl>
-<dt><strong><code>title</code></strong> :&ensp;<code>Optional[str]</code></dt>
-<dd>Overrides the default title of the tool.</dd>
-<dt><strong><code>description</code></strong> :&ensp;<code>Optional[str]</code></dt>
-<dd>Overrides the default description of the tool.</dd>
-</dl>
-<p>Create a new model by parsing and validating input data from keyword arguments.</p>
-<p>Raises [<code>ValidationError</code>][pydantic_core.ValidationError] if the input data cannot be
-validated to form a valid model.</p>
-<p><code>self</code> is explicitly positional-only to allow <code>self</code> as a field name.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class BaseToolConfig(BaseModel):
- &#34;&#34;&#34;
- Configuration for a tool.
-
- Attributes:
- title (Optional[str]): Overrides the default title of the tool.
- description (Optional[str]): Overrides the default description of the tool.
- &#34;&#34;&#34;
-
- title: Optional[str] = None
- description: Optional[str] = None</code></pre>
-</details>
-<h3>Ancestors</h3>
-<ul class="hlist">
-<li>pydantic.main.BaseModel</li>
-</ul>
-<h3>Class variables</h3>
-<dl>
-<dt id="atomic_agents.lib.base.base_tool.BaseToolConfig.description"><code class="name">var <span class="ident">description</span> : Optional[str]</code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-<dt id="atomic_agents.lib.base.base_tool.BaseToolConfig.model_config"><code class="name">var <span class="ident">model_config</span></code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-<dt id="atomic_agents.lib.base.base_tool.BaseToolConfig.title"><code class="name">var <span class="ident">title</span> : Optional[str]</code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-</dl>
-</dd>
-</dl>
-</section>
-</article>
-<nav id="sidebar">
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="atomic_agents.lib.base" href="index.html">atomic_agents.lib.base</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="atomic_agents.lib.base.base_tool.BaseTool" href="#atomic_agents.lib.base.base_tool.BaseTool">BaseTool</a></code></h4>
-<ul class="">
-<li><code><a title="atomic_agents.lib.base.base_tool.BaseTool.input_schema" href="#atomic_agents.lib.base.base_tool.BaseTool.input_schema">input_schema</a></code></li>
-<li><code><a title="atomic_agents.lib.base.base_tool.BaseTool.output_schema" href="#atomic_agents.lib.base.base_tool.BaseTool.output_schema">output_schema</a></code></li>
-<li><code><a title="atomic_agents.lib.base.base_tool.BaseTool.run" href="#atomic_agents.lib.base.base_tool.BaseTool.run">run</a></code></li>
-</ul>
-</li>
-<li>
-<h4><code><a title="atomic_agents.lib.base.base_tool.BaseToolConfig" href="#atomic_agents.lib.base.base_tool.BaseToolConfig">BaseToolConfig</a></code></h4>
-<ul class="">
-<li><code><a title="atomic_agents.lib.base.base_tool.BaseToolConfig.description" href="#atomic_agents.lib.base.base_tool.BaseToolConfig.description">description</a></code></li>
-<li><code><a title="atomic_agents.lib.base.base_tool.BaseToolConfig.model_config" href="#atomic_agents.lib.base.base_tool.BaseToolConfig.model_config">model_config</a></code></li>
-<li><code><a title="atomic_agents.lib.base.base_tool.BaseToolConfig.title" href="#atomic_agents.lib.base.base_tool.BaseToolConfig.title">title</a></code></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
-</footer>
-</body>
-</html>
diff --git a/docs/lib/base/index.html b/docs/lib/base/index.html
deleted file mode 100644
index 139f5b8..0000000
--- a/docs/lib/base/index.html
+++ /dev/null
@@ -1,72 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
-<meta name="generator" content="pdoc3 0.11.1">
-<title>atomic_agents.lib.base API documentation</title>
-<meta name="description" content="">
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
-<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
-<script>window.addEventListener('DOMContentLoaded', () => {
-hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
-hljs.highlightAll();
-})</script>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Namespace <code>atomic_agents.lib.base</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="atomic_agents.lib.base.base_io_schema" href="base_io_schema.html">atomic_agents.lib.base.base_io_schema</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt><code class="name"><a title="atomic_agents.lib.base.base_tool" href="base_tool.html">atomic_agents.lib.base.base_tool</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="atomic_agents.lib" href="../index.html">atomic_agents.lib</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="atomic_agents.lib.base.base_io_schema" href="base_io_schema.html">atomic_agents.lib.base.base_io_schema</a></code></li>
-<li><code><a title="atomic_agents.lib.base.base_tool" href="base_tool.html">atomic_agents.lib.base.base_tool</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
-</footer>
-</body>
-</html>
diff --git a/docs/lib/components/agent_memory.html b/docs/lib/components/agent_memory.html
deleted file mode 100644
index 1199cc3..0000000
--- a/docs/lib/components/agent_memory.html
+++ /dev/null
@@ -1,484 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
-<meta name="generator" content="pdoc3 0.11.1">
-<title>atomic_agents.lib.components.agent_memory API documentation</title>
-<meta name="description" content="">
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
-<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
-<script>window.addEventListener('DOMContentLoaded', () => {
-hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
-hljs.highlightAll();
-})</script>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>atomic_agents.lib.components.agent_memory</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="atomic_agents.lib.components.agent_memory.AgentMemory"><code class="flex name class">
-<span>class <span class="ident">AgentMemory</span></span>
-<span>(</span><span>max_messages: Optional[int] = None)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Manages the chat history for an AI agent.</p>
-<h2 id="attributes">Attributes</h2>
-<dl>
-<dt><strong><code>history</code></strong> :&ensp;<code>List[<a title="atomic_agents.lib.components.agent_memory.Message" href="#atomic_agents.lib.components.agent_memory.Message">Message</a>]</code></dt>
-<dd>A list of messages representing the chat history.</dd>
-<dt><strong><code>max_messages</code></strong> :&ensp;<code>Optional[int]</code></dt>
-<dd>Maximum number of messages to keep in history.</dd>
-<dt><strong><code>current_turn_id</code></strong> :&ensp;<code>Optional[str]</code></dt>
-<dd>The ID of the current turn.</dd>
-</dl>
-<p>Initializes the AgentMemory with an empty history and optional constraints.</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>max_messages</code></strong> :&ensp;<code>Optional[int]</code></dt>
-<dd>Maximum number of messages to keep in history.
-When exceeded, oldest messages are removed first.</dd>
-</dl></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class AgentMemory:
- &#34;&#34;&#34;
- Manages the chat history for an AI agent.
-
- Attributes:
- history (List[Message]): A list of messages representing the chat history.
- max_messages (Optional[int]): Maximum number of messages to keep in history.
- current_turn_id (Optional[str]): The ID of the current turn.
- &#34;&#34;&#34;
-
- def __init__(self, max_messages: Optional[int] = None):
- &#34;&#34;&#34;
- Initializes the AgentMemory with an empty history and optional constraints.
-
- Args:
- max_messages (Optional[int]): Maximum number of messages to keep in history.
- When exceeded, oldest messages are removed first.
- &#34;&#34;&#34;
- self.history: List[Message] = []
- self.max_messages = max_messages
- self.current_turn_id: Optional[str] = None
-
- def initialize_turn(self) -&gt; None:
- &#34;&#34;&#34;
- Initializes a new turn by generating a random turn ID.
- &#34;&#34;&#34;
- self.current_turn_id = str(uuid.uuid4())
-
- def add_message(
- self,
- role: str,
- content: BaseIOSchema,
- ) -&gt; None:
- &#34;&#34;&#34;
- Adds a message to the chat history and manages overflow.
-
- Args:
- role (str): The role of the message sender.
- content (BaseIOSchema): The content of the message.
- &#34;&#34;&#34;
- if self.current_turn_id is None:
- self.initialize_turn()
-
- message = Message(role=role, content=content, turn_id=self.current_turn_id)
- self.history.append(message)
- self._manage_overflow()
-
- def _manage_overflow(self) -&gt; None:
- &#34;&#34;&#34;
- Manages the chat history overflow based on max_messages constraint.
- &#34;&#34;&#34;
- if self.max_messages is not None:
- while len(self.history) &gt; self.max_messages:
- self.history.pop(0)
-
- def get_history(self) -&gt; List[Dict]:
- &#34;&#34;&#34;
- Retrieves the chat history, filtering out unnecessary fields and serializing content.
-
- Returns:
- List[Dict]: The list of messages in the chat history as dictionaries.
- &#34;&#34;&#34;
- return [
- {
- &#34;role&#34;: message.role,
- &#34;content&#34;: json.dumps(message.content.model_dump()),
- }
- for message in self.history
- ]
-
- def copy(self) -&gt; &#34;AgentMemory&#34;:
- &#34;&#34;&#34;
- Creates a copy of the chat memory.
-
- Returns:
- AgentMemory: A copy of the chat memory.
- &#34;&#34;&#34;
- new_memory = AgentMemory(max_messages=self.max_messages)
- new_memory.load(self.dump())
- new_memory.current_turn_id = self.current_turn_id
- return new_memory
-
- def get_current_turn_id(self) -&gt; Optional[str]:
- &#34;&#34;&#34;
- Returns the current turn ID.
-
- Returns:
- Optional[str]: The current turn ID, or None if not set.
- &#34;&#34;&#34;
- return self.current_turn_id
-
- def delete_turn_id(self, turn_id: int):
- &#34;&#34;&#34;
- Delete messages from the memory by its turn ID.
-
- Args:
- turn_id (int): The turn ID of the message to delete.
-
- Returns:
- str: A success message with the deleted turn ID.
-
- Raises:
- ValueError: If the specified turn ID is not found in the memory.
- &#34;&#34;&#34;
- initial_length = len(self.history)
- self.history = [msg for msg in self.history if msg.turn_id != turn_id]
-
- if len(self.history) == initial_length:
- raise ValueError(f&#34;Turn ID {turn_id} not found in memory.&#34;)
-
- # Update current_turn_id if necessary
- if not len(self.history):
- self.current_turn_id = None
- elif turn_id == self.current_turn_id:
- # Always update to the last message&#39;s turn_id
- self.current_turn_id = self.history[-1].turn_id
-
- def get_message_count(self) -&gt; int:
- &#34;&#34;&#34;
- Returns the number of messages in the chat history.
-
- Returns:
- int: The number of messages.
- &#34;&#34;&#34;
- return len(self.history)
-
- def dump(self) -&gt; str:
- &#34;&#34;&#34;
- Serializes the entire AgentMemory instance to a JSON string.
-
- Returns:
- str: A JSON string representation of the AgentMemory.
- &#34;&#34;&#34;
- serialized_history = []
- for message in self.history:
- content_class = message.content.__class__
- serialized_message = {
- &#34;role&#34;: message.role,
- &#34;content&#34;: {
- &#34;class_name&#34;: f&#34;{content_class.__module__}.{content_class.__name__}&#34;,
- &#34;data&#34;: message.content.model_dump(),
- },
- &#34;turn_id&#34;: message.turn_id,
- }
- serialized_history.append(serialized_message)
-
- memory_data = {
- &#34;history&#34;: serialized_history,
- &#34;max_messages&#34;: self.max_messages,
- &#34;current_turn_id&#34;: self.current_turn_id,
- }
- return json.dumps(memory_data)
-
- def load(self, serialized_data: str) -&gt; None:
- &#34;&#34;&#34;
- Deserializes a JSON string and loads it into the AgentMemory instance.
-
- Args:
- serialized_data (str): A JSON string representation of the AgentMemory.
-
- Raises:
- ValueError: If the serialized data is invalid or cannot be deserialized.
- &#34;&#34;&#34;
- try:
- memory_data = json.loads(serialized_data)
- self.history = []
- self.max_messages = memory_data[&#34;max_messages&#34;]
- self.current_turn_id = memory_data[&#34;current_turn_id&#34;]
-
- for message_data in memory_data[&#34;history&#34;]:
- content_info = message_data[&#34;content&#34;]
- content_class = self._get_class_from_string(content_info[&#34;class_name&#34;])
- content_instance = content_class(**content_info[&#34;data&#34;])
-
- message = Message(role=message_data[&#34;role&#34;], content=content_instance, turn_id=message_data[&#34;turn_id&#34;])
- self.history.append(message)
- except (json.JSONDecodeError, KeyError, AttributeError, TypeError) as e:
- raise ValueError(f&#34;Invalid serialized data: {e}&#34;)
-
- @staticmethod
- def _get_class_from_string(class_string: str) -&gt; Type[BaseIOSchema]:
- &#34;&#34;&#34;
- Retrieves a class object from its string representation.
-
- Args:
- class_string (str): The fully qualified class name.
-
- Returns:
- Type[BaseIOSchema]: The class object.
-
- Raises:
- AttributeError: If the class cannot be found.
- &#34;&#34;&#34;
- module_name, class_name = class_string.rsplit(&#34;.&#34;, 1)
- module = __import__(module_name, fromlist=[class_name])
- return getattr(module, class_name)</code></pre>
-</details>
-<h3>Methods</h3>
-<dl>
-<dt id="atomic_agents.lib.components.agent_memory.AgentMemory.add_message"><code class="name flex">
-<span>def <span class="ident">add_message</span></span>(<span>self, role: str, content: <a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="../base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a>) ‑> None</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Adds a message to the chat history and manages overflow.</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>role</code></strong> :&ensp;<code>str</code></dt>
-<dd>The role of the message sender.</dd>
-<dt><strong><code>content</code></strong> :&ensp;<code>BaseIOSchema</code></dt>
-<dd>The content of the message.</dd>
-</dl></div>
-</dd>
-<dt id="atomic_agents.lib.components.agent_memory.AgentMemory.copy"><code class="name flex">
-<span>def <span class="ident">copy</span></span>(<span>self) ‑> <a title="atomic_agents.lib.components.agent_memory.AgentMemory" href="#atomic_agents.lib.components.agent_memory.AgentMemory">AgentMemory</a></span>
-</code></dt>
-<dd>
-<div class="desc"><p>Creates a copy of the chat memory.</p>
-<h2 id="returns">Returns</h2>
-<dl>
-<dt><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory" href="#atomic_agents.lib.components.agent_memory.AgentMemory">AgentMemory</a></code></dt>
-<dd>A copy of the chat memory.</dd>
-</dl></div>
-</dd>
-<dt id="atomic_agents.lib.components.agent_memory.AgentMemory.delete_turn_id"><code class="name flex">
-<span>def <span class="ident">delete_turn_id</span></span>(<span>self, turn_id: int)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Delete messages from the memory by its turn ID.</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>turn_id</code></strong> :&ensp;<code>int</code></dt>
-<dd>The turn ID of the message to delete.</dd>
-</dl>
-<h2 id="returns">Returns</h2>
-<dl>
-<dt><code>str</code></dt>
-<dd>A success message with the deleted turn ID.</dd>
-</dl>
-<h2 id="raises">Raises</h2>
-<dl>
-<dt><code>ValueError</code></dt>
-<dd>If the specified turn ID is not found in the memory.</dd>
-</dl></div>
-</dd>
-<dt id="atomic_agents.lib.components.agent_memory.AgentMemory.dump"><code class="name flex">
-<span>def <span class="ident">dump</span></span>(<span>self) ‑> str</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Serializes the entire AgentMemory instance to a JSON string.</p>
-<h2 id="returns">Returns</h2>
-<dl>
-<dt><code>str</code></dt>
-<dd>A JSON string representation of the AgentMemory.</dd>
-</dl></div>
-</dd>
-<dt id="atomic_agents.lib.components.agent_memory.AgentMemory.get_current_turn_id"><code class="name flex">
-<span>def <span class="ident">get_current_turn_id</span></span>(<span>self) ‑> Optional[str]</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Returns the current turn ID.</p>
-<h2 id="returns">Returns</h2>
-<dl>
-<dt><code>Optional[str]</code></dt>
-<dd>The current turn ID, or None if not set.</dd>
-</dl></div>
-</dd>
-<dt id="atomic_agents.lib.components.agent_memory.AgentMemory.get_history"><code class="name flex">
-<span>def <span class="ident">get_history</span></span>(<span>self) ‑> List[Dict]</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Retrieves the chat history, filtering out unnecessary fields and serializing content.</p>
-<h2 id="returns">Returns</h2>
-<dl>
-<dt><code>List[Dict]</code></dt>
-<dd>The list of messages in the chat history as dictionaries.</dd>
-</dl></div>
-</dd>
-<dt id="atomic_agents.lib.components.agent_memory.AgentMemory.get_message_count"><code class="name flex">
-<span>def <span class="ident">get_message_count</span></span>(<span>self) ‑> int</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Returns the number of messages in the chat history.</p>
-<h2 id="returns">Returns</h2>
-<dl>
-<dt><code>int</code></dt>
-<dd>The number of messages.</dd>
-</dl></div>
-</dd>
-<dt id="atomic_agents.lib.components.agent_memory.AgentMemory.initialize_turn"><code class="name flex">
-<span>def <span class="ident">initialize_turn</span></span>(<span>self) ‑> None</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Initializes a new turn by generating a random turn ID.</p></div>
-</dd>
-<dt id="atomic_agents.lib.components.agent_memory.AgentMemory.load"><code class="name flex">
-<span>def <span class="ident">load</span></span>(<span>self, serialized_data: str) ‑> None</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Deserializes a JSON string and loads it into the AgentMemory instance.</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>serialized_data</code></strong> :&ensp;<code>str</code></dt>
-<dd>A JSON string representation of the AgentMemory.</dd>
-</dl>
-<h2 id="raises">Raises</h2>
-<dl>
-<dt><code>ValueError</code></dt>
-<dd>If the serialized data is invalid or cannot be deserialized.</dd>
-</dl></div>
-</dd>
-</dl>
-</dd>
-<dt id="atomic_agents.lib.components.agent_memory.Message"><code class="flex name class">
-<span>class <span class="ident">Message</span></span>
-<span>(</span><span>**data: Any)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Represents a message in the chat history.</p>
-<h2 id="attributes">Attributes</h2>
-<dl>
-<dt><strong><code>role</code></strong> :&ensp;<code>str</code></dt>
-<dd>The role of the message sender (e.g., 'user', 'system', 'tool').</dd>
-<dt><strong><code>content</code></strong> :&ensp;<code>BaseIOSchema</code></dt>
-<dd>The content of the message.</dd>
-<dt><strong><code>turn_id</code></strong> :&ensp;<code>Optional[str]</code></dt>
-<dd>Unique identifier for the turn this message belongs to.</dd>
-</dl>
-<p>Create a new model by parsing and validating input data from keyword arguments.</p>
-<p>Raises [<code>ValidationError</code>][pydantic_core.ValidationError] if the input data cannot be
-validated to form a valid model.</p>
-<p><code>self</code> is explicitly positional-only to allow <code>self</code> as a field name.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class Message(BaseModel):
- &#34;&#34;&#34;
- Represents a message in the chat history.
-
- Attributes:
- role (str): The role of the message sender (e.g., &#39;user&#39;, &#39;system&#39;, &#39;tool&#39;).
- content (BaseIOSchema): The content of the message.
- turn_id (Optional[str]): Unique identifier for the turn this message belongs to.
- &#34;&#34;&#34;
-
- role: str
- content: BaseIOSchema
- turn_id: Optional[str] = None</code></pre>
-</details>
-<h3>Ancestors</h3>
-<ul class="hlist">
-<li>pydantic.main.BaseModel</li>
-</ul>
-<h3>Class variables</h3>
-<dl>
-<dt id="atomic_agents.lib.components.agent_memory.Message.content"><code class="name">var <span class="ident">content</span> : <a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="../base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a></code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-<dt id="atomic_agents.lib.components.agent_memory.Message.model_config"><code class="name">var <span class="ident">model_config</span></code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-<dt id="atomic_agents.lib.components.agent_memory.Message.role"><code class="name">var <span class="ident">role</span> : str</code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-<dt id="atomic_agents.lib.components.agent_memory.Message.turn_id"><code class="name">var <span class="ident">turn_id</span> : Optional[str]</code></dt>
-<dd>
-<div class="desc"><p>The type of the None singleton.</p></div>
-</dd>
-</dl>
-</dd>
-</dl>
-</section>
-</article>
-<nav id="sidebar">
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="atomic_agents.lib.components" href="index.html">atomic_agents.lib.components</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory" href="#atomic_agents.lib.components.agent_memory.AgentMemory">AgentMemory</a></code></h4>
-<ul class="two-column">
-<li><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory.add_message" href="#atomic_agents.lib.components.agent_memory.AgentMemory.add_message">add_message</a></code></li>
-<li><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory.copy" href="#atomic_agents.lib.components.agent_memory.AgentMemory.copy">copy</a></code></li>
-<li><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory.delete_turn_id" href="#atomic_agents.lib.components.agent_memory.AgentMemory.delete_turn_id">delete_turn_id</a></code></li>
-<li><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory.dump" href="#atomic_agents.lib.components.agent_memory.AgentMemory.dump">dump</a></code></li>
-<li><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory.get_current_turn_id" href="#atomic_agents.lib.components.agent_memory.AgentMemory.get_current_turn_id">get_current_turn_id</a></code></li>
-<li><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory.get_history" href="#atomic_agents.lib.components.agent_memory.AgentMemory.get_history">get_history</a></code></li>
-<li><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory.get_message_count" href="#atomic_agents.lib.components.agent_memory.AgentMemory.get_message_count">get_message_count</a></code></li>
-<li><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory.initialize_turn" href="#atomic_agents.lib.components.agent_memory.AgentMemory.initialize_turn">initialize_turn</a></code></li>
-<li><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory.load" href="#atomic_agents.lib.components.agent_memory.AgentMemory.load">load</a></code></li>
-</ul>
-</li>
-<li>
-<h4><code><a title="atomic_agents.lib.components.agent_memory.Message" href="#atomic_agents.lib.components.agent_memory.Message">Message</a></code></h4>
-<ul class="">
-<li><code><a title="atomic_agents.lib.components.agent_memory.Message.content" href="#atomic_agents.lib.components.agent_memory.Message.content">content</a></code></li>
-<li><code><a title="atomic_agents.lib.components.agent_memory.Message.model_config" href="#atomic_agents.lib.components.agent_memory.Message.model_config">model_config</a></code></li>
-<li><code><a title="atomic_agents.lib.components.agent_memory.Message.role" href="#atomic_agents.lib.components.agent_memory.Message.role">role</a></code></li>
-<li><code><a title="atomic_agents.lib.components.agent_memory.Message.turn_id" href="#atomic_agents.lib.components.agent_memory.Message.turn_id">turn_id</a></code></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
-</footer>
-</body>
-</html>
diff --git a/docs/lib/components/index.html b/docs/lib/components/index.html
deleted file mode 100644
index b945039..0000000
--- a/docs/lib/components/index.html
+++ /dev/null
@@ -1,72 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
-<meta name="generator" content="pdoc3 0.11.1">
-<title>atomic_agents.lib.components API documentation</title>
-<meta name="description" content="">
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
-<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
-<script>window.addEventListener('DOMContentLoaded', () => {
-hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
-hljs.highlightAll();
-})</script>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>atomic_agents.lib.components</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="atomic_agents.lib.components.agent_memory" href="agent_memory.html">atomic_agents.lib.components.agent_memory</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt><code class="name"><a title="atomic_agents.lib.components.system_prompt_generator" href="system_prompt_generator.html">atomic_agents.lib.components.system_prompt_generator</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="atomic_agents.lib" href="../index.html">atomic_agents.lib</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="atomic_agents.lib.components.agent_memory" href="agent_memory.html">atomic_agents.lib.components.agent_memory</a></code></li>
-<li><code><a title="atomic_agents.lib.components.system_prompt_generator" href="system_prompt_generator.html">atomic_agents.lib.components.system_prompt_generator</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
-</footer>
-</body>
-</html>
diff --git a/docs/lib/components/system_prompt_generator.html b/docs/lib/components/system_prompt_generator.html
deleted file mode 100644
index e97f1af..0000000
--- a/docs/lib/components/system_prompt_generator.html
+++ /dev/null
@@ -1,176 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
-<meta name="generator" content="pdoc3 0.11.1">
-<title>atomic_agents.lib.components.system_prompt_generator API documentation</title>
-<meta name="description" content="">
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
-<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
-<script>window.addEventListener('DOMContentLoaded', () => {
-hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
-hljs.highlightAll();
-})</script>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>atomic_agents.lib.components.system_prompt_generator</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase"><code class="flex name class">
-<span>class <span class="ident">SystemPromptContextProviderBase</span></span>
-<span>(</span><span>title: str)</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Helper class that provides a standard way to create an ABC using
-inheritance.</p></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class SystemPromptContextProviderBase(ABC):
- def __init__(self, title: str):
- self.title = title
-
- @abstractmethod
- def get_info(self) -&gt; str:
- pass
-
- def __repr__(self) -&gt; str:
- return self.get_info()</code></pre>
-</details>
-<h3>Ancestors</h3>
-<ul class="hlist">
-<li>abc.ABC</li>
-</ul>
-<h3>Methods</h3>
-<dl>
-<dt id="atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase.get_info"><code class="name flex">
-<span>def <span class="ident">get_info</span></span>(<span>self) ‑> str</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-</dl>
-</dd>
-<dt id="atomic_agents.lib.components.system_prompt_generator.SystemPromptGenerator"><code class="flex name class">
-<span>class <span class="ident">SystemPromptGenerator</span></span>
-<span>(</span><span>background: Optional[List[str]] = None, steps: Optional[List[str]] = None, output_instructions: Optional[List[str]] = None, context_providers: Optional[Dict[str, <a title="atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase" href="#atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase">SystemPromptContextProviderBase</a>]] = None)</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class SystemPromptGenerator:
- 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,
- ):
- self.background = background or [&#34;This is a conversation with a helpful and friendly AI assistant.&#34;]
- self.steps = steps or []
- self.output_instructions = output_instructions or []
- self.context_providers = context_providers or {}
-
- self.output_instructions.extend(
- [
- &#34;Always respond using the proper JSON schema.&#34;,
- &#34;Always use the available additional information and context to enhance the response.&#34;,
- ]
- )
-
- def generate_prompt(self) -&gt; str:
- sections = [
- (&#34;IDENTITY and PURPOSE&#34;, self.background),
- (&#34;INTERNAL ASSISTANT STEPS&#34;, self.steps),
- (&#34;OUTPUT INSTRUCTIONS&#34;, self.output_instructions),
- ]
-
- prompt_parts = []
-
- for title, content in sections:
- if content:
- prompt_parts.append(f&#34;# {title}&#34;)
- prompt_parts.extend(f&#34;- {item}&#34; for item in content)
- prompt_parts.append(&#34;&#34;)
-
- if self.context_providers:
- prompt_parts.append(&#34;# EXTRA INFORMATION AND CONTEXT&#34;)
- for provider in self.context_providers.values():
- info = provider.get_info()
- if info:
- prompt_parts.append(f&#34;## {provider.title}&#34;)
- prompt_parts.append(info)
- prompt_parts.append(&#34;&#34;)
-
- return &#34;\n&#34;.join(prompt_parts).strip()</code></pre>
-</details>
-<h3>Methods</h3>
-<dl>
-<dt id="atomic_agents.lib.components.system_prompt_generator.SystemPromptGenerator.generate_prompt"><code class="name flex">
-<span>def <span class="ident">generate_prompt</span></span>(<span>self) ‑> str</span>
-</code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-</dl>
-</dd>
-</dl>
-</section>
-</article>
-<nav id="sidebar">
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="atomic_agents.lib.components" href="index.html">atomic_agents.lib.components</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase" href="#atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase">SystemPromptContextProviderBase</a></code></h4>
-<ul class="">
-<li><code><a title="atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase.get_info" href="#atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase.get_info">get_info</a></code></li>
-</ul>
-</li>
-<li>
-<h4><code><a title="atomic_agents.lib.components.system_prompt_generator.SystemPromptGenerator" href="#atomic_agents.lib.components.system_prompt_generator.SystemPromptGenerator">SystemPromptGenerator</a></code></h4>
-<ul class="">
-<li><code><a title="atomic_agents.lib.components.system_prompt_generator.SystemPromptGenerator.generate_prompt" href="#atomic_agents.lib.components.system_prompt_generator.SystemPromptGenerator.generate_prompt">generate_prompt</a></code></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
-</footer>
-</body>
-</html>
diff --git a/docs/lib/index.html b/docs/lib/index.html
deleted file mode 100644
index 37b7212..0000000
--- a/docs/lib/index.html
+++ /dev/null
@@ -1,77 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
-<meta name="generator" content="pdoc3 0.11.1">
-<title>atomic_agents.lib API documentation</title>
-<meta name="description" content="">
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
-<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
-<script>window.addEventListener('DOMContentLoaded', () => {
-hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
-hljs.highlightAll();
-})</script>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>atomic_agents.lib</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="atomic_agents.lib.base" href="base/index.html">atomic_agents.lib.base</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt><code class="name"><a title="atomic_agents.lib.components" href="components/index.html">atomic_agents.lib.components</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-<dt><code class="name"><a title="atomic_agents.lib.utils" href="utils/index.html">atomic_agents.lib.utils</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="atomic_agents" href="../index.html">atomic_agents</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="atomic_agents.lib.base" href="base/index.html">atomic_agents.lib.base</a></code></li>
-<li><code><a title="atomic_agents.lib.components" href="components/index.html">atomic_agents.lib.components</a></code></li>
-<li><code><a title="atomic_agents.lib.utils" href="utils/index.html">atomic_agents.lib.utils</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
-</footer>
-</body>
-</html>
diff --git a/docs/lib/utils/format_tool_message.html b/docs/lib/utils/format_tool_message.html
deleted file mode 100644
index e2b9c6e..0000000
--- a/docs/lib/utils/format_tool_message.html
+++ /dev/null
@@ -1,81 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
-<meta name="generator" content="pdoc3 0.11.1">
-<title>atomic_agents.lib.utils.format_tool_message API documentation</title>
-<meta name="description" content="">
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
-<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
-<script>window.addEventListener('DOMContentLoaded', () => {
-hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
-hljs.highlightAll();
-})</script>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>atomic_agents.lib.utils.format_tool_message</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="atomic_agents.lib.utils.format_tool_message.format_tool_message"><code class="name flex">
-<span>def <span class="ident">format_tool_message</span></span>(<span>tool_call: Type[pydantic.main.BaseModel], tool_id: Optional[str] = None) ‑> Dict</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Formats a message for a tool call.</p>
-<h2 id="args">Args</h2>
-<dl>
-<dt><strong><code>tool_call</code></strong> :&ensp;<code>Type[BaseModel]</code></dt>
-<dd>The Pydantic model instance representing the tool call.</dd>
-<dt><strong><code>tool_id</code></strong> :&ensp;<code>str</code>, optional</dt>
-<dd>The unique identifier for the tool call. If not provided, a random UUID will be generated.</dd>
-</dl>
-<h2 id="returns">Returns</h2>
-<dl>
-<dt><code>Dict</code></dt>
-<dd>A formatted message dictionary for the tool call.</dd>
-</dl></div>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="atomic_agents.lib.utils" href="index.html">atomic_agents.lib.utils</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="atomic_agents.lib.utils.format_tool_message.format_tool_message" href="#atomic_agents.lib.utils.format_tool_message.format_tool_message">format_tool_message</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
-</footer>
-</body>
-</html>
diff --git a/docs/lib/utils/index.html b/docs/lib/utils/index.html
deleted file mode 100644
index 15c451e..0000000
--- a/docs/lib/utils/index.html
+++ /dev/null
@@ -1,67 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
-<meta name="generator" content="pdoc3 0.11.1">
-<title>atomic_agents.lib.utils API documentation</title>
-<meta name="description" content="">
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
-<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
-<script>window.addEventListener('DOMContentLoaded', () => {
-hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
-hljs.highlightAll();
-})</script>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>atomic_agents.lib.utils</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="atomic_agents.lib.utils.format_tool_message" href="format_tool_message.html">atomic_agents.lib.utils.format_tool_message</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="atomic_agents.lib" href="../index.html">atomic_agents.lib</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="atomic_agents.lib.utils.format_tool_message" href="format_tool_message.html">atomic_agents.lib.utils.format_tool_message</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
-</footer>
-</body>
-</html>
diff --git a/pyproject.toml b/pyproject.toml
index 10328c3..1881cf9 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -33,6 +33,12 @@ pytest = ">=8.3.3,<9.0.0"
pytest-cov = ">=5.0.0,<6.0.0"
pytest-asyncio = ">=0.24.0,<1.0.0"
openai = ">=1.35.12,<2.0.0"
+sphinx = ">=7.2.6,<8.0.0"
+sphinx-rtd-theme = ">=2.0.0,<3.0.0"
+myst-parser = ">=2.0.0,<3.0.0"
+sphinx-copybutton = ">=0.5.2,<1.0.0"
+sphinx-design = ">=0.5.0,<1.0.0"
+sphinx-autobuild = ">=2024.2.4,<2025.0.0"
[tool.poetry.scripts]
atomic = "atomic_assembler.main:main"