Skip to content

Commit f26db0a

Browse files
ashpreetbediashpreetbedi
committed
Merge branch 'memory-revamp-docs'
2 parents 9bdaa47 + e066433 commit f26db0a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+2520
-1202
lines changed

‎_snippets/agent-memory-reference.mdx‎

Lines changed: 40 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -2,80 +2,65 @@
22

33
| Parameter | Type | Description | Default |
44
|-----------|------|-------------|---------|
5-
| `runs` | `List[AgentRun]` | List of conversation runs between user and agent | `[]` |
6-
| `messages` | `List[Message]` | List of messages sent to the model | `[]` |
7-
| `update_system_message_on_change` | `bool` | Whether to update system message when changed | `False` |
8-
| `summary` | `Optional[SessionSummary]` | Current session summary | `None` |
9-
| `create_session_summary` | `bool` | Whether to create session summaries | `False` |
10-
| `update_session_summary_after_run` | `bool` | Whether to update summary after each run | `True` |
11-
| `summarizer` | `Optional[MemorySummarizer]` | Summarizer for generating session summaries | `None` |
12-
| `create_user_memories` | `bool` | Whether to create personalized memories | `False` |
13-
| `update_user_memories_after_run` | `bool` | Whether to update memories after each run | `True` |
14-
| `db` | `Optional[MemoryDb]` | Database for storing personalized memories | `None` |
15-
| `user_id` | `Optional[str]` | User identifier for personalized memories | `None` |
16-
| `retrieval` | `MemoryRetrieval` | Memory retrieval strategy | `MemoryRetrieval.last_n` |
17-
| `memories` | `Optional[List[Memory]]` | List of retrieved memories | `None` |
18-
| `num_memories` | `Optional[int]` | Number of memories to retrieve | `None` |
19-
| `classifier` | `Optional[MemoryClassifier]` | Classifier for memory importance | `None` |
20-
| `manager` | `Optional[MemoryManager]` | Manager for memory operations | `None` |
21-
22-
### Agent Run
23-
24-
| Parameter | Type | Description | Default |
25-
|-----------|------|-------------|---------|
26-
| `message` | `Optional[Message]` | Single message associated with the run | `None` |
27-
| `messages` | `Optional[List[Message]]` | List of messages associated with the run | `None` |
28-
| `response` | `Optional[RunResponse]` | Response generated during the run | `None` |
29-
30-
31-
### Session Summary
32-
33-
| Parameter | Type | Description | Default |
34-
|-----------|------|-------------|---------|
35-
| `summary` | `str` | Concise summary of the session focusing on important information | Required |
36-
| `topics` | `Optional[List[str]]` | List of topics discussed in the session | `None` |
37-
38-
### Memory Summarizer
39-
40-
| Parameter | Type | Description | Default |
41-
|-----------|------|-------------|---------|
42-
| `model` | `Optional[Model]` | Model used for generating summaries | `None` |
43-
| `use_structured_outputs` | `bool` | Whether to use structured outputs from the model | `False` |
5+
| `model` | `Optional[Model]` | Model used for memories and summaries | `None` |
6+
| `memory_manager` | `Optional[MemoryManager]` | Manager for memory operations | `None` |
7+
| `summarizer` | `Optional[SessionSummarizer]` | Summarizer for generating session summaries | `None` |
8+
| `db` | `Optional[MemoryDb]` | Database for storing memories | `None` |
9+
| `debug_mode` | `bool` | Whether to enable debug logging | `False` |
4410

11+
### Key Methods
4512

13+
#### User Memory Management
4614

47-
### Memory Retrieval
15+
| Method | Description | Parameters | Returns |
16+
|--------|-------------|------------|---------|
17+
| `get_user_memories` | Retrieves all memories for a user | `user_id: str` | `List[UserMemory]` |
18+
| `get_user_memory` | Gets a specific memory | `user_id: str, memory_id: str` | `UserMemory` |
19+
| `add_user_memory` | Adds a new memory and gets the memory id | `memory: UserMemory, user_id: Optional[str] = None` | `str` |
20+
| `replace_user_memory` | Updates an existing memory and gets the memory id | `memory_id: str, memory: UserMemory, user_id: Optional[str] = None` | `str` |
21+
| `delete_user_memory` | Deletes a memory | `user_id: str, memory_id: str` | `None` |
22+
| `create_user_memories` | Creates memories from one or more messages | `message: Optional[str] = None, messages: Optional[List[Message]] = None, user_id: Optional[str] = None` | `str` |
23+
| `acreate_user_memories` | Creates memories from one or more messages (Async) | `message: Optional[str] = None, messages: Optional[List[Message]] = None, user_id: Optional[str] = None` | `str` |
24+
| `search_user_memories` | Searches user memories using specified retrieval method | `query: Optional[str] = None, limit: Optional[int] = None, retrieval_method: Optional[Literal["last_n", "first_n", "semantic"]] = None, user_id: Optional[str] = None` | `List[UserMemory]` |
4825

49-
| Parameter | Type | Description |
50-
|-----------|------|-------------|
51-
| `last_n` | `str` | Retrieve the last N memories from history |
52-
| `first_n` | `str` | Retrieve the first N memories from history |
53-
| `semantic` | `str` | Retrieve memories based on semantic similarity |
26+
#### Session Summary Management
5427

