Skip to content

Commit 105302b

Browse files
Craig ShoemakerCraig Shoemaker
authored andcommitted
updates
1 parent 15cdd87 commit 105302b

1 file changed

Lines changed: 25 additions & 25 deletions

File tree

articles/sre-agent/memory-system.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -66,31 +66,31 @@ The `SearchMemory` tool retrieves all memory components. It searches across user
6666
- Custom subagents: Add `SearchMemory` tool to your configuration
6767

6868
> [!IMPORTANT]
69-
> Don't store secrets, credentials, API keys, or sensitive data in any memory component. Memories are shared across your team and indexed for search.
69+
> Don't store secrets, credentials, API keys, or sensitive data in any memory component. Your team shares memories, and the system indexes them for search.
7070
7171
### Enhanced search parameters
7272

7373
The `SearchNodes` tool supports filtering options for more targeted searches:
7474

7575
| Parameter | Type | Description |
7676
|-----------|------|-------------|
77-
| `entityType` | string | Filter results by entity type (for example, `Incident`, `Service`, `Resource`) |
78-
| `includeNeighbors` | bool | Include connected nodes in the search results |
77+
| `entityType` | string | Filter results by entity type, such as `Incident`, `Service`, or `Resource`. |
78+
| `includeNeighbors` | bool | Include connected nodes in the search results. |
7979

8080
**Example:**
8181

8282
```text
8383
Search for all incidents related to "database timeout" and include connected resources
8484
```
8585

86-
With `includeNeighbors: true`, the search returns not only matching incident nodes but also their connected:
86+
When you set `includeNeighbors` to `true`, the search returns not only matching incident nodes but also their connected:
8787

8888
- Resources
8989
- Services
9090
- Related incidents
9191
- Linked documents
9292

93-
This enables richer context during investigations by showing the full relationship graph around matching nodes.
93+
By showing the full relationship graph around matching nodes, you get richer context during investigations.
9494

9595
## Quick start
9696

@@ -164,7 +164,7 @@ Save facts, standards, or context for future conversations.
164164
#remember Team uses Kusto for logs. Workspace is "myteam-prod-logs"
165165
```
166166

167-
Content is embedded by using OpenAI, stored in Azure AI Search, and becomes available for automatic retrieval across all conversations. You see a confirmation: `✅ Agent Memory saved.`
167+
The system embeds content by using OpenAI, stores it in Azure AI Search, and makes it available for automatic retrieval across all conversations. You see a confirmation: `✅ Agent Memory saved.`
168168

169169
#### Remove memories by using `#forget`
170170

@@ -183,7 +183,7 @@ Delete previously saved memories by searching for them.
183183
#forget production environment location
184184
```
185185

186-
The system searches your memories semantically for the best match, shows you the content, and deletes it. You see a confirmation: `✅ Agent Memory forgotten: [deleted content]`
186+
The system semantically searches your memories for the best match, shows you the content, and deletes it. You see a confirmation: `✅ Agent Memory forgotten: [deleted content]`
187187

188188
#### Query memories by using `#retrieve`
189189

@@ -202,7 +202,7 @@ Explicitly search and display saved memories without triggering agent reasoning.
202202
#retrieve deployment process
203203
```
204204

205-
Searches memories semantically, and then uses the top five matches to synthesize a response. Both the individual memories and the synthesized answer are displayed.
205+
The system semantically searches memories. It uses the top five matches to synthesize a response. Both the individual memories and the synthesized answer are displayed.
206206

207207
### Scope and storage
208208

@@ -231,11 +231,11 @@ The knowledge base provides direct document upload capabilities for runbooks, tr
231231

232232
### Upload via agent tool
233233

234-
The agent can upload documents directly to the knowledge base using the `UploadKnowledgeDocument` tool. This is useful when:
234+
The agent can upload documents directly to the knowledge base by using the `UploadKnowledgeDocument` tool. This method is useful when:
235235

236-
- Capturing troubleshooting steps discovered during an investigation
237-
- Adding runbooks generated from incident resolutions
238-
- Programmatically adding documentation without UI access
236+
- You want to capture troubleshooting steps discovered during an investigation.
237+
- You need to add runbooks generated from incident resolutions.
238+
- You want to programmatically add documentation without UI access.
239239

240240
**Tool: UploadKnowledgeDocument**
241241

@@ -253,24 +253,24 @@ Ask the agent:
253253
254254
The agent uses `UploadKnowledgeDocument` to:
255255

256-
1. Create a document with appropriate filename
257-
1. Format the content in Markdown
258-
1. Upload to Azure Blob Storage
259-
1. Trigger indexing for immediate searchability
256+
1. Create a document with an appropriate filename.
257+
1. Format the content in Markdown.
258+
1. Upload the document to Azure Blob Storage.
259+
1. Trigger indexing for immediate searchability.
260260

261261
**Constraints:**
262262

263-
- Maximum file size: 16 MB
264-
- Supported extensions: `.md`, `.txt` only
265-
- If a document with the same filename exists, it's overwritten
263+
- Maximum file size: 16 MB.
264+
- Supported extensions: `.md` and `.txt` only.
265+
- If a document with the same filename exists, the agent overwrites it.
266266

267267
**Error handling:**
268268

269269
| Error | Resolution |
270270
|-------|------------|
271-
| "Agent memory is disabled" | Enable agent memory in configuration |
272-
| "Invalid file extension" | Use `.md` or `.txt` extension only |
273-
| "Document content exceeds maximum size" | Split large documents into smaller files |
271+
| "Agent memory is disabled" | Enable agent memory in configuration. |
272+
| "Invalid file extension" | Use `.md` or `.txt` extension only. |
273+
| "Document content exceeds maximum size" | Split large documents into smaller files. |
274274

275275
### Manage documents
276276

@@ -282,7 +282,7 @@ The agent uses `UploadKnowledgeDocument` to:
282282

283283
## Session insights
284284

285-
As the agent handles your incidents, it learns. Session insights capture what worked, what didn't, and key learnings from each session. The agent automatically applies that knowledge to help with similar issues in the future.
285+
As the agent handles your incidents, it learns. Session insights capture what worked, what didn't, and key learnings from each session. The agent automatically applies that knowledge to help with similar problems in the future.
286286

287287
### Automatic improvement
288288

@@ -307,11 +307,11 @@ While session insights work automatically, reviewing them can surface valuable p
307307
| Telemetry gaps made diagnosis harder | Improve logging or add metrics |
308308
| Alert triggered but wasn't actionable | Tune the alert or add runbook links |
309309

310-
Think of session insights as a window into what the agent learns. You might find something worth acting on, or you might just let the agent handle any surfaced issues.
310+
Think of session insights as a window into what the agent learns. You might find something worth acting on, or you might just let the agent handle any surfaced problems.
311311

312312
### How it works
313313

314-
Session insights create a continuous improvement loop: the agent captures symptoms, steps, root cause, and pitfalls from each session, then retrieves relevant past insights when similar issues arise. This automatic cycle helps the agent resolve problems faster over time.
314+
Session insights create a continuous improvement loop: the agent captures symptoms, steps, root cause, and pitfalls from each session, then retrieves relevant past insights when similar problems arise. This automatic cycle helps the agent resolve problems faster over time.
315315

316316
<!--
317317
```mermaid

0 commit comments

Comments
 (0)