SemanticKernel.Assistants 1.3.1

.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package SemanticKernel.Assistants --version 1.3.1                

                    
                

            
NuGet\Install-Package SemanticKernel.Assistants -Version 1.3.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="SemanticKernel.Assistants" Version="1.3.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add SemanticKernel.Assistants --version 1.3.1                

                    
                

            
#r "nuget: SemanticKernel.Assistants, 1.3.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install SemanticKernel.Assistants as a Cake Addin
#addin nuget:?package=SemanticKernel.Assistants&version=1.3.1

// Install SemanticKernel.Assistants as a Cake Tool
#tool nuget:?package=SemanticKernel.Assistants&version=1.3.1

Assistants for Semantic Kernel

This is assistant support for the Semantic Kernel.

This enables the usage of assistants for the Semantic Kernel without relying on OpenAI Assistant APIs. It runs locally planners and plugins for the assistants.

It provides different scenarios for the usage of assistants such as:

  • Assistant with Semantic Kernel plugins
  • Multi-Assistant conversation

As the assistants are using the Semantic Kernel, you can use your own model for the assistants and host them locally (see: Bring you own model for more details.).

Usage

  1. Create you agent description file in yaml: 
    name: Mathematician
description: A mathematician that resolves given maths problems.
instructions: |
  You are a mathematician.
  Given a math problem, you must answer it with the best calculation formula.
  No need to show your work, just give the answer to the math problem.
  Use calculation results.
input_parameter: 
  default_value: ""
  description: |
      The word mathematics problem to solve in 2-3 sentences.
      Make sure to include all the input variables needed along with their values and units otherwise the math function will not be able to solve it.
execution_settings:
  planner: Handlebars
  prompt_settings: 
    temperature: 0.0
    top_p: 1
    max_tokens: 2000
  2. Instanciate your assistant in your code: 
     string azureOpenAIChatCompletionDeployment = configuration["AzureOpenAIDeploymentName"]!;
 string azureOpenAIEndpoint = configuration["AzureOpenAIEndpoint"]!;
 string azureOpenAIKey = configuration["AzureOpenAIAPIKey"]!;

 var mathKernel = Kernel.CreateBuilder()
                                     .AddAzureOpenAIChatCompletion(azureOpenAIChatCompletionDeployment, azureOpenAIEndpoint, azureOpenAIKey)
                                     .Build();

 mathKernel.ImportPluginFromObject(new MathPlugin());

 var mathematician = AssistantBuilder.FromTemplate("./Assistants/Mathematician.yaml")
                                     .WithKernel(mathKernel)
                                     .Build();

    var thread = mathematician.CreateThread();
await thread.InvokeAsync("Your ask to the assistant.");

Bring you own model ?

As the assistants are using the Semantic Kernel, you can use your own model for the assistants. For example, you can use the Ollama model for the assistants.

This could be achieved by using the Ollama connector for the Semantic Kernel:

using Codeblaze.SemanticKernel.Connectors.Ollama;

string ollamaEndpoint = configuration["OllamaEndpoint"]!;

var butlerKernel = Kernel.CreateBuilder()
                    .AddOllamaChatCompletion("phi:latest", ollamaEndpoint)
                    .Build();

assistant = AssistantBuilder.FromTemplate("./Assistants/Butler.yaml")
        .WithKernel(butlerKernel)
        .Build();

License

This project is licensed under the MIT License.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on SemanticKernel.Assistants:

Package Downloads
SemanticKernel.Assistants.AutoGen

This enables the usage of AutoGen assistants for the Semantic Kernel. It provides different scenarios for the usage of assistants such as: - **Assistant with Semantic Kernel plugins** - **Multi-Assistant conversation** - **AutoGen conversation** (see [AutoGen](#autogen) for more details)

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.21.1 147 10/1/2024
1.17.1 226 8/14/2024
1.17.0 112 8/8/2024
1.14.0 505 6/5/2024
1.13.1 128 6/2/2024
1.13.0 198 5/21/2024
1.12.0 115 5/17/2024
1.10.1 152 5/1/2024
1.10.0 91 5/1/2024
1.7.3 143 4/8/2024
1.7.2 136 4/8/2024
1.7.1 144 4/7/2024
1.6.3 171 3/24/2024
1.6.2 153 3/24/2024
1.5.3 199 3/3/2024
1.5.2 164 3/3/2024
1.5.1 128 3/3/2024
1.5.0 146 3/2/2024
1.3.3 194 2/10/2024
1.3.1 121 2/6/2024
1.3.0 115 2/1/2024
1.2.0-preview 84 1/27/2024
1.1.1-peview 98 1/22/2024
1.1.0-preview 90 1/18/2024
1.0.4-preview 108 1/5/2024
1.0.3-preview 134 12/20/2023
1.0.2-preview 109 12/19/2023
1.0.1-rc4 114 12/16/2023
1.0.1-rc3 115 12/11/2023
1.0.1-preview 120 12/19/2023
1.0.0-rc3 117 12/10/2023
0.0.1-alpha 144 1/5/2024