mirror of https://github.com/microsoft/semantic-kernel.git synced 2026-10-12 02:19:06 +00:00

Files

T

arminhadzalic a214e129fa .Net: Adapted broken link to KernelFunctionStrategies (#6853 )

### Motivation and Context

Links in samples for GettingStartedWithAgents section should work

### Description

fixed broken link in sample for KernelFunctionStrategies

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x ] The code builds clean without any errors or warnings
- [ ] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ ] All unit tests pass, and I have added new tests where possible
- [ x] I didn't break anyone 😄

2024-06-20 09:39:55 +00:00

4.1 KiB

Raw Permalink Blame History

Semantic Kernel Agents - Getting Started

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

NuGet:

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 getting started with agents examples include:

Example	Description
Step1_Agent	How to create and use an agent.
Step2_Plugins	How to associate plug-ins with an agent.
Step3_Chat	How to create a conversation between agents.
Step4_KernelFunctionStrategies	How to utilize a `KernelFunction` as a chat strategy.
Step5_JsonResult	How to have an agent produce JSON.
Step6_DependencyInjection	How to define dependency injection patterns for agents.
Step7_OpenAIAssistant	How to create 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:

Navigate the console to the project folder:

cd dotnet/samples/GettingStartedWithAgents

Examine existing secret definitions:
```
dotnet user-secrets list
```
If needed, perform first time initialization:
```
dotnet user-secrets init
```

Define secrets for either Open AI:

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

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;

4.1 KiB Raw Permalink Blame History