Skip to content

Files

Latest commit

 

History

History
143 lines (99 loc) · 7.75 KB

README.md

File metadata and controls

143 lines (99 loc) · 7.75 KB

Semantic Kernel Agents - Getting Started

This project contains a step by step guide to get started with Semantic Kernel Agents.

NuGet

Source

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

Examples

The getting started with agents examples include:

ChatCompletion

Example Description
Step01_Agent How to create and use an agent.
Step02_Plugins How to associate plug-ins with an agent.
Step03_Chat How to create a conversation between agents.
Step04_KernelFunctionStrategies How to utilize a KernelFunction as a chat strategy.
Step05_JsonResult How to have an agent produce JSON.
Step06_DependencyInjection How to define dependency injection patterns for agents.
Step07_Telemetry How to enable logging for agents.

Open AI Assistant

Example Description
Step01_Assistant How to create an Open AI Assistant agent.
Step02_Assistant_Plugins How to create an Open AI Assistant agent.
Step03_Assistant_Vision How to provide an image as input to an Open AI Assistant agent.
Step04_AssistantTool_CodeInterpreter_ How to use the code-interpreter tool for an Open AI Assistant agent.
Step05_AssistantTool_FileSearch How to use the file-search tool for an Open AI Assistant agent.

Azure AI Agent

Example Description
Step01_AzureAIAgent How to create an Azure AI agent.
Step02_AzureAIAgent_Plugins How to create an Azure AI agent.
Step03_AzureAIAgent_Chat How create a conversation with Azure AI agents.
Step04_AzureAIAgent_CodeInterpreter How to use the code-interpreter tool for an Azure AI agent.
Step05_AzureAIAgent_FileSearch How to use the file-search tool for an Azure AI agent.
Step06_AzureAIAgent_OpenAPI How to use the Open API tool for an Azure AI agent.

Bedrock Agent

Example Description
Step01_BedrockAgent How to create a Bedrock agent and interact with it in the most basic way.
Step02_BedrockAgent_CodeInterpreter How to use the code-interpreter tool with a Bedrock agent.
Step03_BedrockAgent_Functions How to use kernel functions with a Bedrock agent.
Step04_BedrockAgent_Trace How to enable tracing for a Bedrock agent to inspect the chain of thoughts.
Step05_BedrockAgent_FileSearch How to use file search with a Bedrock agent (i.e. Bedrock knowledge base).
Step06_BedrockAgent_AgentChat How to create a conversation between two agents and one of them in a Bedrock agent.

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 with Filters

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 Step3_Chat

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:ChatDeploymentName" "gpt-4o"
dotnet user-secrets set "AzureOpenAI:Endpoint" "https://... .openai.azure.com/"
dotnet user-secrets set "AzureOpenAI:ApiKey" "..."

  6. Or Azure AI:

    dotnet user-secrets set "AzureAI:ConnectionString" "..."
dotnet user-secrets set "AzureAI:ChatModelId" "gpt-4o"

  7. Or Bedrock:

    dotnet user-secrets set "BedrockAgent:AgentResourceRoleArn" "arn:aws:iam::...:role/..."
dotnet user-secrets set "BedrockAgent:FoundationModel" "..."

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;