28+
| Method | Description | Parameters |
29+
|--------|-------------|------------|
30+
| `get_session_summaries` | Retrieves all session summaries for a user | `user_id: str` |
31+
| `get_session_summary` | Gets a specific session summary | `user_id: str, session_id: str` |
32+
| `create_session_summary` | Creates a summary for a session from the stored session runs | `session_id: str, user_id: Optional[str] = None` |
33+
| `acreate_session_summary` | Creates a summary for a session from the stored session runs (Async) | `session_id: str, user_id: Optional[str] = None` |
34+
| `delete_session_summary` | Deletes a session summary | `user_id: str, session_id: str` |
5535

56-
### Memory
36+
### UserMemory
5737

5838
| Parameter | Type | Description | Default |
5939
|-----------|------|-------------|---------|
6040
| `memory` | `str` | The actual memory content | Required |
61-
| `id` | `Optional[str]` | Unique identifier for the memory | `None` |
62-
| `topic` | `Optional[str]` | Topic or category of the memory | `None` |
41+
| `topics` | `Optional[List[str]]` | Topics or categories of the memory | `None` |
6342
| `input` | `Optional[str]` | Original input that generated the memory | `None` |
43+
| `last_updated` | `Optional[datetime]` | When the memory was last updated | `None` |
44+
| `memory_id` | `Optional[str]` | Unique identifier for the memory | `None` |
6445

65-
### Memory Classifier
46+
### SessionSummary
6647

6748
| Parameter | Type | Description | Default |
6849
|-----------|------|-------------|---------|
69-
| `model` | `Optional[Model]` | Model used for classifying memories | `None` |
70-
| `system_prompt` | `Optional[str]` | Custom system prompt for the classifier | `None` |
71-
| `existing_memories` | `Optional[List[Memory]]` | List of existing memories to check against | `None` |
50+
| `summary` | `str` | Concise summary of the session | Required |
51+
| `topics` | `Optional[List[str]]` | Topics discussed in the session | `None` |
52+
| `last_updated` | `Optional[datetime]` | When the summary was last updated | `None` |
7253

7354
### Memory Manager
7455

7556
| Parameter | Type | Description | Default |
7657
|-----------|------|-------------|---------|
7758
| `model` | `Optional[Model]` | Model used for managing memories | `None` |
78-
| `user_id` | `Optional[str]` | Unique identifier for the user | `None` |
7959
| `system_prompt` | `Optional[str]` | Custom system prompt for the memory manager | `None` |
80-
| `db` | `Optional[MemoryDb]` | Database for storing memories | `None` |
81-
| `input_message` | `Optional[str]` | Current input message being processed | `None` |
60+
61+
### Session Summarizer
62+
63+
| Parameter | Type | Description | Default |
64+
|-----------|------|-------------|---------|
65+
| `model` | `Optional[Model]` | Model used for summarizing sessions | `None` |
66+
| `system_prompt` | `Optional[str]` | Custom system prompt for the summarizer | `None` |

‎_snippets/agent-reference.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
| `context` | `Optional[Dict[str, Any]]` | `None` | Context available for tools and prompt functions |
1414
| `add_context` | `bool` | `False` | If True, add the context to the user prompt |
1515
| `resolve_context` | `bool` | `True` | If True, resolve the context (i.e. call any functions in the context) before running the agent |
16-
| `memory` | `Optional[AgentMemory]` | `None` | Agent Memory |
16+
| `memory` | `Optional[Memory]` | `None` | Agent Memory |
1717
| `add_history_to_messages` | `bool` | `False` | Add chat history to the messages sent to the Model |
1818
| `num_history_responses` | `int` | `3` | Number of historical responses to add to the messages |
1919
| `knowledge` | `Optional[AgentKnowledge]` | `None` | Agent Knowledge |

‎_snippets/agent-session-reference.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
| `session_id` | `str` | Required | Session UUID |
44
| `agent_id` | `Optional[str]` | `None` | ID of the agent that this session is associated with |
55
| `user_id` | `Optional[str]` | `None` | ID of the user interacting with this agent |
6-
| `team_id` | `Optional[str]` | `None` | ID of the team that this session is possibly associated with |
6+
| `team_session_id` | `Optional[str]` | `None` | ID of the team session that this session is possibly associated with |
77
| `memory` | `Optional[Dict[str, Any]]` | `None` | Agent Memory |
88
| `agent_data` | `Optional[Dict[str, Any]]` | `None` | Agent Data: agent_id, name and model |
99
| `session_data` | `Optional[Dict[str, Any]]` | `None` | Session Data: session_name, session_state, images, videos, audio |

‎_snippets/task-base-reference.mdx‎

Lines changed: 0 additions & 34 deletions
This file was deleted.

‎_snippets/team-reference.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
| `response_model` | `Optional[Type[BaseModel]]` | `None` | Response model for the team response |
3232
| `use_json_mode` | `bool` | `False` | If `response_model` is set, sets the response "mode" of the model, i.e. if the model should explicitly respond with a JSON object instead of a Pydantic model |
3333
| `parse_response` | `bool` | `True` | If True, parse the response |
34-
| `memory` | `Optional[TeamMemory]` | `None` | Memory for the team |
34+
| `memory` | `Optional[Memory]` | `None` | Memory for the team |
3535
| `enable_team_history` | `bool` | `False` | If True, enable the team history |
3636
| `num_of_interactions_from_history` | `int` | `3` | Number of interactions from history |
3737
| `storage` | `Optional[Storage]` | `None` | Storage for the team |

0 commit comments

Comments
 (0)