Skip to content

Overview graphic, restructuring of samples, troubleshooting guide, and more#13

Merged
aayush3011 merged 3 commits into
AzureCosmosDB:mainfrom
jcodella:main
May 20, 2026
Merged

Overview graphic, restructuring of samples, troubleshooting guide, and more#13
aayush3011 merged 3 commits into
AzureCosmosDB:mainfrom
jcodella:main

Conversation

@jcodella

Copy link
Copy Markdown
Contributor

This pull request improves the documentation and sample organization for the Agent Memory Toolkit, focusing on troubleshooting, onboarding clarity, and sample usability. It introduces a comprehensive troubleshooting guide, clarifies architecture, updates references to sample locations, and improves the organization of demo notebooks.

Documentation improvements:

  • Added a new Docs/troubleshooting.md guide that covers common setup, authentication, Cosmos DB, embeddings, Durable Functions, vector search, and change feed issues, and linked it from both the main and documentation READMEs. [1] [2] [3]
  • Enhanced the main README.md with a visual overview image and a concise architecture diagram to clarify system components and their interactions. [1] [2]
  • Improved documentation structure by updating the recommended reading order and clarifying the contents of the Samples/ and Docs/ directories. [1] [2]

Sample and notebook organization:

  • Moved and renamed the Durable Function demo notebook to Samples/Notebooks/Demo_function_app.ipynb for better categorization, and removed all executed outputs to make it cleaner for new users. [1] [2] [3] [4] [5] [6] [7] [8] [9]
  • Updated sample script references in the README.md to point to the correct, categorized quickstart path.

Copilot AI review requested due to automatic review settings May 19, 2026 18:56

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

This PR improves the Agent Memory Toolkit’s documentation and sample organization to make onboarding, troubleshooting, and end-to-end demos easier to follow.

Changes:

  • Added a comprehensive troubleshooting guide and linked it from the docs index and main README.
  • Reorganized/added demo notebooks (sync + async) and cleaned notebook outputs for a better “first run” experience.
  • Updated README content with an overview image and a new concise architecture diagram.

Reviewed changes

Copilot reviewed 8 out of 26 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
Samples/quickstart_local.py Updates the run command shown in the header docstring to reflect new sample location.
Samples/Notebooks/Demo_async.ipynb Adds a new async walkthrough notebook demonstrating local + Cosmos operations.
Samples/Notebooks/Demo.ipynb Adds a new sync walkthrough notebook demonstrating local + Cosmos operations.
Samples/Demo_function_app_async.ipynb Clears executed outputs / execution counts for a cleaner Functions demo notebook.
Samples/Demo_function_app.ipynb Clears executed outputs / execution counts for a cleaner Functions demo notebook.
README.md Adds overview image + new architecture block; updates sample paths; links troubleshooting.
Docs/troubleshooting.md Introduces a dedicated troubleshooting guide covering setup/auth/Cosmos/Functions/search.
Docs/README.md Links the new troubleshooting guide and updates recommended reading order.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread README.md
Comment thread Docs/troubleshooting.md
Comment thread Docs/troubleshooting.md Outdated
Comment thread Samples/Notebooks/Demo.ipynb Outdated
Comment thread Samples/Notebooks/Demo_async.ipynb Outdated
Comment thread Samples/Notebooks/Demo_async.ipynb
@jcodella jcodella requested a review from aayush3011 May 20, 2026 13:50
@aayush3011 aayush3011 requested a review from Copilot May 20, 2026 14:24

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 8 out of 26 changed files in this pull request and generated 2 comments.

Comment thread README.md Outdated
Comment thread Samples/Notebooks/Demo_async.ipynb
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings May 20, 2026 14:56
@aayush3011 aayush3011 merged commit ebdcd18 into AzureCosmosDB:main May 20, 2026
8 checks passed

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 8 out of 26 changed files in this pull request and generated 2 comments.

Comment on lines +277 to +280
"# Filter by user_id\n",
"user1_memories = memory.get_local(user_id=USER_ID)\n",
"print(f\"Memories for user-001: {len(user1_memories)}\")\n",
"\n",
Comment on lines +239 to +255
"cell_type": "code",
"execution_count": 15,
"id": "942e3714",
"metadata": {
"ExecuteTime": {
"end_time": "2026-04-07T22:06:50.682868Z",
"start_time": "2026-04-07T22:06:50.661470Z"
},
"execution": {
"iopub.execute_input": "2026-05-04T20:25:45.661416Z",
"iopub.status.busy": "2026-05-04T20:25:45.661371Z",
"iopub.status.idle": "2026-05-04T20:25:45.663639Z",
"shell.execute_reply": "2026-05-04T20:25:45.663296Z"
}
},
"outputs": [
{
aayush3011 added a commit that referenced this pull request May 29, 2026
…ine, and simplifies the deployment for Release (#15)

* Add procedural synthesis, strip per-turn procedural, fact_count rename

Brings forward the procedural-synthesis feature on top of the post-PR-#13
baseline and applies hygiene cleanup.

- Adds synthesize_procedural() on pipeline + processors (sync/async) and
  the Durable Functions orchestrator. Procedural memory is now produced
  via this dedicated reflection flow over a user's full history (system-
  prompt-style), not as a per-turn extraction.
- Strips procedural emission from extract_memories: removes the procedural
  type from the extraction prompt, drops procedural_count from result
  dicts and docstrings, and trims procedural from _load_existing_memories.
- Renames facts_count -> fact_count across pipeline, processors, FA
  orchestrator docstring, and all tests.
- Cosmetic enum rename: supersede_reason value 'contradiction' ->
  'contradict' for verb-tense consistency with 'update'. README and
  Docs/concepts.md updated accordingly.

Unit suite: 531 passed.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* refactor store + services

* updating record schema, adding logging

* improvements to tagging, filtering

* Improving the bicep files

* resolving comments

* resolving comments

* lint: fix ruff E501/F841 violations and apply ruff format

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* resolving comments

* resolving comments

* resolving comments

* resolving comments

---------

Co-authored-by: Aayush Kataria <aayushkataria@Aayushs-MacBook-Pro-2.local>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants