Building AI agents, atomically
chore: Bump version to 0.1.44 and update docs
KennyVaneetveldea7faaa25f079
diff --git a/docs/api/atomic_agents/agents/base_chat_agent.md b/docs/api/atomic_agents/agents/base_chat_agent.mdindex c0bfabf..0822823 100644--- a/docs/api/atomic_agents/agents/base_chat_agent.md+++ b/docs/api/atomic_agents/agents/base_chat_agent.md@@ -11,13 +11,16 @@- [BaseChatAgent()._init_run](#basechatagent()_init_run)- [BaseChatAgent()._post_run](#basechatagent()_post_run)- [BaseChatAgent()._pre_run](#basechatagent()_pre_run)+ - [BaseChatAgent().get_context_provider](#basechatagent()get_context_provider)- [BaseChatAgent().get_response](#basechatagent()get_response)- [BaseChatAgent().get_system_prompt](#basechatagent()get_system_prompt)+ - [BaseChatAgent().register_context_provider](#basechatagent()register_context_provider)- [BaseChatAgent().reset_memory](#basechatagent()reset_memory)- [BaseChatAgent().run](#basechatagent()run)+ - [BaseChatAgent().unregister_context_provider](#basechatagent()unregister_context_provider)- [BaseChatAgentConfig](#basechatagentconfig)- [BaseChatAgentInputSchema](#basechatagentinputschema)- - [BaseChatAgentResponseSchema](#basechatagentresponse)+ - [BaseChatAgentResponseSchema](#basechatagentresponseschema)## BaseAgentIO@@ -35,7 +38,7 @@ class BaseAgentIO(BaseModel): ...## BaseChatAgent-[Show source in base_chat_agent.py:46](../../../../atomic_agents/agents/base_chat_agent.py#L46)+[Show source in base_chat_agent.py:62](../../../../atomic_agents/agents/base_chat_agent.py#L62)Base class for chat agents.@@ -70,7 +73,7 @@ class BaseChatAgent:### BaseChatAgent()._get_and_handle_response-[Show source in base_chat_agent.py:132](../../../../atomic_agents/agents/base_chat_agent.py#L132)+[Show source in base_chat_agent.py:150](../../../../atomic_agents/agents/base_chat_agent.py#L150)Handles obtaining and processing the response.@@ -86,7 +89,7 @@ def _get_and_handle_response(self): ...### BaseChatAgent()._init_run-[Show source in base_chat_agent.py:142](../../../../atomic_agents/agents/base_chat_agent.py#L142)+[Show source in base_chat_agent.py:159](../../../../atomic_agents/agents/base_chat_agent.py#L159)Initializes the run with the given user input.@@ -106,7 +109,7 @@ def _init_run(self, user_input: Type[BaseAgentIO]): ...### BaseChatAgent()._post_run-[Show source in base_chat_agent.py:158](../../../../atomic_agents/agents/base_chat_agent.py#L158)+[Show source in base_chat_agent.py:175](../../../../atomic_agents/agents/base_chat_agent.py#L175)Finalizes the run with the given response.@@ -122,7 +125,7 @@ def _post_run(self, response): ...### BaseChatAgent()._pre_run-[Show source in base_chat_agent.py:152](../../../../atomic_agents/agents/base_chat_agent.py#L152)+[Show source in base_chat_agent.py:169](../../../../atomic_agents/agents/base_chat_agent.py#L169)Prepares for the run. This method can be overridden by subclasses to add custom pre-run logic.@@ -132,9 +135,39 @@ Prepares for the run. This method can be overridden by subclasses to add customdef _pre_run(self): ...```+### BaseChatAgent().get_context_provider++[Show source in base_chat_agent.py:184](../../../../atomic_agents/agents/base_chat_agent.py#L184)++Retrieves a context provider by name.++#### Arguments++- `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.++#### Signature++```python+def get_context_provider(+ self, provider_name: str+) -> Type[SystemPromptContextProviderBase]: ...+```++#### See also++- [SystemPromptContextProviderBase](../lib/components/system_prompt_generator.md#systempromptcontextproviderbase)+### BaseChatAgent().get_response-[Show source in base_chat_agent.py:94](../../../../atomic_agents/agents/base_chat_agent.py#L94)+[Show source in base_chat_agent.py:112](../../../../atomic_agents/agents/base_chat_agent.py#L112)Obtains a response from the language model.@@ -154,7 +187,7 @@ def get_response(self, response_model=None) -> Type[BaseModel]: ...### BaseChatAgent().get_system_prompt-[Show source in base_chat_agent.py:85](../../../../atomic_agents/agents/base_chat_agent.py#L85)+[Show source in base_chat_agent.py:103](../../../../atomic_agents/agents/base_chat_agent.py#L103)Generates the system prompt.@@ -168,9 +201,32 @@ Generates the system prompt.def get_system_prompt(self) -> str: ...```+### BaseChatAgent().register_context_provider++[Show source in base_chat_agent.py:201](../../../../atomic_agents/agents/base_chat_agent.py#L201)++Registers a new context provider.++#### Arguments++- `provider_name` *str* - The name of the context provider.+- `provider` *SystemPromptContextProviderBase* - The context provider instance.++#### Signature++```python+def register_context_provider(+ self, provider_name: str, provider: SystemPromptContextProviderBase+): ...+```++#### See also++- [SystemPromptContextProviderBase](../lib/components/system_prompt_generator.md#systempromptcontextproviderbase)+### BaseChatAgent().reset_memory-[Show source in base_chat_agent.py:79](../../../../atomic_agents/agents/base_chat_agent.py#L79)+[Show source in base_chat_agent.py:97](../../../../atomic_agents/agents/base_chat_agent.py#L97)Resets the memory to its initial state.@@ -182,7 +238,7 @@ def reset_memory(self): ...### BaseChatAgent().run-[Show source in base_chat_agent.py:115](../../../../atomic_agents/agents/base_chat_agent.py#L115)+[Show source in base_chat_agent.py:133](../../../../atomic_agents/agents/base_chat_agent.py#L133)Runs the chat agent with the given user input.@@ -204,11 +260,27 @@ def run(self, user_input: Optional[Type[BaseAgentIO]] = None) -> Type[BaseAgentI- [BaseAgentIO](#baseagentio)+### BaseChatAgent().unregister_context_provider++[Show source in base_chat_agent.py:211](../../../../atomic_agents/agents/base_chat_agent.py#L211)++Unregisters an existing context provider.++#### Arguments++- `provider_name` *str* - The name of the context provider to remove.++#### Signature++```python+def unregister_context_provider(self, provider_name: str): ...+```+## BaseChatAgentConfig-[Show source in base_chat_agent.py:36](../../../../atomic_agents/agents/base_chat_agent.py#L36)+[Show source in base_chat_agent.py:51](../../../../atomic_agents/agents/base_chat_agent.py#L51)#### Signature@@ -220,7 +292,7 @@ class BaseChatAgentConfig(BaseModel): ...## BaseChatAgentInputSchema-[Show source in base_chat_agent.py:22](../../../../atomic_agents/agents/base_chat_agent.py#L22)+[Show source in base_chat_agent.py:21](../../../../atomic_agents/agents/base_chat_agent.py#L21)#### Signature@@ -236,7 +308,7 @@ class BaseChatAgentInputSchema(BaseAgentIO): ...## BaseChatAgentResponseSchema-[Show source in base_chat_agent.py:25](../../../../atomic_agents/agents/base_chat_agent.py#L25)+[Show source in base_chat_agent.py:36](../../../../atomic_agents/agents/base_chat_agent.py#L36)#### Signaturediff --git a/docs/api/atomic_agents/lib/components/system_prompt_generator.md b/docs/api/atomic_agents/lib/components/system_prompt_generator.mdindex 6579b15..712ac2b 100644--- a/docs/api/atomic_agents/lib/components/system_prompt_generator.md+++ b/docs/api/atomic_agents/lib/components/system_prompt_generator.md@@ -17,7 +17,7 @@## CurrentDateProvider-[Show source in system_prompt_generator.py:56](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L56)+[Show source in system_prompt_generator.py:61](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L61)#### Signature@@ -32,7 +32,7 @@ class CurrentDateProvider(SystemPromptContextProviderBase):### CurrentDateProvider().get_info-[Show source in system_prompt_generator.py:61](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L61)+[Show source in system_prompt_generator.py:66](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L66)#### Signature@@ -44,7 +44,7 @@ def get_info(self) -> str: ...## LoremIpsumProvider-[Show source in system_prompt_generator.py:64](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L64)+[Show source in system_prompt_generator.py:69](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L69)#### Signature@@ -58,7 +58,7 @@ class LoremIpsumProvider(SystemPromptContextProviderBase): ...### LoremIpsumProvider().get_info-[Show source in system_prompt_generator.py:65](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L65)+[Show source in system_prompt_generator.py:70](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L70)#### Signature@@ -109,7 +109,7 @@ class SystemPromptGenerator:### SystemPromptGenerator().generate_prompt-[Show source in system_prompt_generator.py:30](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L30)+[Show source in system_prompt_generator.py:35](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L35)#### Signaturediff --git a/docs/api/atomic_agents/lib/models/web_document.md b/docs/api/atomic_agents/lib/models/web_document.mdindex 028f8bc..abb3ad5 100644--- a/docs/api/atomic_agents/lib/models/web_document.md+++ b/docs/api/atomic_agents/lib/models/web_document.md@@ -10,19 +10,23 @@## WebDocument-[Show source in web_document.py:10](../../../../../atomic_agents/lib/models/web_document.py#L10)+[Show source in web_document.py:12](../../../../../atomic_agents/lib/models/web_document.py#L12)#### Signature```python-class WebDocument(BaseModel): ...+class WebDocument(BaseAgentIO): ...```+#### See also++- [BaseAgentIO](../../agents/base_chat_agent.md#baseagentio)+## WebDocumentMetadata-[Show source in web_document.py:3](../../../../../atomic_agents/lib/models/web_document.py#L3)+[Show source in web_document.py:5](../../../../../atomic_agents/lib/models/web_document.py#L5)#### Signaturediff --git a/docs/api/atomic_agents/lib/tools/content_scraping_tool.md b/docs/api/atomic_agents/lib/tools/content_scraping_tool.mdindex 1fe5b37..1db3a6a 100644--- a/docs/api/atomic_agents/lib/tools/content_scraping_tool.md+++ b/docs/api/atomic_agents/lib/tools/content_scraping_tool.md@@ -8,7 +8,7 @@- `result` - ################TEST WEB PAGE #- ################: client.chat.completions.create(model='gpt-3.5-turbo', response_model=ContentScrapingTool.input_schema, messages=[{'role': 'user', 'content': 'Scrape the content of https://example.com'}])+ ################: client.chat.completions.create(model='gpt-3.5-turbo', response_model=ContentScrapingTool.input_schema, messages=[{'role': 'user', 'content': 'Scrape the content of https://brainblendai.com'}])- `result` - ###############TEST PDF URL #@@ -24,7 +24,7 @@## ContentScrapingTool-[Show source in content_scraping_tool.py:42](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L42)+[Show source in content_scraping_tool.py:44](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L44)Tool for scraping web pages or PDFs and converting content to markdown.@@ -49,7 +49,7 @@ class ContentScrapingTool(BaseTool):### ContentScrapingTool().run-[Show source in content_scraping_tool.py:62](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L62)+[Show source in content_scraping_tool.py:64](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L64)Runs the ContentScrapingTool with the given parameters.@@ -76,7 +76,7 @@ def run(self, params: ContentScrapingToolSchema) -> ContentScrapingToolOutputSch## ContentScrapingToolConfig-[Show source in content_scraping_tool.py:39](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L39)+[Show source in content_scraping_tool.py:40](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L40)#### Signature@@ -92,7 +92,7 @@ class ContentScrapingToolConfig(BaseToolConfig): ...## ContentScrapingToolOutputSchema-[Show source in content_scraping_tool.py:31](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L31)+[Show source in content_scraping_tool.py:32](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L32)#### Signature@@ -108,7 +108,7 @@ class ContentScrapingToolOutputSchema(BaseAgentIO): ...## ContentScrapingToolSchema-[Show source in content_scraping_tool.py:17](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L17)+[Show source in content_scraping_tool.py:18](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L18)#### Signaturediff --git a/docs/api/atomic_agents/lib/utils/scraping/pdf_to_markdown.md b/docs/api/atomic_agents/lib/utils/scraping/pdf_to_markdown.mdindex 88bf301..40902dd 100644--- a/docs/api/atomic_agents/lib/utils/scraping/pdf_to_markdown.md+++ b/docs/api/atomic_agents/lib/utils/scraping/pdf_to_markdown.md@@ -10,7 +10,7 @@## PdfToMarkdownConverter-[Show source in pdf_to_markdown.py:8](../../../../../../atomic_agents/lib/utils/scraping/pdf_to_markdown.py#L8)+[Show source in pdf_to_markdown.py:9](../../../../../../atomic_agents/lib/utils/scraping/pdf_to_markdown.py#L9)#### Signature@@ -20,7 +20,7 @@ class PdfToMarkdownConverter: ...### PdfToMarkdownConverter.convert-[Show source in pdf_to_markdown.py:28](../../../../../../atomic_agents/lib/utils/scraping/pdf_to_markdown.py#L28)+[Show source in pdf_to_markdown.py:32](../../../../../../atomic_agents/lib/utils/scraping/pdf_to_markdown.py#L32)#### Signaturediff --git a/docs/api/atomic_agents/lib/utils/scraping/url_to_markdown.md b/docs/api/atomic_agents/lib/utils/scraping/url_to_markdown.mdindex ca2e1b6..e304556 100644--- a/docs/api/atomic_agents/lib/utils/scraping/url_to_markdown.md+++ b/docs/api/atomic_agents/lib/utils/scraping/url_to_markdown.md@@ -10,7 +10,7 @@## UrlToMarkdownConverter-[Show source in url_to_markdown.py:8](../../../../../../atomic_agents/lib/utils/scraping/url_to_markdown.py#L8)+[Show source in url_to_markdown.py:9](../../../../../../atomic_agents/lib/utils/scraping/url_to_markdown.py#L9)#### Signature@@ -20,7 +20,7 @@ class UrlToMarkdownConverter: ...### UrlToMarkdownConverter.convert-[Show source in url_to_markdown.py:55](../../../../../../atomic_agents/lib/utils/scraping/url_to_markdown.py#L55)+[Show source in url_to_markdown.py:59](../../../../../../atomic_agents/lib/utils/scraping/url_to_markdown.py#L59)#### Signaturediff --git a/pyproject.toml b/pyproject.tomlindex 6f7b123..29c5ccd 100644--- a/pyproject.toml+++ b/pyproject.toml@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"[project]name = "atomic_agents"-version = "0.1.43"+version = "0.1.44"description = "A versatile framework designed to facilitate the creation and management of intelligent agents."authors = [{ name = "Kenny Vaneetvelde", email = "[email protected]" }