Adds sample documentation for two separate Neo4j context providers fo…#361
Adds sample documentation for two separate Neo4j context providers fo…#361retroryan wants to merge 3 commits intoMicrosoftDocs:mainfrom
Conversation
|
Learn Build status updates of commit 0791fe1: ✅ Validation status: passed
For more details, please refer to the build report. |
|
Learn Build status updates of commit ab91b57: ✅ Validation status: passed
For more details, please refer to the build report. |
|
Learn Build status updates of commit 67cb43e:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| semantic-kernel/concepts/vector-store-connectors/index.md | Details | ||
| semantic-kernel/Frameworks/agent/TOC.yml | 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 status updates of commit 4c16798: ✅ Validation status: passed
For more details, please refer to the build report. |
retroryan
force-pushed
the
docs/neo4j-context-provider
branch
from
4c16798 to
2f41998
Compare
|
Learn Build status updates of commit 2f41998: ✅ Validation status: passed
For more details, please refer to the build report. |
retroryan
force-pushed
the
docs/neo4j-context-provider
branch
from
2f41998 to
8ba2b9e
Compare
|
Learn Build status updates of commit 8ba2b9e: ✅ Validation status: passed
For more details, please refer to the build report. |
|
Learn Build status updates of commit a02e153: ✅ Validation status: passed
For more details, please refer to the build report. |
| ) | ||
| ``` | ||
|
|
||
| #### Neo4j Memory Provider |
There was a problem hiding this comment.
Instead of having these directly in the user-guide, they should really be under integrations.
See e.g. https://learn.microsoft.com/en-us/agent-framework/integrations/?pivots=programming-language-python, where the list of integrations can be updated, and then we can have a specific page for the memory provider and RAG provider that lists it's features and usage examples.
There was a problem hiding this comment.
@westey-m - How do I get these integrations added to that page? Is there a repo I can create a PR in?
There was a problem hiding this comment.
@retroryan, that is part of this repo as well. Make sure to sync the latest updates from this repo, and you should see it at: https://github.com/MicrosoftDocs/semantic-kernel-docs/blob/main/agent-framework/integrations/index.md
This repo is a mirror, and I recently synced the latest updates into here, so you probably didn't get it as part of your fork yet.
There was a problem hiding this comment.
@westey-m Done. I've synced upstream, rebased, and restructured the PR to follow the integrations pattern. Let me know if this is correct or if you need any other changes. Here is what I did
- Created dedicated pages at
integrations/neo4j-graphrag.mdandintegrations/neo4j-memory.mdwith prerequisites, usage examples, and resource links - Added Neo4j entries to the provider tables in
integrations/index.md - Added TOC entries under Integrations
- Removed the inline sections from the general concept pages
The build flagged ms.author: ryanknight as not a valid Microsoft alias. Not sure what alias should I use for partner-contributed integration pages?
…iders for retrieval and memory
retroryan
force-pushed
the
docs/neo4j-context-provider
branch
from
a02e153 to
a79eec4
Compare
|
Learn Build status updates of commit a79eec4:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| Details | |||
| agent-framework/agents/providers/microsoft-foundry.md | Details | ||
| agent-framework/agents/rag.md | Details | ||
| agent-framework/agents/tools/code-interpreter.md | 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 status updates of commit 96cdd2f:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| agent-framework/agents/providers/microsoft-foundry.md | Details | ||
| agent-framework/agents/tools/code-interpreter.md | 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.
2 participants
Summary
Adds dedicated integration pages for two Neo4j context providers for Agent Framework. These providers serve distinct roles in the agent architecture:
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 enrichmentintegrations/neo4j-memory.md) — Read-write memory provider that stores conversations, extracts entities into a knowledge graph, and learns user preferences across sessionsAddresses 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
agent-framework/integrations/neo4j-graphrag.md— GraphRAG provider: graph-enhanced RAG with vector, fulltext, and hybrid searchagent-framework/integrations/neo4j-memory.md— Memory provider: persistent agent memory with knowledge graph building and memory toolsagent-framework/integrations/index.md— Added Neo4j to Memory and RAG provider tables (Python pivot)agent-framework/TOC.yml— Added sidebar entries under Integrations sectionagent-framework/agents/rag.md— Replaced inline Neo4j section with link to integration pageagent-framework/user-guide/agents/agent-memory.md— Removed orphaned file from old directory structureLinks
Build notes
The two suggestions on our files are expected:
ms.author: ryanknightis not a valid Microsoft alias — happy to update to whichever alias owns the integrations sectionThe two warnings on
microsoft-foundry.mdandcode-interpreter.mdare pre-existing and unrelated to this PR.