General freshness update for AI docs #50541
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR performs a general freshness update for the AI documentation, with the main focus on breaking out the IChatClient and IEmbeddingGenerator interfaces into separate dedicated articles. This reorganization improves the documentation structure by making it easier for developers to find specific interface documentation.
Key changes include:
- Creation of two new standalone articles (
ichatclient.mdandiembeddinggenerator.md) with comprehensive usage examples and implementation guidance - Updated TOC structure to reflect the new organization under Microsoft.Extensions.AI
- Package version updates removing prerelease flags for several stable packages
- Addition of sample implementation code files for both interfaces
- Redirection configuration for the removed
sample-implementations.mdfile
Reviewed changes
Copilot reviewed 17 out of 21 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/ai/toc.yml | Restructures Microsoft.Extensions.AI section to include separate entries for IChatClient and IEmbeddingGenerator interfaces; reorders API reference section; removes Advanced section |
| docs/ai/ichatclient.md | New standalone article providing comprehensive coverage of the IChatClient interface with examples for responses, streaming, tool calling, caching, telemetry, options, pipelines, middleware, dependency injection, stateless/stateful clients, and implementation examples |
| docs/ai/iembeddinggenerator.md | New standalone article covering the IEmbeddingGenerator interface with examples for creating embeddings, pipelines, and implementation guidance |
| docs/ai/snippets/sample-implementations/SampleChatClient.cs | New sample implementation of IChatClient demonstrating basic structure with metadata, response generation, and streaming |
| docs/ai/snippets/sample-implementations/SampleEmbeddingGenerator.cs | New sample implementation of IEmbeddingGenerator showing basic embedding generation structure |
| docs/ai/snippets/sample-implementations/Implementations.csproj | Project file for sample implementations targeting .NET 9.0 with Microsoft.Extensions.AI.Abstractions reference |
| docs/ai/microsoft-extensions-ai.md | Refactored to provide overview and links to dedicated interface articles; removes detailed examples now covered in separate articles |
| docs/ai/index.yml | Updates landing page with refreshed content links in Essential Concepts and Training sections; updates date to 12/10/2025 |
| docs/ai/overview.md | Updates date to 12/10/2025 |
| docs/ai/quickstarts/create-assistant.md | Removes --prerelease flag from OpenAI package installation |
| docs/ai/quickstarts/build-vector-search-app.md | Removes --prerelease flag from Microsoft.Extensions.VectorData.Abstractions package; removes preview note |
| docs/ai/evaluation/evaluate-safety.md | Removes --prerelease flags from Microsoft.Extensions.AI packages that are now stable |
| docs/ai/dotnet-ai-ecosystem.md | Adds section about other AI-related Microsoft.Extensions libraries (VectorData and DataIngestion); removes vector databases section; updates date |
| docs/ai/conceptual/vector-databases.md | Renames section heading to "Semantic Kernel vector database solutions"; updates include reference to sk-connectors.md |
| docs/ai/conceptual/rag.md | Updates section heading from "Related content" to "See also"; changes link to data-ingestion.md; updates date and removes customer intent comment |
| docs/ai/conceptual/embeddings.md | Updates internal link reference to match renamed section in vector-databases.md |
| docs/ai/conceptual/data-ingestion.md | Fixes typo in line 113 changing "Vectore stores" to "Vector stores" |
| docs/ai/conceptual/agents.md | Adds "Magentic" orchestration pattern to the list; updates date; reformats final paragraph |
| docs/ai/includes/sk-connectors.md | New include file containing table of Semantic Kernel vector database connectors |
| docs/ai/advanced/sample-implementations.md | File removed (content moved to separate interface articles) |
| .openpublishing.redirection.ai.json | Adds redirection from removed sample-implementations.md to ichatclient.md |
meaghanlewis
approved these changes
Dec 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #50540
Internal previews
Toggle expand/collapse