Beef up MEVD docs: expanded conceptual article, new how-to guide, and working code snippets#51846
Beef up MEVD docs: expanded conceptual article, new how-to guide, and working code snippets#51846
Conversation
…how-to, new TOC section Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
|
@copilot I added learn.microsoft.com to your allow list. Can you try to access the docs you need to port over to this repo? |
…ybrid search, record definitions, more connectors Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
Accessed the SK vector store docs at learn.microsoft.com and ported relevant content. Commit
All code samples compile and run against the real |
docs/ai/how-to/snippets/use-vector-stores/csharp/VectorStoresExamples/.gitignore
Outdated
Show resolved
Hide resolved
|
@copilot please respond to all feedback |
…tignore, fix TOC duplicate, update intro sentence Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
All feedback addressed in
|
…rtAsync, GetAsync, VectorSearchOptions Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
All feedback addressed in |
There was a problem hiding this comment.
Pull request overview
This PR significantly expands the vector database documentation for .NET AI applications by adding comprehensive coverage of the Microsoft.Extensions.VectorData library. The changes transform a brief conceptual overview into detailed documentation with working code examples, covering both conceptual understanding and practical implementation.
Changes:
- Expanded the vector databases conceptual article with detailed coverage of the Microsoft.Extensions.VectorData library, including API examples, data modeling patterns, and a complete list of available connectors
- Created a new how-to guide for using vector stores with step-by-step instructions for common operations like upserting, searching, and filtering
- Added a complete, compilable C# snippet project with working code examples demonstrating all major features
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/ai/toc.yml | Reorganized TOC to create a new "Vector stores" top-level section containing both the conceptual overview and how-to guide |
| docs/ai/conceptual/vector-databases.md | Expanded from a brief overview to comprehensive conceptual documentation covering MEVD library features, data models, search patterns, and available connectors |
| docs/ai/how-to/use-vector-stores.md | New how-to guide with detailed step-by-step instructions for all vector store operations including CRUD, search, filtering, and hybrid search |
| docs/ai/how-to/snippets/use-vector-stores/csharp/VectorStoresExamples/VectorStoresExamples.csproj | Project file targeting net10.0 with required vector store dependencies |
| docs/ai/how-to/snippets/use-vector-stores/csharp/VectorStoresExamples/Hotel.cs | Data model example demonstrating vector store attributes |
| docs/ai/how-to/snippets/use-vector-stores/csharp/VectorStoresExamples/Program.cs | Main demonstration code with snippets for all basic operations |
| docs/ai/how-to/snippets/use-vector-stores/csharp/VectorStoresExamples/RecordDefinition.cs | Example of programmatic schema definition without attributes |
| docs/ai/how-to/snippets/use-vector-stores/csharp/VectorStoresExamples/AutoEmbedding.cs | Example of automatic embedding generation feature |
|
@gewarren great to see this! Just want to make sure you're aware of the vector store section in the Semantic Kernel docs (the entire section, not just that page). These are pretty high-quality docs that will go away as part of this effort, with their contents merged into the .NET docs you're working on. At least some of this content can simply be moved as-is, others can at least be a source for Copilot. Let me know your thoughts... BTW I'm nearing the end of my coding work on MEVD, and am definitely happy to be involved in the docs side of things, as a reviewer or anything else that might be helpful. |
BillWagner
left a comment
There was a problem hiding this comment.
This looks great @gewarren
I had a few questions on the code to consider.
docs/ai/vector-stores/how-to/snippets/VectorStoresExamples/AutoEmbedding.cs
Outdated
Show resolved
Hide resolved
docs/ai/vector-stores/how-to/snippets/VectorStoresExamples/AutoEmbedding.cs
Outdated
Show resolved
Hide resolved
docs/ai/vector-stores/how-to/snippets/VectorStoresExamples/Hotel.cs
Outdated
Show resolved
Hide resolved
docs/ai/vector-stores/how-to/snippets/VectorStoresExamples/Program.cs
Outdated
Show resolved
Hide resolved
I will add the remainder of the docs - didn't catch that Copilot hadn't done that. |
docs/ai/conceptual/vector-databases.mdwith MEVD API concepts and code samplesdocs/ai/how-to/use-vector-stores.mdhow-to guide with working code samples and snippet filesdocs/ai/how-to/snippets/use-vector-stores/csharp/VectorStoresExamples/docs/ai/toc.ymlto add a new "Vector stores" top-level sectionGetCollection<TKey, TRecord>to use<xref:Microsoft.Extensions.VectorData.VectorStore.GetCollection*>UpsertAsyncto use<xref:Microsoft.Extensions.VectorData.VectorStoreCollection\2.UpsertAsync*>`GetAsyncmentions to use<xref:Microsoft.Extensions.VectorData.VectorStoreCollection\2.GetAsync*>`VectorSearchOptions<TRecord>to use<xref:Microsoft.Extensions.VectorData.VectorSearchOptions\1>`Original prompt
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.
Internal previews
Toggle expand/collapse