mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
.Net: Agent Samples - Adding AzureAIAgentsPersistent to Steps (#105)
* Adding Persistent Agent to Steps * Add comments * Ensure changes * Fix format * Fix formatting * Adding cancellation token good practice
This commit is contained in:
Roger Barreto
committed by
GitHub
Unverified
GitHub
parent
06a690685f
commit
b46ee00468
+50
-37
@@ -10,14 +10,11 @@ namespace Steps;
|
||||
/// <remarks>This class contains examples of using <see cref="ChatClientAgent"/> to showcase scenarios with and without conversation history.
|
||||
/// Each test method demonstrates how to configure and interact with the agents, including handling user input and displaying responses.
|
||||
/// </remarks>
|
||||
public sealed class Step01_Running(ITestOutputHelper output) : AgentSample(output)
|
||||
public sealed class Step01_ChatClientAgent_Running(ITestOutputHelper output) : AgentSample(output)
|
||||
{
|
||||
private const string ParrotName = "Parrot";
|
||||
private const string ParrotInstructions = "Repeat the user message in the voice of a pirate and then end with a parrot sound.";
|
||||
|
||||
private const string JokerName = "Joker";
|
||||
private const string JokerInstructions = "You are good at telling jokes.";
|
||||
|
||||
/// <summary>
|
||||
/// Demonstrate the usage of <see cref="ChatClientAgent"/> where each invocation is
|
||||
/// a unique interaction with no conversation history between them.
|
||||
@@ -26,18 +23,21 @@ public sealed class Step01_Running(ITestOutputHelper output) : AgentSample(outpu
|
||||
[InlineData(ChatClientProviders.OpenAI)]
|
||||
[InlineData(ChatClientProviders.AzureOpenAI)]
|
||||
[InlineData(ChatClientProviders.OpenAIResponses)]
|
||||
[InlineData(ChatClientProviders.AzureAIAgentsPersistent)]
|
||||
public async Task RunWithoutThread(ChatClientProviders provider)
|
||||
{
|
||||
// Define the options for the chat client agent.
|
||||
var agentOptions = new ChatClientAgentOptions
|
||||
{
|
||||
Name = ParrotName,
|
||||
Instructions = ParrotInstructions,
|
||||
};
|
||||
|
||||
// Get the chat client to use for the agent.
|
||||
using var chatClient = base.GetChatClient(provider);
|
||||
using var chatClient = await base.GetChatClientAsync(provider, agentOptions);
|
||||
|
||||
// Define the agent
|
||||
ChatClientAgent agent =
|
||||
new(chatClient, new()
|
||||
{
|
||||
Name = ParrotName,
|
||||
Instructions = ParrotInstructions,
|
||||
});
|
||||
var agent = new ChatClientAgent(chatClient, agentOptions);
|
||||
|
||||
// Respond to user input
|
||||
await RunAgentAsync("Fortune favors the bold.");
|
||||
@@ -52,6 +52,9 @@ public sealed class Step01_Running(ITestOutputHelper output) : AgentSample(outpu
|
||||
var response = await agent.RunAsync(input);
|
||||
this.WriteResponseOutput(response);
|
||||
}
|
||||
|
||||
// Clean up the agent after use when applicable.
|
||||
await base.AgentCleanUpAsync(provider, agent);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -60,24 +63,26 @@ public sealed class Step01_Running(ITestOutputHelper output) : AgentSample(outpu
|
||||
[Theory]
|
||||
[InlineData(ChatClientProviders.OpenAI)]
|
||||
[InlineData(ChatClientProviders.AzureOpenAI)]
|
||||
[InlineData(ChatClientProviders.OpenAIResponses_InMemoryMessage)]
|
||||
[InlineData(ChatClientProviders.OpenAIResponses_ConversationId)]
|
||||
[InlineData(ChatClientProviders.AzureAIAgentsPersistent)]
|
||||
[InlineData(ChatClientProviders.OpenAIResponses_InMemoryMessageThread)]
|
||||
[InlineData(ChatClientProviders.OpenAIResponses_ConversationIdThread)]
|
||||
public async Task RunWithThread(ChatClientProviders provider)
|
||||
{
|
||||
// Get the chat client to use for the agent.
|
||||
using var chatClient = base.GetChatClient(provider);
|
||||
// Define the options for the chat client agent.
|
||||
var agentOptions = new ChatClientAgentOptions
|
||||
{
|
||||
Name = ParrotName,
|
||||
Instructions = ParrotInstructions,
|
||||
|
||||
// Get chat options based on the store type, if needed.
|
||||
var chatOptions = base.GetChatOptions(provider);
|
||||
// Get chat options based on the store type, if needed.
|
||||
ChatOptions = base.GetChatOptions(provider),
|
||||
};
|
||||
|
||||
// Get the chat client to use for the agent.
|
||||
using var chatClient = await base.GetChatClientAsync(provider, agentOptions);
|
||||
|
||||
// Define the agent
|
||||
ChatClientAgent agent =
|
||||
new(chatClient, new()
|
||||
{
|
||||
Name = JokerName,
|
||||
Instructions = JokerInstructions,
|
||||
ChatOptions = chatOptions,
|
||||
});
|
||||
var agent = new ChatClientAgent(chatClient, agentOptions);
|
||||
|
||||
// Start a new thread for the agent conversation.
|
||||
AgentThread thread = agent.GetNewThread();
|
||||
@@ -95,6 +100,9 @@ public sealed class Step01_Running(ITestOutputHelper output) : AgentSample(outpu
|
||||
|
||||
this.WriteResponseOutput(response);
|
||||
}
|
||||
|
||||
// Clean up the agent and thread after use when applicable.
|
||||
await base.AgentCleanUpAsync(provider, agent, thread);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -104,24 +112,26 @@ public sealed class Step01_Running(ITestOutputHelper output) : AgentSample(outpu
|
||||
[Theory]
|
||||
[InlineData(ChatClientProviders.OpenAI)]
|
||||
[InlineData(ChatClientProviders.AzureOpenAI)]
|
||||
[InlineData(ChatClientProviders.OpenAIResponses_InMemoryMessage)]
|
||||
[InlineData(ChatClientProviders.OpenAIResponses_ConversationId)]
|
||||
[InlineData(ChatClientProviders.AzureAIAgentsPersistent)]
|
||||
[InlineData(ChatClientProviders.OpenAIResponses_InMemoryMessageThread)]
|
||||
[InlineData(ChatClientProviders.OpenAIResponses_ConversationIdThread)]
|
||||
public async Task RunStreamingWithThread(ChatClientProviders provider)
|
||||
{
|
||||
// Get the chat client to use for the agent.
|
||||
using var chatClient = base.GetChatClient(provider);
|
||||
// Define the options for the chat client agent.
|
||||
var agentOptions = new ChatClientAgentOptions
|
||||
{
|
||||
Name = ParrotName,
|
||||
Instructions = ParrotInstructions,
|
||||
|
||||
// Get chat options based on the store type, if needed.
|
||||
var chatOptions = base.GetChatOptions(provider);
|
||||
// Get chat options based on the store type, if needed.
|
||||
ChatOptions = base.GetChatOptions(provider),
|
||||
};
|
||||
|
||||
// Get the chat client to use for the agent.
|
||||
using var chatClient = await base.GetChatClientAsync(provider, agentOptions);
|
||||
|
||||
// Define the agent
|
||||
ChatClientAgent agent =
|
||||
new(chatClient, new()
|
||||
{
|
||||
Name = ParrotName,
|
||||
Instructions = ParrotInstructions,
|
||||
ChatOptions = chatOptions,
|
||||
});
|
||||
var agent = new ChatClientAgent(chatClient, agentOptions);
|
||||
|
||||
// Start a new thread for the agent conversation.
|
||||
AgentThread thread = agent.GetNewThread();
|
||||
@@ -140,5 +150,8 @@ public sealed class Step01_Running(ITestOutputHelper output) : AgentSample(outpu
|
||||
this.WriteAgentOutput(update);
|
||||
}
|
||||
}
|
||||
|
||||
// Clean up the agent and thread after use when applicable.
|
||||
await base.AgentCleanUpAsync(provider, agent, thread);
|
||||
}
|
||||
}
|
||||
+45
-33
@@ -6,32 +6,38 @@ using Microsoft.Extensions.AI;
|
||||
|
||||
namespace Steps;
|
||||
|
||||
public sealed class Step02_UsingTools(ITestOutputHelper output) : AgentSample(output)
|
||||
public sealed class Step02_ChatClientAgent_UsingTools(ITestOutputHelper output) : AgentSample(output)
|
||||
{
|
||||
[Theory]
|
||||
[InlineData(ChatClientProviders.OpenAI)]
|
||||
[InlineData(ChatClientProviders.AzureOpenAI)]
|
||||
public async Task RunningWithTools(ChatClientProviders provider)
|
||||
{
|
||||
// Creating a Menu Tools to be used by the agent.
|
||||
var menuTools = new MenuTools();
|
||||
|
||||
// Define the options for the chat client agent.
|
||||
var agentOptions = new ChatClientAgentOptions
|
||||
{
|
||||
Name = "Host",
|
||||
Instructions = "Answer questions about the menu.",
|
||||
|
||||
// Provide the tools that are available to the agent
|
||||
ChatOptions = new()
|
||||
{
|
||||
Tools = [
|
||||
AIFunctionFactory.Create(menuTools.GetMenu),
|
||||
AIFunctionFactory.Create(menuTools.GetSpecials),
|
||||
AIFunctionFactory.Create(menuTools.GetItemPrice)
|
||||
]
|
||||
},
|
||||
};
|
||||
|
||||
// Get the chat client to use for the agent.
|
||||
using var chatClient = base.GetChatClient(provider);
|
||||
using var chatClient = await base.GetChatClientAsync(provider, agentOptions);
|
||||
|
||||
// Define the agent
|
||||
var menuTools = new MenuTools();
|
||||
ChatClientAgent agent =
|
||||
new(chatClient, new()
|
||||
{
|
||||
Name = "Host",
|
||||
Instructions = "Answer questions about the menu.",
|
||||
ChatOptions = new()
|
||||
{
|
||||
Tools = [
|
||||
AIFunctionFactory.Create(menuTools.GetMenu),
|
||||
AIFunctionFactory.Create(menuTools.GetSpecials),
|
||||
AIFunctionFactory.Create(menuTools.GetItemPrice)
|
||||
]
|
||||
}
|
||||
});
|
||||
var agent = new ChatClientAgent(chatClient, agentOptions);
|
||||
|
||||
// Create the chat history thread to capture the agent interaction.
|
||||
var thread = agent.GetNewThread();
|
||||
@@ -55,25 +61,31 @@ public sealed class Step02_UsingTools(ITestOutputHelper output) : AgentSample(ou
|
||||
[InlineData(ChatClientProviders.AzureOpenAI)]
|
||||
public async Task StreamingRunWithTools(ChatClientProviders provider)
|
||||
{
|
||||
// Creating a Menu Tools to be used by the agent.
|
||||
var menuTools = new MenuTools();
|
||||
|
||||
// Define the options for the chat client agent.
|
||||
var agentOptions = new ChatClientAgentOptions
|
||||
{
|
||||
Name = "Host",
|
||||
Instructions = "Answer questions about the menu.",
|
||||
|
||||
// Provide the tools that are available to the agent
|
||||
ChatOptions = new()
|
||||
{
|
||||
Tools = [
|
||||
AIFunctionFactory.Create(menuTools.GetMenu),
|
||||
AIFunctionFactory.Create(menuTools.GetSpecials),
|
||||
AIFunctionFactory.Create(menuTools.GetItemPrice)
|
||||
]
|
||||
},
|
||||
};
|
||||
|
||||
// Get the chat client to use for the agent.
|
||||
using var chatClient = base.GetChatClient(provider);
|
||||
using var chatClient = await base.GetChatClientAsync(provider, agentOptions);
|
||||
|
||||
// Define the agent
|
||||
var menuTools = new MenuTools();
|
||||
ChatClientAgent agent =
|
||||
new(chatClient, new()
|
||||
{
|
||||
Name = "Host",
|
||||
Instructions = "Answer questions about the menu.",
|
||||
ChatOptions = new()
|
||||
{
|
||||
Tools = [
|
||||
AIFunctionFactory.Create(menuTools.GetMenu),
|
||||
AIFunctionFactory.Create(menuTools.GetSpecials),
|
||||
AIFunctionFactory.Create(menuTools.GetItemPrice)
|
||||
]
|
||||
}
|
||||
});
|
||||
var agent = new ChatClientAgent(chatClient, agentOptions);
|
||||
|
||||
// Create the chat history thread to capture the agent interaction.
|
||||
var thread = agent.GetNewThread();
|
||||
Reference in New Issue
Block a user