Add sample IChatClient and IEmbeddingGenerator implementations #46482
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
Rageking8
reviewed
May 30, 2025
Co-authored-by: Rageking8 <106309953+Rageking8@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR adds real-world OllamaApiClient examples and dedicated sample implementations for IChatClient and IEmbeddingGenerator.
- Swapped out
SampleChatClientandSampleEmbeddingGeneratorin most snippets forOllamaApiClientand added theOllamaSharppackage reference. - Introduced a new
sample-implementations.mdarticle with concrete IChatClient and IEmbeddingGenerator examples underdocs/ai/advanced. - Updated the main Microsoft.Extensions.AI docs to link to the new advanced sample implementations.
Reviewed Changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/ai/snippets/microsoft-extensions-ai/ConsoleAI.UseTelemetry/ConsoleAI.UseTelemetry.csproj | Added OllamaSharp package reference |
| docs/ai/snippets/microsoft-extensions-ai/ConsoleAI.GetStreamingResponseAsync/Program.cs | Replaced SampleChatClient with OllamaApiClient; added using OllamaSharp |
| docs/ai/snippets/microsoft-extensions-ai/ConsoleAI.GetStreamingResponseAsync/ConsoleAI.GetStreamingResponseAsync.csproj | Added OllamaSharp package reference |
| docs/ai/snippets/microsoft-extensions-ai/ConsoleAI.GetResponseAsyncArgs/Program.cs | Replaced SampleChatClient with OllamaApiClient; added using OllamaSharp |
| docs/ai/snippets/microsoft-extensions-ai/ConsoleAI.GetResponseAsyncArgs/ConsoleAI.GetResponseAsyncArgs.csproj | Added OllamaSharp package reference |
| docs/ai/snippets/microsoft-extensions-ai/ConsoleAI.CustomEmbeddingsMiddle/Program.cs | Replaced SampleEmbeddingGenerator with OllamaApiClient; added using OllamaSharp |
| docs/ai/snippets/microsoft-extensions-ai/ConsoleAI.CustomEmbeddingsMiddle/ConsoleAI.CustomEmbeddingsMiddle.csproj | Added OllamaSharp package reference |
| docs/ai/snippets/microsoft-extensions-ai/ConsoleAI.CreateEmbeddings/Program.cs | Replaced SampleEmbeddingGenerator with OllamaApiClient; added using OllamaSharp |
| docs/ai/snippets/microsoft-extensions-ai/ConsoleAI.CreateEmbeddings/ConsoleAI.CreateEmbeddings.csproj | Added OllamaSharp package reference |
| docs/ai/snippets/microsoft-extensions-ai/ConsoleAI.ConsumeRateLimitingEmbedding/Program.cs | Replaced SampleEmbeddingGenerator with OllamaApiClient; added using OllamaSharp |
| docs/ai/snippets/microsoft-extensions-ai/ConsoleAI.ConsumeRateLimitingEmbedding/ConsoleAI.ConsumeRateLimitingEmbedding.csproj | Added OllamaSharp package reference |
| docs/ai/snippets/microsoft-extensions-ai/ConsoleAI.ConsumeClientMiddleware/Program.cs | Replaced builder sample with OllamaApiClient; added using OllamaSharp |
| docs/ai/snippets/microsoft-extensions-ai/ConsoleAI.ConsumeClientMiddleware/ConsoleAI.ConsumeClientMiddleware.csproj | Added OllamaSharp package reference |
| docs/ai/snippets/microsoft-extensions-ai/ConsoleAI.AddMessages/Program.cs | Replaced SampleChatClient with OllamaApiClient; added using OllamaSharp |
| docs/ai/snippets/microsoft-extensions-ai/ConsoleAI.AddMessages/ConsoleAI.AddMessages.csproj | Added OllamaSharp package reference |
| docs/ai/microsoft-extensions-ai.md | Updated links to point at the new advanced sample-implementations article |
| docs/ai/advanced/snippets/sample-implementations/SampleEmbeddingGenerator.cs | Modified return expression to use C# collection syntax |
| docs/ai/advanced/snippets/sample-implementations/SampleChatClient.cs | Reformatted constructor signature and property initializer |
| docs/ai/advanced/snippets/sample-implementations/Implementations.csproj | Added new project file for sample implementations |
| docs/ai/advanced/sample-implementations.md | Added new article with sample IChatClient and IEmbeddingGenerator code |
Comments suppressed due to low confidence (2)
docs/ai/snippets/microsoft-extensions-ai/ConsoleAI.AddMessages/Program.cs:8
- Assigning an empty array literal
[]to a List will not compile. Initialize the list explicitly usingnew List<ChatMessage>()or use a collection expression that returns a List, e.g.:var history = new List<ChatMessage>();
List<ChatMessage> history = [];
docs/ai/advanced/snippets/sample-implementations/SampleEmbeddingGenerator.cs:19
- The return statement uses a C# collection expression instead of instantiating the GeneratedEmbeddings<Embedding> object. This will not compile since the method signature expects a GeneratedEmbeddings<Embedding>. You should wrap the array in the constructor, e.g.:
return new GeneratedEmbeddings<Embedding<float>>(values.Select(v => new Embedding<float>(Enumerable.Range(0,384).Select(_ => Random.Shared.NextSingle()).ToArray())));
return [.. from value in values
BillWagner
approved these changes
Jun 10, 2025
There was a problem hiding this comment.
This LGTM @gewarren
You can 
once you and the product team are happy.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Contributes to #46047.
Internal previews