Skip to content

Adds sample documentation for two separate Neo4j context providers fo…#361

Merged
westey-m merged 6 commits intoMicrosoftDocs:mainfrom
neo4j-partners:docs/neo4j-context-provider
Apr 1, 2026
Merged

Adds sample documentation for two separate Neo4j context providers fo…#361
westey-m merged 6 commits intoMicrosoftDocs:mainfrom
neo4j-partners:docs/neo4j-context-provider

Conversation

@retroryan
Copy link
Copy Markdown
Contributor

@retroryan retroryan commented Feb 17, 2026

Summary

Adds dedicated integration pages for two Neo4j context providers for Agent Framework. These providers serve distinct roles in the agent architecture:

  • GraphRAG (integrations/neo4j-graphrag.md) — Read-only RAG provider that queries pre-existing Neo4j knowledge bases with vector, fulltext, or hybrid search and optional graph traversal enrichment
  • Memory (integrations/neo4j-memory.md) — Read-write memory provider that stores conversations, extracts entities into a knowledge graph, and learns user preferences across sessions

Addresses PR feedback to move provider-specific content from inline sections in the user-guide to standalone pages under integrations/, matching the existing pattern (e.g. Purview).

Changes

  • Created agent-framework/integrations/neo4j-graphrag.md — GraphRAG provider: graph-enhanced RAG with vector, fulltext, and hybrid search
  • Created agent-framework/integrations/neo4j-memory.md — Memory provider: persistent agent memory with knowledge graph building and memory tools
  • Updated agent-framework/integrations/index.md — Added Neo4j to Memory and RAG provider tables (Python pivot)
  • Updated agent-framework/TOC.yml — Added sidebar entries under Integrations section
  • Updated agent-framework/agents/rag.md — Replaced inline Neo4j section with link to integration page
  • Deleted agent-framework/user-guide/agents/agent-memory.md — Removed orphaned file from old directory structure

Links

Build notes

The two suggestions on our files are expected:

  • ms.author: ryanknight is not a valid Microsoft alias — happy to update to whichever alias owns the integrations section
  • Filename lint flags "graphrag" as an abbreviation — "GraphRAG" is an established term in the ecosystem; happy to rename if preferred

The two warnings on microsoft-foundry.md and code-interpreter.md are pre-existing and unrelated to this PR.

@retroryan retroryan marked this pull request as draft February 17, 2026 19:09
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 0791fe1:

✅ Validation status: passed

File Status Preview URL Details
agent-framework/user-guide/agents/agent-memory.md ✅Succeeded
agent-framework/user-guide/agents/agent-rag.md ✅Succeeded

For more details, please refer to the build report.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit ab91b57:

✅ Validation status: passed

File Status Preview URL Details
agent-framework/user-guide/agents/agent-memory.md ✅Succeeded
agent-framework/user-guide/agents/agent-rag.md ✅Succeeded

For more details, please refer to the build report.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 67cb43e:

⚠️ Validation status: warnings

File Status Preview URL Details
semantic-kernel/concepts/vector-store-connectors/index.md ⚠️Warning Details
semantic-kernel/Frameworks/agent/TOC.yml ⚠️Warning Details
agent-framework/user-guide/agents/agent-graphrag.md ✅Succeeded
agent-framework/user-guide/agents/agent-memory.md ✅Succeeded
agent-framework/user-guide/agents/agent-rag.md ✅Succeeded n/a (file deleted or renamed)
agent-framework/user-guide/agents/agent-tools.md ✅Succeeded
agent-framework/user-guide/agents/TOC.yml ✅Succeeded

semantic-kernel/concepts/vector-store-connectors/index.md

  • Line 56, Column 66: [Warning: file-not-found - See documentation] Invalid file link: '../../Frameworks/agent/agent-graphrag.md'.

semantic-kernel/Frameworks/agent/TOC.yml

  • Line 18, Column 9: [Warning: file-not-found - See documentation] Invalid file link: 'agent-graphrag.md'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 4c16798:

✅ Validation status: passed

