README.md

Semantic Kernel: Agent syntax examples

This project contains a collection of examples on how to use Semantic Kernel Agents.

NuGet:

• Microsoft.SemanticKernel.Agents.Abstractions
• Microsoft.SemanticKernel.Agents.Core
• Microsoft.SemanticKernel.Agents.OpenAI

Source

• Semantic Kernel Agent Framework

The examples can be run as integration tests but their code can also be copied to stand-alone programs.

Examples

The concept agents examples are grouped by prefix:

Prefix	Description
OpenAIAssistant	How to use agents based on the Open AI Assistant API.
MixedChat	How to combine different agent types.
ComplexChat	How to deveop complex agent chat solutions.
Legacy	How to use the legacy Experimental Agent API.

Legacy Agents

Support for the OpenAI Assistant API was originally published in Microsoft.SemanticKernel.Experimental.Agents package: Microsoft.SemanticKernel.Experimental.Agents

This package has been superseded by Semantic Kernel Agents, which includes support for Open AI Assistant agents.

Running Examples

Examples may be explored and ran within Visual Studio using Test Explorer.

You can also run specific examples via the command-line by using test filters (dotnet test --filter). Type dotnet test --help at the command line for more details.

Example:

dotnet test --filter OpenAIAssistant_CodeInterpreter

Configuring Secrets

Each example requires secrets / credentials to access OpenAI or Azure OpenAI.

We suggest using .NET Secret Manager to avoid the risk of leaking secrets into the repository, branches and pull requests. You can also use environment variables if you prefer.

To set your secrets with .NET Secret Manager:

1. Navigate the console to the project folder:

   cd dotnet/samples/GettingStartedWithAgents
   

2. Examine existing secret definitions:

   dotnet user-secrets list
   

3. If needed, perform first time initialization:

   dotnet user-secrets init
   

4. Define secrets for either Open AI:

   dotnet user-secrets set "OpenAI:ChatModelId" "..."
   dotnet user-secrets set "OpenAI:ApiKey" "..."
   

5. Or Azure Open AI:

   dotnet user-secrets set "AzureOpenAI:DeploymentName" "..."
   dotnet user-secrets set "AzureOpenAI:ChatDeploymentName" "..."
   dotnet user-secrets set "AzureOpenAI:Endpoint" "https://... .openai.azure.com/"
   dotnet user-secrets set "AzureOpenAI:ApiKey" "..."
   

NOTE: Azure secrets will take precedence, if both Open AI and Azure Open AI secrets are defined, unless ForceOpenAI is set:

protected override bool ForceOpenAI => true;