mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
.Net: Add Azure OpenAI Agent Model Samples (#80)
* Improved Merge logic * Add modularization for Model Samples and Azure OpenAI * Address PR feedback * Warning fix * Address PR comments
This commit is contained in:
committed by
GitHub
Unverified
parent
e6bfc51367
commit
14f3811648
@@ -5,6 +5,9 @@
|
||||
<ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
|
||||
</PropertyGroup>
|
||||
<ItemGroup>
|
||||
<!-- Azure.* -->
|
||||
<PackageVersion Include="Azure.AI.OpenAI" Version="2.2.0-beta.4" />
|
||||
<PackageVersion Include="Azure.Identity" Version="1.14.0" />
|
||||
<!-- System.* -->
|
||||
<PackageVersion Include="Microsoft.Extensions.Configuration" Version="9.0.6" />
|
||||
<PackageVersion Include="Microsoft.Extensions.Configuration.Abstractions" Version="9.0.6" />
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
using System.ClientModel;
|
||||
using Azure.AI.OpenAI;
|
||||
using Azure.Identity;
|
||||
using Microsoft.Extensions.AI;
|
||||
using Microsoft.Shared.Samples;
|
||||
using OpenAI;
|
||||
@@ -8,8 +11,35 @@ namespace GettingStarted;
|
||||
|
||||
public class AgentSample(ITestOutputHelper output) : BaseSample(output)
|
||||
{
|
||||
protected IChatClient GetOpenAIChatClient()
|
||||
/// <summary>
|
||||
/// Represents the available providers for <see cref="IChatClient"/> instances.
|
||||
/// </summary>
|
||||
public enum ChatClientProviders
|
||||
{
|
||||
OpenAI,
|
||||
AzureOpenAI,
|
||||
}
|
||||
|
||||
protected IChatClient GetChatClient(ChatClientProviders provider)
|
||||
{
|
||||
return provider switch
|
||||
{
|
||||
ChatClientProviders.OpenAI => GetOpenAIChatClient(),
|
||||
ChatClientProviders.AzureOpenAI => GetAzureOpenAIChatClient(),
|
||||
_ => throw new NotSupportedException($"Provider {provider} is not supported.")
|
||||
};
|
||||
}
|
||||
|
||||
private IChatClient GetOpenAIChatClient()
|
||||
=> new OpenAIClient(TestConfiguration.OpenAI.ApiKey)
|
||||
.GetChatClient(TestConfiguration.OpenAI.ChatModelId)
|
||||
.AsIChatClient();
|
||||
|
||||
private IChatClient GetAzureOpenAIChatClient()
|
||||
=> ((TestConfiguration.AzureOpenAI.ApiKey is null)
|
||||
// Use Azure CLI credentials if API key is not provided.
|
||||
? new AzureOpenAIClient(TestConfiguration.AzureOpenAI.Endpoint, new AzureCliCredential())
|
||||
: new AzureOpenAIClient(TestConfiguration.AzureOpenAI.Endpoint, new ApiKeyCredential(TestConfiguration.AzureOpenAI.ApiKey)))
|
||||
.GetChatClient(TestConfiguration.AzureOpenAI.DeploymentName)
|
||||
.AsIChatClient();
|
||||
}
|
||||
|
||||
@@ -15,6 +15,8 @@
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Azure.AI.OpenAI" />
|
||||
<PackageReference Include="Azure.Identity" />
|
||||
<PackageReference Include="Microsoft.Extensions.AI.OpenAI" />
|
||||
<PackageReference Include="Microsoft.Extensions.Configuration.Binder" />
|
||||
<PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" />
|
||||
|
||||
+56
@@ -0,0 +1,56 @@
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
using System.ClientModel;
|
||||
using Azure.AI.OpenAI;
|
||||
using Azure.Identity;
|
||||
using Microsoft.Agents;
|
||||
using Microsoft.Extensions.AI;
|
||||
using Microsoft.Shared.Samples;
|
||||
|
||||
namespace Providers;
|
||||
|
||||
/// <summary>
|
||||
/// End-to-end sample showing how to use <see cref="ChatClientAgent"/> with Azure OpenAI Chat Completion.
|
||||
/// </summary>
|
||||
public sealed class ChatClientAgent_With_AzureOpenAIChatCompletion(ITestOutputHelper output) : AgentSample(output)
|
||||
{
|
||||
private const string JokerName = "Joker";
|
||||
private const string JokerInstructions = "You are good at telling jokes.";
|
||||
|
||||
[Fact]
|
||||
public async Task RunWithChatCompletion()
|
||||
{
|
||||
// Get the chat client to use for the agent.
|
||||
using var chatClient = ((TestConfiguration.AzureOpenAI.ApiKey is null)
|
||||
// Use Azure CLI credentials if API key is not provided.
|
||||
? new AzureOpenAIClient(TestConfiguration.AzureOpenAI.Endpoint, new AzureCliCredential())
|
||||
: new AzureOpenAIClient(TestConfiguration.AzureOpenAI.Endpoint, new ApiKeyCredential(TestConfiguration.AzureOpenAI.ApiKey)))
|
||||
.GetChatClient(TestConfiguration.AzureOpenAI.DeploymentName)
|
||||
.AsIChatClient();
|
||||
|
||||
// Define the agent
|
||||
ChatClientAgent agent =
|
||||
new(chatClient, new()
|
||||
{
|
||||
Name = JokerName,
|
||||
Instructions = JokerInstructions,
|
||||
});
|
||||
|
||||
// Start a new thread for the agent conversation.
|
||||
AgentThread thread = agent.GetNewThread();
|
||||
|
||||
// Respond to user input
|
||||
await RunAgentAsync("Tell me a joke about a pirate.");
|
||||
await RunAgentAsync("Now add some emojis to the joke.");
|
||||
|
||||
// Local function to invoke agent and display the conversation messages for the thread.
|
||||
async Task RunAgentAsync(string input)
|
||||
{
|
||||
this.WriteUserMessage(input);
|
||||
|
||||
var response = await agent.RunAsync(input, thread);
|
||||
|
||||
this.WriteResponseOutput(response);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -10,7 +10,7 @@ using OpenAI;
|
||||
namespace Providers;
|
||||
|
||||
/// <summary>
|
||||
/// Shows how to use <see cref="ChatClientAgent"/> with Open AI Assistants.
|
||||
/// End-to-end sample showing how to use <see cref="ChatClientAgent"/> with OpenAI Assistants.
|
||||
/// </summary>
|
||||
public sealed class ChatClientAgent_With_OpenAIAssistant(ITestOutputHelper output) : AgentSample(output)
|
||||
{
|
||||
@@ -45,11 +45,11 @@ public sealed class ChatClientAgent_With_OpenAIAssistant(ITestOutputHelper outpu
|
||||
AgentThread thread = agent.GetNewThread();
|
||||
|
||||
// Respond to user input
|
||||
await InvokeAgentAsync("Tell me a joke about a pirate.");
|
||||
await InvokeAgentAsync("Now add some emojis to the joke.");
|
||||
await RunAgentAsync("Tell me a joke about a pirate.");
|
||||
await RunAgentAsync("Now add some emojis to the joke.");
|
||||
|
||||
// Local function to invoke agent and display the conversation messages for the thread.
|
||||
async Task InvokeAgentAsync(string input)
|
||||
async Task RunAgentAsync(string input)
|
||||
{
|
||||
this.WriteUserMessage(input);
|
||||
|
||||
|
||||
+5
-5
@@ -8,7 +8,7 @@ using OpenAI;
|
||||
namespace Providers;
|
||||
|
||||
/// <summary>
|
||||
/// Shows how to use <see cref="ChatClientAgent"/> with Open AI Chat Completion.
|
||||
/// End-to-end sample showing how to use <see cref="ChatClientAgent"/> with OpenAI Chat Completion.
|
||||
/// </summary>
|
||||
public sealed class ChatClientAgent_With_OpenAIChatCompletion(ITestOutputHelper output) : AgentSample(output)
|
||||
{
|
||||
@@ -16,7 +16,7 @@ public sealed class ChatClientAgent_With_OpenAIChatCompletion(ITestOutputHelper
|
||||
private const string JokerInstructions = "You are good at telling jokes.";
|
||||
|
||||
[Fact]
|
||||
public async Task RunWithOpenAIAssistant()
|
||||
public async Task RunWithChatCompletion()
|
||||
{
|
||||
// Get the chat client to use for the agent.
|
||||
using var chatClient = new OpenAIClient(TestConfiguration.OpenAI.ApiKey)
|
||||
@@ -35,11 +35,11 @@ public sealed class ChatClientAgent_With_OpenAIChatCompletion(ITestOutputHelper
|
||||
AgentThread thread = agent.GetNewThread();
|
||||
|
||||
// Respond to user input
|
||||
await InvokeAgentAsync("Tell me a joke about a pirate.");
|
||||
await InvokeAgentAsync("Now add some emojis to the joke.");
|
||||
await RunAgentAsync("Tell me a joke about a pirate.");
|
||||
await RunAgentAsync("Now add some emojis to the joke.");
|
||||
|
||||
// Local function to invoke agent and display the conversation messages for the thread.
|
||||
async Task InvokeAgentAsync(string input)
|
||||
async Task RunAgentAsync(string input)
|
||||
{
|
||||
this.WriteUserMessage(input);
|
||||
|
||||
|
||||
@@ -22,11 +22,13 @@ public sealed class Step01_Running(ITestOutputHelper output) : AgentSample(outpu
|
||||
/// Demonstrate the usage of <see cref="ChatClientAgent"/> where each invocation is
|
||||
/// a unique interaction with no conversation history between them.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task RunWithoutThread()
|
||||
[Theory]
|
||||
[InlineData(ChatClientProviders.OpenAI)]
|
||||
[InlineData(ChatClientProviders.AzureOpenAI)]
|
||||
public async Task RunWithoutThread(ChatClientProviders provider)
|
||||
{
|
||||
// Get the chat client to use for the agent.
|
||||
using var chatClient = base.GetOpenAIChatClient();
|
||||
using var chatClient = base.GetChatClient(provider);
|
||||
|
||||
// Define the agent
|
||||
ChatClientAgent agent =
|
||||
@@ -37,12 +39,12 @@ public sealed class Step01_Running(ITestOutputHelper output) : AgentSample(outpu
|
||||
});
|
||||
|
||||
// Respond to user input
|
||||
await InvokeAgentAsync("Fortune favors the bold.");
|
||||
await InvokeAgentAsync("I came, I saw, I conquered.");
|
||||
await InvokeAgentAsync("Practice makes perfect.");
|
||||
await RunAgentAsync("Fortune favors the bold.");
|
||||
await RunAgentAsync("I came, I saw, I conquered.");
|
||||
await RunAgentAsync("Practice makes perfect.");
|
||||
|
||||
// Local function to invoke agent and display the conversation messages.
|
||||
async Task InvokeAgentAsync(string input)
|
||||
async Task RunAgentAsync(string input)
|
||||
{
|
||||
this.WriteUserMessage(input);
|
||||
|
||||
@@ -54,11 +56,13 @@ public sealed class Step01_Running(ITestOutputHelper output) : AgentSample(outpu
|
||||
/// <summary>
|
||||
/// Demonstrate the usage of <see cref="ChatClientAgent"/> where a conversation history is maintained.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task RunWithConversationThread()
|
||||
[Theory]
|
||||
[InlineData(ChatClientProviders.OpenAI)]
|
||||
[InlineData(ChatClientProviders.AzureOpenAI)]
|
||||
public async Task RunWithConversationThread(ChatClientProviders provider)
|
||||
{
|
||||
// Get the chat client to use for the agent.
|
||||
using var chatClient = base.GetOpenAIChatClient();
|
||||
using var chatClient = base.GetChatClient(provider);
|
||||
|
||||
// Define the agent
|
||||
ChatClientAgent agent =
|
||||
@@ -72,11 +76,11 @@ public sealed class Step01_Running(ITestOutputHelper output) : AgentSample(outpu
|
||||
AgentThread thread = agent.GetNewThread();
|
||||
|
||||
// Respond to user input
|
||||
await InvokeAgentAsync("Tell me a joke about a pirate.");
|
||||
await InvokeAgentAsync("Now add some emojis to the joke.");
|
||||
await RunAgentAsync("Tell me a joke about a pirate.");
|
||||
await RunAgentAsync("Now add some emojis to the joke.");
|
||||
|
||||
// Local function to invoke agent and display the conversation messages for the thread.
|
||||
async Task InvokeAgentAsync(string input)
|
||||
async Task RunAgentAsync(string input)
|
||||
{
|
||||
this.WriteUserMessage(input);
|
||||
|
||||
@@ -90,11 +94,13 @@ public sealed class Step01_Running(ITestOutputHelper output) : AgentSample(outpu
|
||||
/// Demonstrate the usage of <see cref="ChatClientAgent"/> in streaming mode,
|
||||
/// where a conversation is maintained by the <see cref="AgentThread"/>.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task StreamingRunWithConversationThread()
|
||||
[Theory]
|
||||
[InlineData(ChatClientProviders.OpenAI)]
|
||||
[InlineData(ChatClientProviders.AzureOpenAI)]
|
||||
public async Task StreamingRunWithConversationThread(ChatClientProviders provider)
|
||||
{
|
||||
// Get the chat client to use for the agent.
|
||||
using var chatClient = base.GetOpenAIChatClient();
|
||||
using var chatClient = base.GetChatClient(provider);
|
||||
|
||||
// Define the agent
|
||||
ChatClientAgent agent =
|
||||
@@ -108,11 +114,11 @@ public sealed class Step01_Running(ITestOutputHelper output) : AgentSample(outpu
|
||||
AgentThread thread = agent.GetNewThread();
|
||||
|
||||
// Respond to user input
|
||||
await InvokeAgentAsync("Tell me a joke about a pirate.");
|
||||
await InvokeAgentAsync("Now add some emojis to the joke.");
|
||||
await RunAgentAsync("Tell me a joke about a pirate.");
|
||||
await RunAgentAsync("Now add some emojis to the joke.");
|
||||
|
||||
// Local function to invoke agent and display the conversation messages.
|
||||
async Task InvokeAgentAsync(string input)
|
||||
async Task RunAgentAsync(string input)
|
||||
{
|
||||
this.WriteUserMessage(input);
|
||||
|
||||
|
||||
@@ -8,11 +8,13 @@ namespace Steps;
|
||||
|
||||
public sealed class Step02_UsingTools(ITestOutputHelper output) : AgentSample(output)
|
||||
{
|
||||
[Fact]
|
||||
public async Task RunningWithTools()
|
||||
[Theory]
|
||||
[InlineData(ChatClientProviders.OpenAI)]
|
||||
[InlineData(ChatClientProviders.AzureOpenAI)]
|
||||
public async Task RunningWithTools(ChatClientProviders provider)
|
||||
{
|
||||
// Get the chat client to use for the agent.
|
||||
using var chatClient = base.GetOpenAIChatClient();
|
||||
using var chatClient = base.GetChatClient(provider);
|
||||
|
||||
// Define the agent
|
||||
var menuTools = new MenuTools();
|
||||
@@ -35,12 +37,12 @@ public sealed class Step02_UsingTools(ITestOutputHelper output) : AgentSample(ou
|
||||
var thread = agent.GetNewThread();
|
||||
|
||||
// Respond to user input, invoking functions where appropriate.
|
||||
await InvokeAgentAsync("Hello");
|
||||
await InvokeAgentAsync("What is the special soup and its price?");
|
||||
await InvokeAgentAsync("What is the special drink and its price?");
|
||||
await InvokeAgentAsync("Thank you");
|
||||
await RunAgentAsync("Hello");
|
||||
await RunAgentAsync("What is the special soup and its price?");
|
||||
await RunAgentAsync("What is the special drink and its price?");
|
||||
await RunAgentAsync("Thank you");
|
||||
|
||||
async Task InvokeAgentAsync(string input)
|
||||
async Task RunAgentAsync(string input)
|
||||
{
|
||||
this.WriteUserMessage(input);
|
||||
var response = await agent.RunAsync(input, thread);
|
||||
@@ -48,11 +50,13 @@ public sealed class Step02_UsingTools(ITestOutputHelper output) : AgentSample(ou
|
||||
}
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task StreamingRunWithTools()
|
||||
[Theory]
|
||||
[InlineData(ChatClientProviders.OpenAI)]
|
||||
[InlineData(ChatClientProviders.AzureOpenAI)]
|
||||
public async Task StreamingRunWithTools(ChatClientProviders provider)
|
||||
{
|
||||
// Get the chat client to use for the agent.
|
||||
using var chatClient = base.GetOpenAIChatClient();
|
||||
using var chatClient = base.GetChatClient(provider);
|
||||
|
||||
// Define the agent
|
||||
var menuTools = new MenuTools();
|
||||
@@ -75,12 +79,12 @@ public sealed class Step02_UsingTools(ITestOutputHelper output) : AgentSample(ou
|
||||
var thread = agent.GetNewThread();
|
||||
|
||||
// Respond to user input, invoking functions where appropriate.
|
||||
await InvokeAgentAsync("Hello");
|
||||
await InvokeAgentAsync("What is the special soup and its price?");
|
||||
await InvokeAgentAsync("What is the special drink and its price?");
|
||||
await InvokeAgentAsync("Thank you");
|
||||
await RunAgentAsync("Hello");
|
||||
await RunAgentAsync("What is the special soup and its price?");
|
||||
await RunAgentAsync("What is the special drink and its price?");
|
||||
await RunAgentAsync("Thank you");
|
||||
|
||||
async Task InvokeAgentAsync(string input)
|
||||
async Task RunAgentAsync(string input)
|
||||
{
|
||||
this.WriteUserMessage(input);
|
||||
await foreach (var update in agent.RunStreamingAsync(input, thread))
|
||||
|
||||
@@ -117,10 +117,10 @@ public sealed class ChatClientAgent : Agent
|
||||
AgentRunOptions? options = null,
|
||||
[EnumeratorCancellation] CancellationToken cancellationToken = default)
|
||||
{
|
||||
Throw.IfNull(messages);
|
||||
var inputMessages = Throw.IfNull(messages);
|
||||
|
||||
(ChatClientAgentThread chatClientThread, ChatOptions? chatOptions, List<ChatMessage> threadMessages) =
|
||||
await this.PrepareThreadAndMessagesAsync(thread, messages, options, cancellationToken).ConfigureAwait(false);
|
||||
await this.PrepareThreadAndMessagesAsync(thread, inputMessages, options, cancellationToken).ConfigureAwait(false);
|
||||
|
||||
int messageCount = threadMessages.Count;
|
||||
var agentName = this.GetAgentName();
|
||||
@@ -158,7 +158,7 @@ public sealed class ChatClientAgent : Agent
|
||||
this.UpdateThreadWithTypeAndConversationId(chatClientThread, chatResponse.ConversationId);
|
||||
|
||||
// To avoid inconsistent state we only notify the thread of the input messages if no error occurs after the initial request.
|
||||
await this.NotifyThreadOfNewMessagesAsync(chatClientThread, messages, cancellationToken).ConfigureAwait(false);
|
||||
await this.NotifyThreadOfNewMessagesAsync(chatClientThread, inputMessages, cancellationToken).ConfigureAwait(false);
|
||||
|
||||
await this.NotifyThreadOfNewMessagesAsync(chatClientThread, chatResponseMessages, cancellationToken).ConfigureAwait(false);
|
||||
if (options?.OnIntermediateMessages is not null)
|
||||
@@ -198,28 +198,33 @@ public sealed class ChatClientAgent : Agent
|
||||
}
|
||||
|
||||
// If both are present, we need to merge them.
|
||||
|
||||
// The merge strategy will prioritize the request options over the agent options,
|
||||
// and will fill the blanks with agent options where the request options were not set.
|
||||
|
||||
// Merge only the additional properties from the agent if they are not already set in the request options.
|
||||
if (requestChatOptions.AdditionalProperties is not null && this._agentOptions.ChatOptions.AdditionalProperties is not null)
|
||||
{
|
||||
foreach (var property in this._agentOptions.ChatOptions.AdditionalProperties.Keys)
|
||||
{
|
||||
requestChatOptions.AdditionalProperties.TryAdd(property, this._agentOptions.ChatOptions.AdditionalProperties[property]);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
requestChatOptions.AdditionalProperties ??= this._agentOptions.ChatOptions.AdditionalProperties;
|
||||
}
|
||||
requestChatOptions.AllowMultipleToolCalls ??= this._agentOptions.ChatOptions.AllowMultipleToolCalls;
|
||||
requestChatOptions.ConversationId ??= this._agentOptions.ChatOptions.ConversationId;
|
||||
requestChatOptions.FrequencyPenalty ??= this._agentOptions.ChatOptions.FrequencyPenalty;
|
||||
requestChatOptions.MaxOutputTokens ??= this._agentOptions.ChatOptions.MaxOutputTokens;
|
||||
requestChatOptions.ModelId ??= this._agentOptions.ChatOptions.ModelId;
|
||||
requestChatOptions.PresencePenalty ??= this._agentOptions.ChatOptions.PresencePenalty;
|
||||
requestChatOptions.ResponseFormat ??= this._agentOptions.ChatOptions.ResponseFormat;
|
||||
requestChatOptions.Seed ??= this._agentOptions.ChatOptions.Seed;
|
||||
requestChatOptions.Temperature ??= this._agentOptions.ChatOptions.Temperature;
|
||||
requestChatOptions.TopP ??= this._agentOptions.ChatOptions.TopP;
|
||||
requestChatOptions.TopK ??= this._agentOptions.ChatOptions.TopK;
|
||||
requestChatOptions.ToolMode ??= this._agentOptions.ChatOptions.ToolMode;
|
||||
|
||||
// Merge only the additional properties from the agent if they are not already set in the request options.
|
||||
if (requestChatOptions.AdditionalProperties is not null && this._agentOptions.ChatOptions.AdditionalProperties is not null)
|
||||
{
|
||||
foreach (var propertyKey in this._agentOptions.ChatOptions.AdditionalProperties.Keys)
|
||||
{
|
||||
requestChatOptions.AdditionalProperties.TryAdd(propertyKey, this._agentOptions.ChatOptions.AdditionalProperties[propertyKey]);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
requestChatOptions.AdditionalProperties ??= this._agentOptions.ChatOptions.AdditionalProperties?.Clone();
|
||||
}
|
||||
|
||||
// Chain the raw representation factory from the request options with the agent's factory if available.
|
||||
if (this._agentOptions.ChatOptions.RawRepresentationFactory is { } agentFactory)
|
||||
@@ -229,41 +234,52 @@ public sealed class ChatClientAgent : Agent
|
||||
: agentFactory;
|
||||
}
|
||||
|
||||
requestChatOptions.ResponseFormat ??= this._agentOptions.ChatOptions.ResponseFormat;
|
||||
requestChatOptions.Seed ??= this._agentOptions.ChatOptions.Seed;
|
||||
|
||||
// We concatenate the request stop sequences with the agent's stop sequences when available.
|
||||
if (this._agentOptions.ChatOptions.StopSequences is { Count: not 0 })
|
||||
{
|
||||
if (requestChatOptions.StopSequences is null || requestChatOptions.StopSequences.Count == 0)
|
||||
{
|
||||
// If the request stop sequences are not set or empty, we use the agent's stop sequences directly.
|
||||
requestChatOptions.StopSequences = this._agentOptions.ChatOptions.StopSequences.ToArray();
|
||||
requestChatOptions.StopSequences = [.. this._agentOptions.ChatOptions.StopSequences];
|
||||
}
|
||||
else if (requestChatOptions.StopSequences is List<string> requestStopSequences)
|
||||
{
|
||||
// If the request stop sequences are set, we concatenate them with the agent's stop sequences.
|
||||
requestStopSequences.AddRange(this._agentOptions.ChatOptions.StopSequences);
|
||||
}
|
||||
else
|
||||
{
|
||||
// If both agent's and request's stop sequences are set, we concatenate them.
|
||||
requestChatOptions.StopSequences = [.. requestChatOptions.StopSequences, .. this._agentOptions.ChatOptions.StopSequences];
|
||||
foreach (string stopSequence in this._agentOptions.ChatOptions.StopSequences)
|
||||
{
|
||||
requestChatOptions.StopSequences.Add(stopSequence);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
requestChatOptions.Temperature ??= this._agentOptions.ChatOptions.Temperature;
|
||||
requestChatOptions.TopP ??= this._agentOptions.ChatOptions.TopP;
|
||||
requestChatOptions.TopK ??= this._agentOptions.ChatOptions.TopK;
|
||||
requestChatOptions.ToolMode ??= this._agentOptions.ChatOptions.ToolMode;
|
||||
|
||||
// We concatenate the request tools with the agent's tools when available.
|
||||
if (this._agentOptions.ChatOptions.Tools is { Count: not 0 })
|
||||
{
|
||||
if (requestChatOptions.Tools is not { Count: > 0 })
|
||||
{
|
||||
// If the request tools are not set or empty, we use the agent's tools directly.
|
||||
requestChatOptions.Tools = this._agentOptions.ChatOptions.Tools;
|
||||
// If the request tools are not set or empty, we use the agent's tools.
|
||||
requestChatOptions.Tools = [.. this._agentOptions.ChatOptions.Tools];
|
||||
}
|
||||
else
|
||||
{
|
||||
// If the both agent's and request's tools are set, we concatenate all tools.
|
||||
requestChatOptions.Tools = [.. requestChatOptions.Tools, .. this._agentOptions.ChatOptions.Tools];
|
||||
if (requestChatOptions.Tools is List<AITool> requestTools)
|
||||
{
|
||||
// If the request tools are set, we concatenate them with the agent's tools.
|
||||
requestTools.AddRange(this._agentOptions.ChatOptions.Tools);
|
||||
}
|
||||
else
|
||||
{
|
||||
// If the both agent's and request's tools are set, we concatenate all tools.
|
||||
foreach (var tool in this._agentOptions.ChatOptions.Tools)
|
||||
{
|
||||
requestChatOptions.Tools.Add(tool);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -5,17 +5,42 @@ using Microsoft.Extensions.Configuration;
|
||||
|
||||
namespace Microsoft.Shared.Samples;
|
||||
|
||||
#pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
|
||||
|
||||
/// <summary>
|
||||
/// Provides a centralized configuration management system for accessing application settings.
|
||||
/// Provides access to application configuration settings.
|
||||
/// </summary>
|
||||
public sealed class TestConfiguration
|
||||
{
|
||||
private readonly IConfigurationRoot _configRoot;
|
||||
private static TestConfiguration? s_instance;
|
||||
/// <summary>Gets the configuration settings for the OpenAI integration.</summary>
|
||||
public static OpenAIConfig OpenAI => LoadSection<OpenAIConfig>();
|
||||
|
||||
private TestConfiguration(IConfigurationRoot configRoot)
|
||||
/// <summary>Gets the configuration settings for the Azure OpenAI integration.</summary>
|
||||
public static AzureOpenAIConfig AzureOpenAI => LoadSection<AzureOpenAIConfig>();
|
||||
|
||||
/// <summary>Represents the configuration settings required to interact with the OpenAI service.</summary>
|
||||
public class OpenAIConfig
|
||||
{
|
||||
this._configRoot = configRoot;
|
||||
/// <summary>Gets or sets the identifier for the chat completion model used in the application.</summary>
|
||||
public string ChatModelId { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the API key used for authentication with the OpenAI service.</summary>
|
||||
public string ApiKey { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Represents the configuration settings required to interact with the Azure OpenAI service.
|
||||
/// </summary>
|
||||
public class AzureOpenAIConfig
|
||||
{
|
||||
/// <summary>Gets the URI endpoint used to connect to the service.</summary>
|
||||
public Uri Endpoint { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the name of the deployment.</summary>
|
||||
public string DeploymentName { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the API key used for authentication with the OpenAI service.</summary>
|
||||
public string? ApiKey { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -27,15 +52,19 @@ public sealed class TestConfiguration
|
||||
s_instance = new TestConfiguration(configRoot);
|
||||
}
|
||||
|
||||
#region Private Members
|
||||
private readonly IConfigurationRoot _configRoot;
|
||||
private static TestConfiguration? s_instance;
|
||||
|
||||
private TestConfiguration(IConfigurationRoot configRoot)
|
||||
{
|
||||
this._configRoot = configRoot;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Provides access to the configuration root for the application.
|
||||
/// </summary>
|
||||
public static IConfigurationRoot? ConfigurationRoot => s_instance?._configRoot;
|
||||
|
||||
/// <summary>
|
||||
/// Gets the configuration settings for the OpenAI integration.
|
||||
/// </summary>
|
||||
public static OpenAIConfig OpenAI => LoadSection<OpenAIConfig>();
|
||||
private static IConfigurationRoot? ConfigurationRoot => s_instance?._configRoot;
|
||||
|
||||
/// <summary>
|
||||
/// Retrieves a configuration section based on the specified key.
|
||||
@@ -43,7 +72,7 @@ public sealed class TestConfiguration
|
||||
/// <param name="caller">The key identifying the configuration section to retrieve. Cannot be null or empty.</param>
|
||||
/// <returns>The <see cref="IConfigurationSection"/> corresponding to the specified key.</returns>
|
||||
/// <exception cref="InvalidOperationException">Thrown if the configuration root is not initialized or the specified key does not correspond to a valid section.</exception>
|
||||
public static IConfigurationSection GetSection(string caller)
|
||||
private static IConfigurationSection GetSection(string caller)
|
||||
{
|
||||
return s_instance?._configRoot.GetSection(caller) ??
|
||||
throw new InvalidOperationException(caller);
|
||||
@@ -66,16 +95,5 @@ public sealed class TestConfiguration
|
||||
throw new InvalidOperationException(caller);
|
||||
}
|
||||
|
||||
/// <summary>Represents the configuration settings required to interact with the OpenAI service.</summary>
|
||||
public class OpenAIConfig
|
||||
{
|
||||
/// <summary>Gets or sets the identifier for the chat completion model used in the application.</summary>
|
||||
public string? ChatModelId { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the identifier for the embedding model used in the application.</summary>
|
||||
public string? EmbeddingModelId { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the API key used for authentication with the OpenAI service.</summary>
|
||||
public string? ApiKey { get; set; }
|
||||
}
|
||||
#endregion
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user