File Status Preview URL Details
agent-framework/user-guide/agents/agent-graphrag.md ✅Succeeded
agent-framework/user-guide/agents/agent-memory.md ✅Succeeded
agent-framework/user-guide/agents/agent-rag.md ✅Succeeded n/a (file deleted or renamed)
agent-framework/user-guide/agents/agent-tools.md ✅Succeeded
agent-framework/user-guide/agents/TOC.yml ✅Succeeded
semantic-kernel/concepts/vector-store-connectors/index.md ✅Succeeded
semantic-kernel/Frameworks/agent/agent-graphrag.md ✅Succeeded
semantic-kernel/Frameworks/agent/agent-rag.md ✅Succeeded n/a (file deleted or renamed)
semantic-kernel/Frameworks/agent/TOC.yml ✅Succeeded

For more details, please refer to the build report.

@retroryan retroryan force-pushed the docs/neo4j-context-provider branch from 4c16798 to 2f41998 Compare February 18, 2026 03:33
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 2f41998:

✅ Validation status: passed

File Status Preview URL Details
agent-framework/user-guide/agents/agent-graphrag.md ✅Succeeded
agent-framework/user-guide/agents/agent-memory.md ✅Succeeded
agent-framework/user-guide/agents/agent-rag.md ✅Succeeded n/a (file deleted or renamed)
agent-framework/user-guide/agents/agent-tools.md ✅Succeeded
agent-framework/user-guide/agents/TOC.yml ✅Succeeded
semantic-kernel/concepts/vector-store-connectors/index.md ✅Succeeded
semantic-kernel/Frameworks/agent/agent-graphrag.md ✅Succeeded
semantic-kernel/Frameworks/agent/agent-rag.md ✅Succeeded n/a (file deleted or renamed)
semantic-kernel/Frameworks/agent/TOC.yml ✅Succeeded

For more details, please refer to the build report.

@retroryan retroryan force-pushed the docs/neo4j-context-provider branch from 2f41998 to 8ba2b9e Compare February 18, 2026 03:43
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 8ba2b9e:

✅ Validation status: passed

File Status Preview URL Details
agent-framework/user-guide/agents/agent-memory.md ✅Succeeded
agent-framework/user-guide/agents/agent-rag.md ✅Succeeded

For more details, please refer to the build report.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit a02e153:

✅ Validation status: passed

File Status Preview URL Details
agent-framework/user-guide/agents/agent-memory.md ✅Succeeded
agent-framework/user-guide/agents/agent-rag.md ✅Succeeded

For more details, please refer to the build report.

@retroryan retroryan marked this pull request as ready for review February 27, 2026 16:09
@retroryan retroryan force-pushed the docs/neo4j-context-provider branch from a02e153 to a79eec4 Compare March 29, 2026 16:37
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit a79eec4:

⚠️ Validation status: warnings

File Status Preview URL Details
⚠️Warning Details
agent-framework/agents/providers/microsoft-foundry.md ⚠️Warning Details
agent-framework/agents/rag.md ⚠️Warning Details
agent-framework/agents/tools/code-interpreter.md ⚠️Warning Details
agent-framework/user-guide/agents/agent-memory.md ✅Succeeded

  • Line 0, Column 0: [Warning: redirected-file-not-removed - See documentation] Redirected file 'user-guide/agents/agent-memory.md' are still in the repo. After adding a file to the redirection JSON file, you must delete the original file from the repo.

agent-framework/agents/providers/microsoft-foundry.md

  • Line 412, Column 1: [Warning: invalid-code] The code snippet "~/../agent-framework-code/python/samples/02-agents/providers/azure_ai/azure_ai_with_reasoning.py" could not be found.
  • Line 416, Column 1: [Warning: invalid-code] The code snippet "~/../agent-framework-code/python/samples/02-agents/providers/azure_ai/azure_ai_with_content_filtering.py" could not be found.

agent-framework/agents/rag.md

  • Line 558, Column 327: [Warning: file-not-found - See documentation] Invalid file link: './agent-memory.md'.

