Skip to content

Latest commit

 

History

History
99 lines (67 loc) · 4.86 KB

README.md

File metadata and controls

99 lines (67 loc) · 4.86 KB
Raw

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:

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_Logging How to enable logging for agents.
Step08_Assistant How to create an Open AI Assistant agent.
Step09_Assistant How to provide an image as input to an Open AI Assistant agent.
Step10_Assistant How to use the code-interpreter tool for an Open AI Assistant agent.
Step11_Assistant How to use the file-search tool for an Open AI Assistant 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: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;