Skip to content

Commit a7faaa2

Browse files
KennyVaneetveldeKennyVaneetvelde
committed
chore: Bump version to 0.1.44 and update docs
1 parent 415c0a5 commit a7faaa2

File tree

7 files changed

+108
-32
lines changed

7 files changed

+108
-32
lines changed

‎docs/api/atomic_agents/agents/base_chat_agent.md‎

Lines changed: 85 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,16 @@
1111
- [BaseChatAgent()._init_run](#basechatagent()_init_run)
1212
- [BaseChatAgent()._post_run](#basechatagent()_post_run)
1313
- [BaseChatAgent()._pre_run](#basechatagent()_pre_run)
14+
- [BaseChatAgent().get_context_provider](#basechatagent()get_context_provider)
1415
- [BaseChatAgent().get_response](#basechatagent()get_response)
1516
- [BaseChatAgent().get_system_prompt](#basechatagent()get_system_prompt)
17+
- [BaseChatAgent().register_context_provider](#basechatagent()register_context_provider)
1618
- [BaseChatAgent().reset_memory](#basechatagent()reset_memory)
1719
- [BaseChatAgent().run](#basechatagent()run)
20+
- [BaseChatAgent().unregister_context_provider](#basechatagent()unregister_context_provider)
1821
- [BaseChatAgentConfig](#basechatagentconfig)
1922
- [BaseChatAgentInputSchema](#basechatagentinputschema)
20-
- [BaseChatAgentResponseSchema](#basechatagentresponse)
23+
- [BaseChatAgentResponseSchema](#basechatagentresponseschema)
2124

2225
## BaseAgentIO
2326

@@ -35,7 +38,7 @@ class BaseAgentIO(BaseModel): ...
3538

3639
## BaseChatAgent
3740

38-
[Show source in base_chat_agent.py:46](../../../../atomic_agents/agents/base_chat_agent.py#L46)
41+
[Show source in base_chat_agent.py:62](../../../../atomic_agents/agents/base_chat_agent.py#L62)
3942

4043
Base class for chat agents.
4144

@@ -70,7 +73,7 @@ class BaseChatAgent:
7073

7174
### BaseChatAgent()._get_and_handle_response
7275

73-
[Show source in base_chat_agent.py:132](../../../../atomic_agents/agents/base_chat_agent.py#L132)
76+
[Show source in base_chat_agent.py:150](../../../../atomic_agents/agents/base_chat_agent.py#L150)
7477

7578
Handles obtaining and processing the response.
7679

@@ -86,7 +89,7 @@ def _get_and_handle_response(self): ...
8689

8790
### BaseChatAgent()._init_run
8891

89-
[Show source in base_chat_agent.py:142](../../../../atomic_agents/agents/base_chat_agent.py#L142)
92+
[Show source in base_chat_agent.py:159](../../../../atomic_agents/agents/base_chat_agent.py#L159)
9093

9194
Initializes the run with the given user input.
9295

@@ -106,7 +109,7 @@ def _init_run(self, user_input: Type[BaseAgentIO]): ...
106109

107110
### BaseChatAgent()._post_run
108111

109-
[Show source in base_chat_agent.py:158](../../../../atomic_agents/agents/base_chat_agent.py#L158)
112+
[Show source in base_chat_agent.py:175](../../../../atomic_agents/agents/base_chat_agent.py#L175)
110113

111114
Finalizes the run with the given response.
112115

@@ -122,7 +125,7 @@ def _post_run(self, response): ...
122125

123126
### BaseChatAgent()._pre_run
124127

125-
[Show source in base_chat_agent.py:152](../../../../atomic_agents/agents/base_chat_agent.py#L152)
128+
[Show source in base_chat_agent.py:169](../../../../atomic_agents/agents/base_chat_agent.py#L169)
126129

127130
Prepares for the run. This method can be overridden by subclasses to add custom pre-run logic.
128131

@@ -132,9 +135,39 @@ Prepares for the run. This method can be overridden by subclasses to add custom
132135
def _pre_run(self): ...
133136
```
134137

138+
### BaseChatAgent().get_context_provider
139+
140+
[Show source in base_chat_agent.py:184](../../../../atomic_agents/agents/base_chat_agent.py#L184)
141+
142+
Retrieves a context provider by name.
143+
144+
#### Arguments
145+
146+
- `provider_name` *str* - The name of the context provider.
147+
148+
#### Returns
149+
150+
- `SystemPromptContextProviderBase` - The context provider if found.
151+
152+
#### Raises
153+
154+
- `KeyError` - If the context provider is not found.
155+
156+
#### Signature
157+
158+
```python
159+
def get_context_provider(
160+
self, provider_name: str
161+
) -> Type[SystemPromptContextProviderBase]: ...
162+
```
163+
164+
#### See also
165+
166+
- [SystemPromptContextProviderBase](../lib/components/system_prompt_generator.md#systempromptcontextproviderbase)
167+
135168
### BaseChatAgent().get_response
136169

137-
[Show source in base_chat_agent.py:94](../../../../atomic_agents/agents/base_chat_agent.py#L94)
170+
[Show source in base_chat_agent.py:112](../../../../atomic_agents/agents/base_chat_agent.py#L112)
138171

139172
Obtains a response from the language model.
140173

@@ -154,7 +187,7 @@ def get_response(self, response_model=None) -> Type[BaseModel]: ...
154187

155188
### BaseChatAgent().get_system_prompt
156189

157-
[Show source in base_chat_agent.py:85](../../../../atomic_agents/agents/base_chat_agent.py#L85)
190+
[Show source in base_chat_agent.py:103](../../../../atomic_agents/agents/base_chat_agent.py#L103)
158191

159192
Generates the system prompt.
160193

@@ -168,9 +201,32 @@ Generates the system prompt.
168201
def get_system_prompt(self) -> str: ...
169202
```
170203

204+
### BaseChatAgent().register_context_provider
205+
206+
[Show source in base_chat_agent.py:201](../../../../atomic_agents/agents/base_chat_agent.py#L201)
207+
208+
Registers a new context provider.
209+
210+
#### Arguments
211+
212+
- `provider_name` *str* - The name of the context provider.
213+
- `provider` *SystemPromptContextProviderBase* - The context provider instance.
214+
215+
#### Signature
216+
217+
```python
218+
def register_context_provider(
219+
self, provider_name: str, provider: SystemPromptContextProviderBase
220+
): ...
221+
```
222+
223+
#### See also
224+
225+
- [SystemPromptContextProviderBase](../lib/components/system_prompt_generator.md#systempromptcontextproviderbase)
226+
171227
### BaseChatAgent().reset_memory
172228

173-
[Show source in base_chat_agent.py:79](../../../../atomic_agents/agents/base_chat_agent.py#L79)
229+
[Show source in base_chat_agent.py:97](../../../../atomic_agents/agents/base_chat_agent.py#L97)
174230

175231
Resets the memory to its initial state.
176232

@@ -182,7 +238,7 @@ def reset_memory(self): ...
182238

183239
### BaseChatAgent().run
184240

185-
[Show source in base_chat_agent.py:115](../../../../atomic_agents/agents/base_chat_agent.py#L115)
241+
[Show source in base_chat_agent.py:133](../../../../atomic_agents/agents/base_chat_agent.py#L133)
186242

187243
Runs the chat agent with the given user input.
188244

@@ -204,11 +260,27 @@ def run(self, user_input: Optional[Type[BaseAgentIO]] = None) -> Type[BaseAgentI
204260

205261
- [BaseAgentIO](#baseagentio)
206262

263+
### BaseChatAgent().unregister_context_provider
264+
265+
[Show source in base_chat_agent.py:211](../../../../atomic_agents/agents/base_chat_agent.py#L211)
266+
267+
Unregisters an existing context provider.
268+
269+
#### Arguments
270+
271+
- `provider_name` *str* - The name of the context provider to remove.
272+
273+
#### Signature
274+
275+
```python
276+
def unregister_context_provider(self, provider_name: str): ...
277+
```
278+
207279

208280

209281
## BaseChatAgentConfig
210282

211-
[Show source in base_chat_agent.py:36](../../../../atomic_agents/agents/base_chat_agent.py#L36)
283+
[Show source in base_chat_agent.py:51](../../../../atomic_agents/agents/base_chat_agent.py#L51)
212284

213285
#### Signature
214286

@@ -220,7 +292,7 @@ class BaseChatAgentConfig(BaseModel): ...
220292

221293
## BaseChatAgentInputSchema
222294

223-
[Show source in base_chat_agent.py:22](../../../../atomic_agents/agents/base_chat_agent.py#L22)
295+
[Show source in base_chat_agent.py:21](../../../../atomic_agents/agents/base_chat_agent.py#L21)
224296

225297
#### Signature
226298

@@ -236,7 +308,7 @@ class BaseChatAgentInputSchema(BaseAgentIO): ...
236308

237309
## BaseChatAgentResponseSchema
238310

239-
[Show source in base_chat_agent.py:25](../../../../atomic_agents/agents/base_chat_agent.py#L25)
311+
[Show source in base_chat_agent.py:36](../../../../atomic_agents/agents/base_chat_agent.py#L36)
240312

241313
#### Signature
242314

‎docs/api/atomic_agents/lib/components/system_prompt_generator.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
## CurrentDateProvider
1919

20-
[Show source in system_prompt_generator.py:56](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L56)
20+
[Show source in system_prompt_generator.py:61](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L61)
2121

2222
#### Signature
2323

@@ -32,7 +32,7 @@ class CurrentDateProvider(SystemPromptContextProviderBase):
3232

3333
### CurrentDateProvider().get_info
3434

35-
[Show source in system_prompt_generator.py:61](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L61)
35+
[Show source in system_prompt_generator.py:66](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L66)
3636

3737
#### Signature
3838

@@ -44,7 +44,7 @@ def get_info(self) -> str: ...
4444

4545
## LoremIpsumProvider
4646

47-
[Show source in system_prompt_generator.py:64](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L64)
47+
[Show source in system_prompt_generator.py:69](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L69)
4848

4949
#### Signature
5050

@@ -58,7 +58,7 @@ class LoremIpsumProvider(SystemPromptContextProviderBase): ...
5858

5959
### LoremIpsumProvider().get_info
6060

61-
[Show source in system_prompt_generator.py:65](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L65)
61+
[Show source in system_prompt_generator.py:70](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L70)
6262

6363
#### Signature
6464

@@ -109,7 +109,7 @@ class SystemPromptGenerator:
109109

110110
### SystemPromptGenerator().generate_prompt
111111

112-
[Show source in system_prompt_generator.py:30](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L30)
112+
[Show source in system_prompt_generator.py:35](../../../../../atomic_agents/lib/components/system_prompt_generator.py#L35)
113113

114114
#### Signature
115115

‎docs/api/atomic_agents/lib/models/web_document.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,23 @@
1010

1111
## WebDocument
1212

13-
[Show source in web_document.py:10](../../../../../atomic_agents/lib/models/web_document.py#L10)
13+
[Show source in web_document.py:12](../../../../../atomic_agents/lib/models/web_document.py#L12)
1414

1515
#### Signature
1616

1717
```python
18-
class WebDocument(BaseModel): ...
18+
class WebDocument(BaseAgentIO): ...
1919
```
2020

21+
#### See also
22+
23+
- [BaseAgentIO](../../agents/base_chat_agent.md#baseagentio)
24+
2125

2226

2327
## WebDocumentMetadata
2428

25-
[Show source in web_document.py:3](../../../../../atomic_agents/lib/models/web_document.py#L3)
29+
[Show source in web_document.py:5](../../../../../atomic_agents/lib/models/web_document.py#L5)
2630

2731
#### Signature
2832

‎docs/api/atomic_agents/lib/tools/content_scraping_tool.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
- `result` - ################
1010
TEST WEB PAGE #
11-
################: 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'}])
11+
################: 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'}])
1212

1313
- `result` - ###############
1414
TEST PDF URL #
@@ -24,7 +24,7 @@
2424

2525
## ContentScrapingTool
2626

27-
[Show source in content_scraping_tool.py:42](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L42)
27+
[Show source in content_scraping_tool.py:44](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L44)
2828

2929
Tool for scraping web pages or PDFs and converting content to markdown.
3030

@@ -49,7 +49,7 @@ class ContentScrapingTool(BaseTool):
4949

5050
### ContentScrapingTool().run
5151

52-
[Show source in content_scraping_tool.py:62](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L62)
52+
[Show source in content_scraping_tool.py:64](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L64)
5353

5454
Runs the ContentScrapingTool with the given parameters.
5555

@@ -76,7 +76,7 @@ def run(self, params: ContentScrapingToolSchema) -> ContentScrapingToolOutputSch
7676

7777
## ContentScrapingToolConfig
7878

79-
[Show source in content_scraping_tool.py:39](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L39)
79+
[Show source in content_scraping_tool.py:40](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L40)
8080

8181
#### Signature
8282

@@ -92,7 +92,7 @@ class ContentScrapingToolConfig(BaseToolConfig): ...
9292

9393
## ContentScrapingToolOutputSchema
9494

95-
[Show source in content_scraping_tool.py:31](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L31)
95+
[Show source in content_scraping_tool.py:32](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L32)
9696

9797
#### Signature
9898

@@ -108,7 +108,7 @@ class ContentScrapingToolOutputSchema(BaseAgentIO): ...
108108

109109
## ContentScrapingToolSchema
110110

111-
[Show source in content_scraping_tool.py:17](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L17)
111+
[Show source in content_scraping_tool.py:18](../../../../../atomic_agents/lib/tools/content_scraping_tool.py#L18)
112112

113113
#### Signature
114114

‎docs/api/atomic_agents/lib/utils/scraping/pdf_to_markdown.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
## PdfToMarkdownConverter
1212

13-
[Show source in pdf_to_markdown.py:8](../../../../../../atomic_agents/lib/utils/scraping/pdf_to_markdown.py#L8)
13+
[Show source in pdf_to_markdown.py:9](../../../../../../atomic_agents/lib/utils/scraping/pdf_to_markdown.py#L9)
1414

1515
#### Signature
1616

@@ -20,7 +20,7 @@ class PdfToMarkdownConverter: ...
2020

2121
### PdfToMarkdownConverter.convert
2222

23-
[Show source in pdf_to_markdown.py:28](../../../../../../atomic_agents/lib/utils/scraping/pdf_to_markdown.py#L28)
23+
[Show source in pdf_to_markdown.py:32](../../../../../../atomic_agents/lib/utils/scraping/pdf_to_markdown.py#L32)
2424

2525
#### Signature
2626

‎docs/api/atomic_agents/lib/utils/scraping/url_to_markdown.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
## UrlToMarkdownConverter
1212

13-
[Show source in url_to_markdown.py:8](../../../../../../atomic_agents/lib/utils/scraping/url_to_markdown.py#L8)
13+
[Show source in url_to_markdown.py:9](../../../../../../atomic_agents/lib/utils/scraping/url_to_markdown.py#L9)
1414

1515
#### Signature
1616

@@ -20,7 +20,7 @@ class UrlToMarkdownConverter: ...
2020

2121
### UrlToMarkdownConverter.convert
2222

23-
[Show source in url_to_markdown.py:55](../../../../../../atomic_agents/lib/utils/scraping/url_to_markdown.py#L55)
23+
[Show source in url_to_markdown.py:59](../../../../../../atomic_agents/lib/utils/scraping/url_to_markdown.py#L59)
2424

2525
#### Signature
2626

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "atomic_agents"
7-
version = "0.1.43"
7+
version = "0.1.44"
88
description = "A versatile framework designed to facilitate the creation and management of intelligent agents."
99
authors = [
1010
{ name = "Kenny Vaneetvelde", email = "[email protected]" }

0 commit comments

Comments
 (0)