Files
microsoft--semantic-kernel/dotnet/samples/Concepts/ChatCompletion/AzureOpenAI_ChatCompletionWithReasoning.cs
T
wehub-resource-sync b957a53def
CodeQL / Analyze (csharp) (push) Waiting to run
CodeQL / Analyze (python) (push) Waiting to run
chore: import upstream snapshot with attribution
2026-07-13 13:21:23 +08:00

103 lines
4.6 KiB
C#

// Copyright (c) Microsoft. All rights reserved.
using System.Text;
using Microsoft.SemanticKernel;
using Microsoft.SemanticKernel.ChatCompletion;
using Microsoft.SemanticKernel.Connectors.AzureOpenAI;
using OpenAI.Chat;
namespace ChatCompletion;
/// <summary>
/// These examples demonstrate different ways of using chat completion reasoning models with Azure OpenAI API.
/// </summary>
public class AzureOpenAI_ChatCompletionWithReasoning(ITestOutputHelper output) : BaseTest(output)
{
/// <summary>
/// Sample showing how to use <see cref="Kernel"/> with chat completion and chat prompt syntax.
/// </summary>
[Fact]
public async Task ChatPromptWithReasoningAsync()
{
Console.WriteLine("======== Azure Open AI - Chat Completion with Reasoning ========");
Assert.NotNull(TestConfiguration.AzureOpenAI.ChatDeploymentName);
Assert.NotNull(TestConfiguration.AzureOpenAI.Endpoint);
Assert.NotNull(TestConfiguration.AzureOpenAI.ApiKey);
var kernel = Kernel.CreateBuilder()
.AddAzureOpenAIChatCompletion(
deploymentName: TestConfiguration.AzureOpenAI.ChatDeploymentName,
endpoint: TestConfiguration.AzureOpenAI.Endpoint,
apiKey: TestConfiguration.AzureOpenAI.ApiKey,
modelId: TestConfiguration.AzureOpenAI.ChatModelId)
.Build();
// Create execution settings with high reasoning effort.
var executionSettings = new AzureOpenAIPromptExecutionSettings //OpenAIPromptExecutionSettings
{
// Flags Azure SDK to use the new token property.
SetNewMaxCompletionTokensEnabled = true,
MaxTokens = 2000,
// Note: reasoning effort is only available for reasoning models (at this moment o3-mini & o1 models)
ReasoningEffort = ChatReasoningEffortLevel.Low
};
// Create KernelArguments using the execution settings.
var kernelArgs = new KernelArguments(executionSettings);
StringBuilder chatPrompt = new("""
<message role="developer">You are an expert software engineer, specialized in the Semantic Kernel SDK and NET framework</message>
<message role="user">Hi, Please craft me an example code in .NET using Semantic Kernel that implements a chat loop .</message>
""");
// Invoke the prompt with high reasoning effort.
var reply = await kernel.InvokePromptAsync(chatPrompt.ToString(), kernelArgs);
Console.WriteLine(reply);
}
/// <summary>
/// Sample showing how to use <see cref="IChatCompletionService"/> directly with a <see cref="ChatHistory"/>.
/// </summary>
[Fact]
public async Task ServicePromptWithReasoningAsync()
{
Console.WriteLine("======== Azure Open AI - Chat Completion with Azure Default Credential with Reasoning ========");
Assert.NotNull(TestConfiguration.AzureOpenAI.ChatDeploymentName);
Assert.NotNull(TestConfiguration.AzureOpenAI.Endpoint);
Assert.NotNull(TestConfiguration.AzureOpenAI.ApiKey);
IChatCompletionService chatCompletionService = new AzureOpenAIChatCompletionService(
deploymentName: TestConfiguration.AzureOpenAI.ChatDeploymentName,
endpoint: TestConfiguration.AzureOpenAI.Endpoint,
apiKey: TestConfiguration.AzureOpenAI.ApiKey,
modelId: TestConfiguration.AzureOpenAI.ChatModelId);
// Create execution settings with high reasoning effort.
var executionSettings = new AzureOpenAIPromptExecutionSettings
{
// Flags Azure SDK to use the new token property.
SetNewMaxCompletionTokensEnabled = true,
MaxTokens = 2000,
// Note: reasoning effort is only available for reasoning models (at this moment o3-mini & o1 models)
ReasoningEffort = ChatReasoningEffortLevel.Low
};
// Create a ChatHistory and add messages.
var chatHistory = new ChatHistory();
chatHistory.AddDeveloperMessage(
"You are an expert software engineer, specialized in the Semantic Kernel SDK and .NET framework.");
chatHistory.AddUserMessage(
"Hi, Please craft me an example code in .NET using Semantic Kernel that implements a chat loop.");
// Instead of a prompt string, call GetChatMessageContentAsync with the chat history.
var reply = await chatCompletionService.GetChatMessageContentAsync(
chatHistory: chatHistory,
executionSettings: executionSettings);
Console.WriteLine(reply);
}
}