agent-framework/agents/tools/code-interpreter.md

  • Line 132, Column 1: [Warning: invalid-code] The code snippet "~/../agent-framework-code/python/samples/02-agents/providers/azure_openai/azure_assistants_with_code_interpreter.py" could not be found.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 96cdd2f:

⚠️ Validation status: warnings

File Status Preview URL Details
agent-framework/agents/providers/microsoft-foundry.md ⚠️Warning Details
agent-framework/agents/tools/code-interpreter.md ⚠️Warning Details
agent-framework/integrations/neo4j-graphrag.md 💡Suggestion Details
agent-framework/integrations/neo4j-memory.md 💡Suggestion Details
agent-framework/agents/rag.md ✅Succeeded
agent-framework/integrations/index.md ✅Succeeded
agent-framework/TOC.yml ✅Succeeded

agent-framework/agents/providers/microsoft-foundry.md

  • Line 412, Column 1: [Warning: invalid-code] The code snippet "~/../agent-framework-code/python/samples/02-agents/providers/azure_ai/azure_ai_with_reasoning.py" could not be found.
  • Line 416, Column 1: [Warning: invalid-code] The code snippet "~/../agent-framework-code/python/samples/02-agents/providers/azure_ai/azure_ai_with_content_filtering.py" could not be found.

agent-framework/agents/tools/code-interpreter.md

  • Line 132, Column 1: [Warning: invalid-code] The code snippet "~/../agent-framework-code/python/samples/02-agents/providers/azure_openai/azure_assistants_with_code_interpreter.py" could not be found.

agent-framework/integrations/neo4j-graphrag.md

  • Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
  • Line 7, Column 12: [Suggestion: ms-author-invalid - See documentation] Invalid value for 'ms.author', 'ryanknight' is not a valid Microsoft alias.

agent-framework/integrations/neo4j-memory.md

  • Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
  • Line 7, Column 12: [Suggestion: ms-author-invalid - See documentation] Invalid value for 'ms.author', 'ryanknight' is not a valid Microsoft alias.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds dedicated Agent Framework integration documentation pages for two Neo4j context providers (GraphRAG and persistent Memory), and wires them into the integrations index, TOC, and the RAG guidance page.

Changes:

  • Added new integration pages: Neo4j GraphRAG Context Provider and Neo4j Memory Provider.
  • Updated integrations index tables (Python pivot) to include the new Neo4j providers.
  • Updated TOC and the RAG documentation page to point to the new integration page.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
agent-framework/integrations/neo4j-memory.md New integration page describing Neo4j persistent memory provider usage and resources (Python pivot).
agent-framework/integrations/neo4j-graphrag.md New integration page describing Neo4j GraphRAG provider usage and resources (Python pivot).
agent-framework/integrations/index.md Adds Neo4j entries to the Memory and RAG provider tables (Python pivot).
agent-framework/agents/rag.md Links out to the Neo4j GraphRAG integration page from the RAG guidance section.
agent-framework/TOC.yml Adds Neo4j GraphRAG/Memory pages under the Integrations section.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 5ce444a:

⚠️ Validation status: warnings

File Status Preview URL Details
agent-framework/agents/providers/microsoft-foundry.md ⚠️Warning Details
agent-framework/agents/tools/code-interpreter.md ⚠️Warning Details
agent-framework/integrations/neo4j-graphrag.md 💡Suggestion Details
agent-framework/integrations/neo4j-memory.md 💡Suggestion Details
agent-framework/agents/rag.md ✅Succeeded
agent-framework/integrations/index.md ✅Succeeded
agent-framework/TOC.yml ✅Succeeded

agent-framework/agents/providers/microsoft-foundry.md

  • Line 412, Column 1: [Warning: invalid-code] The code snippet "~/../agent-framework-code/python/samples/02-agents/providers/azure_ai/azure_ai_with_reasoning.py" could not be found.
  • Line 416, Column 1: [Warning: invalid-code] The code snippet "~/../agent-framework-code/python/samples/02-agents/providers/azure_ai/azure_ai_with_content_filtering.py" could not be found.

