chore: import upstream snapshot with attribution
This commit is contained in:
wehub-resource-sync
@@ -0,0 +1,310 @@
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
using System.Text;
|
||||
using Microsoft.Extensions.AI;
|
||||
using Microsoft.SemanticKernel;
|
||||
using Microsoft.SemanticKernel.ChatCompletion;
|
||||
using OllamaSharp;
|
||||
|
||||
namespace ChatCompletion;
|
||||
|
||||
/// <summary>
|
||||
/// These examples demonstrate different ways of using chat completion with Ollama API.
|
||||
/// </summary>
|
||||
public class Ollama_ChatCompletionStreaming(ITestOutputHelper output) : BaseTest(output)
|
||||
{
|
||||
/// <summary>
|
||||
/// This example demonstrates chat completion streaming using <see cref="IChatClient"/> directly.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task UsingChatClientStreaming()
|
||||
{
|
||||
Assert.NotNull(TestConfiguration.Ollama.ModelId);
|
||||
|
||||
Console.WriteLine($"======== Ollama - Chat Completion - {nameof(UsingChatClientStreaming)} ========");
|
||||
|
||||
using IChatClient ollamaClient = new OllamaApiClient(
|
||||
uriString: TestConfiguration.Ollama.Endpoint,
|
||||
defaultModel: TestConfiguration.Ollama.ModelId);
|
||||
|
||||
Console.WriteLine("Chat content:");
|
||||
Console.WriteLine("------------------------");
|
||||
|
||||
List<ChatMessage> chatHistory = [new ChatMessage(ChatRole.System, "You are a librarian, expert about books")];
|
||||
this.OutputLastMessage(chatHistory);
|
||||
|
||||
// First user message
|
||||
chatHistory.Add(new(ChatRole.User, "Hi, I'm looking for book suggestions"));
|
||||
this.OutputLastMessage(chatHistory);
|
||||
|
||||
// First assistant message
|
||||
await StreamChatClientMessageOutputAsync(ollamaClient, chatHistory);
|
||||
|
||||
// Second user message
|
||||
chatHistory.Add(new(Microsoft.Extensions.AI.ChatRole.User, "I love history and philosophy, I'd like to learn something new about Greece, any suggestion?"));
|
||||
this.OutputLastMessage(chatHistory);
|
||||
|
||||
// Second assistant message
|
||||
await StreamChatClientMessageOutputAsync(ollamaClient, chatHistory);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// This example demonstrates chat completion streaming using <see cref="IChatCompletionService"/> directly.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task UsingChatCompletionServiceStreamingWithOllama()
|
||||
{
|
||||
Assert.NotNull(TestConfiguration.Ollama.ModelId);
|
||||
|
||||
Console.WriteLine($"======== Ollama - Chat Completion - {nameof(UsingChatCompletionServiceStreamingWithOllama)} ========");
|
||||
|
||||
using var ollamaClient = new OllamaApiClient(
|
||||
uriString: TestConfiguration.Ollama.Endpoint,
|
||||
defaultModel: TestConfiguration.Ollama.ModelId);
|
||||
|
||||
var chatService = ollamaClient.AsChatCompletionService();
|
||||
|
||||
Console.WriteLine("Chat content:");
|
||||
Console.WriteLine("------------------------");
|
||||
|
||||
var chatHistory = new ChatHistory("You are a librarian, expert about books");
|
||||
this.OutputLastMessage(chatHistory);
|
||||
|
||||
// First user message
|
||||
chatHistory.AddUserMessage("Hi, I'm looking for book suggestions");
|
||||
this.OutputLastMessage(chatHistory);
|
||||
|
||||
// First assistant message
|
||||
await StreamMessageOutputAsync(chatService, chatHistory, AuthorRole.Assistant);
|
||||
|
||||
// Second user message
|
||||
chatHistory.AddUserMessage("I love history and philosophy, I'd like to learn something new about Greece, any suggestion?");
|
||||
this.OutputLastMessage(chatHistory);
|
||||
|
||||
// Second assistant message
|
||||
await StreamMessageOutputAsync(chatService, chatHistory, AuthorRole.Assistant);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// This example demonstrates retrieving underlying OllamaSharp library information through <see cref="IChatClient" /> streaming raw representation (breaking glass) approach.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This is a breaking glass scenario and is more susceptible to break on newer versions of OllamaSharp library.
|
||||
/// </remarks>
|
||||
[Fact]
|
||||
public async Task UsingChatClientStreamingRawContentsWithOllama()
|
||||
{
|
||||
Assert.NotNull(TestConfiguration.Ollama.ModelId);
|
||||
|
||||
Console.WriteLine($"======== Ollama - Chat Completion - {nameof(UsingChatClientStreamingRawContentsWithOllama)} ========");
|
||||
|
||||
using IChatClient ollamaClient = new OllamaApiClient(
|
||||
uriString: TestConfiguration.Ollama.Endpoint,
|
||||
defaultModel: TestConfiguration.Ollama.ModelId);
|
||||
|
||||
Console.WriteLine("Chat content:");
|
||||
Console.WriteLine("------------------------");
|
||||
|
||||
List<ChatMessage> chatHistory = [new ChatMessage(ChatRole.System, "You are a librarian, expert about books")];
|
||||
this.OutputLastMessage(chatHistory);
|
||||
|
||||
// First user message
|
||||
chatHistory.Add(new(ChatRole.User, "Hi, I'm looking for book suggestions"));
|
||||
this.OutputLastMessage(chatHistory);
|
||||
|
||||
await foreach (var chatUpdate in ollamaClient.GetStreamingResponseAsync(chatHistory))
|
||||
{
|
||||
var rawRepresentation = chatUpdate.RawRepresentation as OllamaSharp.Models.Chat.ChatResponseStream;
|
||||
OutputOllamaSharpContent(rawRepresentation!);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Demonstrates how you can template a chat history call while using the <see cref="Kernel"/> for invocation.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task UsingKernelChatPromptStreaming()
|
||||
{
|
||||
Assert.NotNull(TestConfiguration.Ollama.ModelId);
|
||||
|
||||
Console.WriteLine($"======== Ollama - Chat Completion - {nameof(UsingKernelChatPromptStreaming)} ========");
|
||||
|
||||
StringBuilder chatPrompt = new("""
|
||||
<message role="system">You are a librarian, expert about books</message>
|
||||
<message role="user">Hi, I'm looking for book suggestions</message>
|
||||
""");
|
||||
|
||||
var kernel = Kernel.CreateBuilder()
|
||||
.AddOllamaChatClient(
|
||||
endpoint: new Uri(TestConfiguration.Ollama.Endpoint),
|
||||
modelId: TestConfiguration.Ollama.ModelId)
|
||||
.Build();
|
||||
|
||||
var reply = await StreamMessageOutputFromKernelAsync(kernel, chatPrompt.ToString());
|
||||
|
||||
chatPrompt.AppendLine($"<message role=\"assistant\"><![CDATA[{reply}]]></message>");
|
||||
chatPrompt.AppendLine("<message role=\"user\">I love history and philosophy, I'd like to learn something new about Greece, any suggestion</message>");
|
||||
|
||||
reply = await StreamMessageOutputFromKernelAsync(kernel, chatPrompt.ToString());
|
||||
|
||||
Console.WriteLine(reply);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// This example demonstrates retrieving underlying library information through chat completion streaming inner contents.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This is a breaking glass scenario and is more susceptible to break on newer versions of OllamaSharp library.
|
||||
/// </remarks>
|
||||
[Fact]
|
||||
public async Task UsingKernelChatPromptStreamingRawRepresentation()
|
||||
{
|
||||
Assert.NotNull(TestConfiguration.Ollama.ModelId);
|
||||
|
||||
Console.WriteLine($"======== Ollama - Chat Completion - {nameof(UsingKernelChatPromptStreamingRawRepresentation)} ========");
|
||||
|
||||
StringBuilder chatPrompt = new("""
|
||||
<message role="system">You are a librarian, expert about books</message>
|
||||
<message role="user">Hi, I'm looking for book suggestions</message>
|
||||
""");
|
||||
|
||||
var kernel = Kernel.CreateBuilder()
|
||||
.AddOllamaChatClient(
|
||||
endpoint: new Uri(TestConfiguration.Ollama.Endpoint),
|
||||
modelId: TestConfiguration.Ollama.ModelId)
|
||||
.Build();
|
||||
|
||||
var reply = await StreamMessageOutputFromKernelAsync(kernel, chatPrompt.ToString());
|
||||
|
||||
chatPrompt.AppendLine($"<message role=\"assistant\"><![CDATA[{reply}]]></message>");
|
||||
chatPrompt.AppendLine("<message role=\"user\">I love history and philosophy, I'd like to learn something new about Greece, any suggestion</message>");
|
||||
|
||||
await foreach (var chatUpdate in kernel.InvokePromptStreamingAsync<StreamingChatMessageContent>(chatPrompt.ToString()))
|
||||
{
|
||||
var innerContent = chatUpdate.InnerContent as OllamaSharp.Models.Chat.ChatResponseStream;
|
||||
OutputOllamaSharpContent(innerContent!);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// This example demonstrates how the chat completion service streams text content.
|
||||
/// It shows how to access the response update via StreamingChatMessageContent.Content property
|
||||
/// and alternatively via the StreamingChatMessageContent.Items property.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task UsingStreamingTextFromChatCompletion()
|
||||
{
|
||||
Assert.NotNull(TestConfiguration.Ollama.ModelId);
|
||||
|
||||
Console.WriteLine($"======== Ollama - Chat Completion - {nameof(UsingStreamingTextFromChatCompletion)} ========");
|
||||
|
||||
using var ollamaClient = new OllamaApiClient(
|
||||
uriString: TestConfiguration.Ollama.Endpoint,
|
||||
defaultModel: TestConfiguration.Ollama.ModelId);
|
||||
|
||||
// Create chat completion service
|
||||
var chatService = ollamaClient.AsChatCompletionService();
|
||||
|
||||
// Create chat history with initial system and user messages
|
||||
ChatHistory chatHistory = new("You are a librarian, an expert on books.");
|
||||
chatHistory.AddUserMessage("Hi, I'm looking for book suggestions.");
|
||||
chatHistory.AddUserMessage("I love history and philosophy. I'd like to learn something new about Greece, any suggestion?");
|
||||
|
||||
// Start streaming chat based on the chat history
|
||||
await foreach (StreamingChatMessageContent chatUpdate in chatService.GetStreamingChatMessageContentsAsync(chatHistory))
|
||||
{
|
||||
// Access the response update via StreamingChatMessageContent.Content property
|
||||
Console.Write(chatUpdate.Content);
|
||||
|
||||
// Alternatively, the response update can be accessed via the StreamingChatMessageContent.Items property
|
||||
Console.Write(chatUpdate.Items.OfType<StreamingTextContent>().FirstOrDefault());
|
||||
}
|
||||
}
|
||||
|
||||
private async Task<string> StreamMessageOutputFromKernelAsync(Kernel kernel, string prompt)
|
||||
{
|
||||
bool roleWritten = false;
|
||||
string fullMessage = string.Empty;
|
||||
|
||||
await foreach (var chatUpdate in kernel.InvokePromptStreamingAsync<StreamingChatMessageContent>(prompt))
|
||||
{
|
||||
if (!roleWritten && chatUpdate.Role.HasValue)
|
||||
{
|
||||
Console.Write($"{chatUpdate.Role.Value}: {chatUpdate.Content}");
|
||||
roleWritten = true;
|
||||
}
|
||||
|
||||
if (chatUpdate.Content is { Length: > 0 })
|
||||
{
|
||||
fullMessage += chatUpdate.Content;
|
||||
Console.Write(chatUpdate.Content);
|
||||
}
|
||||
}
|
||||
|
||||
Console.WriteLine("\n------------------------");
|
||||
return fullMessage;
|
||||
}
|
||||
|
||||
private async Task StreamChatClientMessageOutputAsync(IChatClient chatClient, List<ChatMessage> chatHistory)
|
||||
{
|
||||
bool roleWritten = false;
|
||||
string fullMessage = string.Empty;
|
||||
List<ChatResponseUpdate> chatUpdates = [];
|
||||
await foreach (var chatUpdate in chatClient.GetStreamingResponseAsync(chatHistory))
|
||||
{
|
||||
chatUpdates.Add(chatUpdate);
|
||||
if (!roleWritten && !string.IsNullOrEmpty(chatUpdate.Text))
|
||||
{
|
||||
Console.Write($"Assistant: {chatUpdate.Text}");
|
||||
roleWritten = true;
|
||||
}
|
||||
else if (!string.IsNullOrEmpty(chatUpdate.Text))
|
||||
{
|
||||
Console.Write(chatUpdate.Text);
|
||||
}
|
||||
}
|
||||
|
||||
Console.WriteLine("\n------------------------");
|
||||
chatHistory.AddRange(chatUpdates.ToChatResponse().Messages);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Retrieve extra information from each streaming chunk response.
|
||||
/// </summary>
|
||||
/// <param name="streamChunk">Streaming chunk provided as inner content of a streaming chat message</param>
|
||||
/// <remarks>
|
||||
/// This is a breaking glass scenario, any attempt on running with different versions of OllamaSharp library that introduces breaking changes
|
||||
/// may cause breaking changes in the code below.
|
||||
/// </remarks>
|
||||
private void OutputOllamaSharpContent(OllamaSharp.Models.Chat.ChatResponseStream streamChunk)
|
||||
{
|
||||
Console.WriteLine($$"""
|
||||
Model: {{streamChunk.Model}}
|
||||
Message role: {{streamChunk.Message.Role}}
|
||||
Message content: {{streamChunk.Message.Content}}
|
||||
Created at: {{streamChunk.CreatedAt}}
|
||||
Done: {{streamChunk.Done}}
|
||||
""");
|
||||
|
||||
/// The last message in the chunk is a <see cref="OllamaSharp.Models.Chat.ChatDoneResponseStream"/> type with additional metadata.
|
||||
if (streamChunk is OllamaSharp.Models.Chat.ChatDoneResponseStream doneStream)
|
||||
{
|
||||
Console.WriteLine($$"""
|
||||
Done Reason: {{doneStream.DoneReason}}
|
||||
Eval count: {{doneStream.EvalCount}}
|
||||
Eval duration: {{doneStream.EvalDuration}}
|
||||
Load duration: {{doneStream.LoadDuration}}
|
||||
Total duration: {{doneStream.TotalDuration}}
|
||||
Prompt eval count: {{doneStream.PromptEvalCount}}
|
||||
Prompt eval duration: {{doneStream.PromptEvalDuration}}
|
||||
""");
|
||||
}
|
||||
Console.WriteLine("------------------------");
|
||||
}
|
||||
|
||||
private void OutputLastMessage(List<ChatMessage> chatHistory)
|
||||
{
|
||||
var message = chatHistory.Last();
|
||||
Console.WriteLine($"{message.Role}: {message.Text}");
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user