westey
3571a7d321
* Subclass AgentThread so that different agents have their own threads with their own typed settings. * Address PR comment. * Add unit tests for base abstract threads * Fix style warning * Fix stlying * FIx and suppress warnings as needed. * Remove covariant thread response types and fix some styling. * Remove unecessary json property name attributes and make OrchestratingAgentThread private * Fix break from merge from main. * Fix formatting * Fix deserialization bug in Memory sample * Remove thread deletion from basic samples. * Remove public constructors for thread subclasses and add more factory methods to concrete agent types. * Update AgentProxy thread constructors to be internal as well. * Revert AgentProxyThread to internal * Change AIContextProvider to internal set * Change conversation id and message store properties to internal set * Update styling. * Seal various thread types. * Add thread type check for thread deletion * Fix tests after latest merge from main * Add thread type checks for thread deletion. --------- Co-authored-by: Chris <66376200+crickman@users.noreply.github.com>
Getting started with agents
The getting started with agents samples demonstrate the fundamental concepts and functionalities of single agents and can be used with any agent type.
While the functionality can be used with any agent type, these samples use Azure OpenAI as the AI provider and use ChatCompletion as the type of service.
For other samples that demonstrate how to create and configure each type of agent that come with the agent framework, see the How to create an agent for each provider samples.
Getting started with agents prerequisites
Before you begin, ensure you have the following prerequisites:
- .NET 8.0 SDK or later
- Azure OpenAI service endpoint and deployment configured
- Azure CLI installed and authenticated (for Azure credential authentication)
- User has the
Cognitive Services OpenAI Contributorrole for the Azure OpenAI resource.
Note: These samples use Azure OpenAI models. For more information, see how to deploy Azure OpenAI models with Azure AI Foundry.
Note: These samples use Azure CLI credentials for authentication. Make sure you're logged in with az login and have access to the Azure OpenAI resource and have the Cognitive Services OpenAI Contributor role. For more information, see the Azure CLI documentation.
Samples
| Sample | Description |
|---|---|
| Running a simple agent | This sample demonstrates how to create and run a basic agent with instructions |
| Multi-turn conversation with a simple agent | This sample demonstrates how to implement a multi-turn conversation with a simple agent |
| Using function tools with a simple agent | This sample demonstrates how to use function tools with a simple agent |
| Using function tools with approvals | This sample demonstrates how to use function tools where approvals require human in the loop approvals before execution |
| Structured output with a simple agent | This sample demonstrates how to use structured output with a simple agent |
| Persisted conversations with a simple agent | This sample demonstrates how to persist conversations and reload them later. This is useful for cases where an agent is hosted in a stateless service |
| 3rd party thread storage with a simple agent | This sample demonstrates how to store conversation history in a 3rd party storage solution |
| Telemetry with a simple agent | This sample demonstrates how to add telemetry to a simple agent |
| Dependency injection with a simple agent | This sample demonstrates how to add and resolve an agent with a dependency injection container |
| Exposing a simple agent as MCP tool | This sample demonstrates how to expose an agent as an MCP tool |
| Using images with a simple agent | This sample demonstrates how to use image multi-modality with an AI agent |
| Exposing a simple agent as a function tool | This sample demonstrates how to expose an agent as a function tool |
| Using memory with an agent | This sample demonstrates how to create a simple memory component and use it with an agent |
Running the samples from the console
To run the samples, navigate to the desired sample directory, e.g.
cd Agents_Step01_Running
Set the following environment variables:
$env:AZURE_OPENAI_ENDPOINT="https://your-resource.openai.azure.com/" # Replace with your Azure OpenAI resource endpoint
$env:AZURE_OPENAI_DEPLOYMENT_NAME="gpt-4o-mini" # Optional, defaults to gpt-4o-mini
If the variables are not set, you will be prompted for the values when running the samples.
Execute the following command to build the sample:
dotnet build
Execute the following command to run the sample:
dotnet run --no-build
Or just build and run in one step:
dotnet run
Running the samples from Visual Studio
Open the solution in Visual Studio and set the desired sample project as the startup project. Then, run the project using the built-in debugger or by pressing F5.
You will be prompted for any required environment variables if they are not already set.