agent-framework/agents/tools/code-interpreter.md

  • Line 132, Column 1: [Warning: invalid-code] The code snippet "~/../agent-framework-code/python/samples/02-agents/providers/azure_openai/azure_assistants_with_code_interpreter.py" could not be found.

agent-framework/integrations/neo4j-graphrag.md

  • Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.

agent-framework/integrations/neo4j-memory.md

  • Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 2a70c67:

⚠️ Validation status: warnings

File Status Preview URL Details
agent-framework/agents/providers/microsoft-foundry.md ⚠️Warning Details
agent-framework/agents/tools/code-interpreter.md ⚠️Warning Details
agent-framework/integrations/neo4j-graphrag.md 💡Suggestion Details
agent-framework/integrations/neo4j-memory.md 💡Suggestion Details
agent-framework/agents/rag.md ✅Succeeded
agent-framework/integrations/index.md ✅Succeeded
agent-framework/TOC.yml ✅Succeeded

agent-framework/agents/providers/microsoft-foundry.md

  • Line 412, Column 1: [Warning: invalid-code] The code snippet "~/../agent-framework-code/python/samples/02-agents/providers/azure_ai/azure_ai_with_reasoning.py" could not be found.
  • Line 416, Column 1: [Warning: invalid-code] The code snippet "~/../agent-framework-code/python/samples/02-agents/providers/azure_ai/azure_ai_with_content_filtering.py" could not be found.

agent-framework/agents/tools/code-interpreter.md

  • Line 132, Column 1: [Warning: invalid-code] The code snippet "~/../agent-framework-code/python/samples/02-agents/providers/azure_openai/azure_assistants_with_code_interpreter.py" could not be found.

agent-framework/integrations/neo4j-graphrag.md

  • Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.

agent-framework/integrations/neo4j-memory.md

  • Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 3c22ca9:

⚠️ Validation status: warnings

File Status Preview URL Details
agent-framework/agents/providers/microsoft-foundry.md ⚠️Warning Details
agent-framework/agents/tools/code-interpreter.md ⚠️Warning Details
agent-framework/integrations/neo4j-graphrag.md 💡Suggestion Details
agent-framework/integrations/neo4j-memory.md 💡Suggestion Details
agent-framework/agents/rag.md ✅Succeeded
agent-framework/integrations/index.md ✅Succeeded
agent-framework/TOC.yml ✅Succeeded

agent-framework/agents/providers/microsoft-foundry.md

  • Line 412, Column 1: [Warning: invalid-code] The code snippet "~/../agent-framework-code/python/samples/02-agents/providers/azure_ai/azure_ai_with_reasoning.py" could not be found.
  • Line 416, Column 1: [Warning: invalid-code] The code snippet "~/../agent-framework-code/python/samples/02-agents/providers/azure_ai/azure_ai_with_content_filtering.py" could not be found.

agent-framework/agents/tools/code-interpreter.md

  • Line 132, Column 1: [Warning: invalid-code] The code snippet "~/../agent-framework-code/python/samples/02-agents/providers/azure_openai/azure_assistants_with_code_interpreter.py" could not be found.

agent-framework/integrations/neo4j-graphrag.md

  • Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.

agent-framework/integrations/neo4j-memory.md

  • Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@westey-m westey-m merged commit ec7edd9 into MicrosoftDocs:main Apr 1, 2026
2 checks passed
learn-build-service-prod bot pushed a commit that referenced this pull request Apr 1, 2026
#361) (#935)

* Python: Adds sample documentation for two separate Neo4j context providers for retrieval and memory

* adding pypi links

* Move Neo4j integration docs from inline sections to dedicated integration pages

* Add GraphRAG section and address PR review comments



* fixing dotnet docs

* fixing dotnet docs

---------

Co-authored-by: Eduard van Valkenburg <eavanvalkenburg@users.noreply.github.com>
Co-authored-by: Evan Mattson <35585003+moonbox3@users.noreply.github.com>
Co-authored-by: westey <164392973+westey-m@users.noreply.github.com>
Co-authored-by: Dmytro Struk <13853051+dmytrostruk@users.noreply.github.com>
Co-authored-by: Ben Thomas <ben.thomas@microsoft.com>
Co-authored-by: Chris <66376200+crickman@users.noreply.github.com>
Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>
Co-authored-by: Learn Build Service GitHub App <Learn Build Service LearnBuild@microsoft.com>
Co-authored-by: Peter Ibekwe <109177538+peibekwe@users.noreply.github.com>
Co-authored-by: Ryan Knight <ryan@grandcloud.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
learn-build-service-prod bot pushed a commit that referenced this pull request Apr 1, 2026
* docs: remove comma splice in tool-approval.md

* docs: Remove duplicate codeblock in tool-approval.md

* docs: Remove duplicate code block

* fix header language

* docs: Link to topic-specific .NET sample project

* docs: move full sample link to tip

* Add fixes for overview page (#949)

* Add fixes for overview page

* Add missing import statements for python sample code

* Add C# runtime-context samples and migrate middleware docs to AIProjectClient

- Add full C# zone pivot to runtime-context.md with 4 code samples covering
  AgentRunOptions.AdditionalProperties, FunctionInvocationContext,
  AgentSession.StateBag, and cross-middleware state sharing
- Migrate all 9 middleware docs from Azure.AI.OpenAI (AzureOpenAIClient) to
  Azure.AI.Projects (AIProjectClient) with DefaultAzureCredential
- Use .GetResponsesClient().AsIChatClient() for standalone IChatClient examples
- Add DefaultAzureCredential production warning to all middleware docs

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

* fix: correct critical provider documentation issues

- copilot-studio.md: Replace non-existent CopilotStudioChatClient with
  CopilotStudioAgent, rewrite C# sample, add Python section
- index.md: Fix comparison table (OpenAI/Anthropic/GitHub Copilot MCP,
  Anthropic Code Interpreter), add Foundry Local row, add Copilot Studio
  to Python list, note both AIAgent/.NET and BaseAgent/Python base classes
- github-copilot.md: Fix PermissionRequest import path, rename thread
  variable to session for consistency
- foundry-local.md: Fix next step link to point forward to Anthropic
- microsoft-foundry.md: Fix next step link to point to Foundry Local

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

* fix: replace geopolitical term in copilot-studio example

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

* Fix doc inaccuracies in various places (#954)

* Fixes for RAG docs (#952)

* Adds sample documentation for two separate Neo4j context providers fo… (#361)

* Python: Adds sample documentation for two separate Neo4j context providers for retrieval and memory

* adding pypi links

* Move Neo4j integration docs from inline sections to dedicated integration pages

* Add GraphRAG section and address PR review comments

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fixing dotnet docs

* fixing dotnet docs

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>

* Fix for csharp declarative agent docs (#955)

---------

Co-authored-by: Learn Build Service GitHub App <Learn Build Service LearnBuild@microsoft.com>
Co-authored-by: Jacob Alber <jaalber@microsoft.com>
Co-authored-by: Jacob Alber <jacob.alber@microsoft.com>
Co-authored-by: Roger Barreto <19890735+rogerbarreto@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Giles Odigwe <gilesodigwe@microsoft.com>
Co-authored-by: Tao Chen <taochen@microsoft.com>
Co-authored-by: Giles Odigwe <79032838+giles17@users.noreply.github.com>
Co-authored-by: Ryan Knight <ryan@grandcloud.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Co-authored-by: Eduard van Valkenburg <eavanvalkenburg@users.noreply.github.com>
Co-authored-by: Evan Mattson <35585003+moonbox3@users.noreply.github.com>
Co-authored-by: Dmytro Struk <13853051+dmytrostruk@users.noreply.github.com>
Co-authored-by: Ben Thomas <ben.thomas@microsoft.com>
Co-authored-by: Chris <66376200+crickman@users.noreply.github.com>
Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>
Co-authored-by: Peter Ibekwe <109177538+peibekwe@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