Encamina.Enmarcha.SemanticKernel.Abstractions 8.1.5-preview-10

This is a prerelease version of Encamina.Enmarcha.SemanticKernel.Abstractions.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Encamina.Enmarcha.SemanticKernel.Abstractions --version 8.1.5-preview-10                
NuGet\Install-Package Encamina.Enmarcha.SemanticKernel.Abstractions -Version 8.1.5-preview-10                
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="Encamina.Enmarcha.SemanticKernel.Abstractions" Version="8.1.5-preview-10" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Encamina.Enmarcha.SemanticKernel.Abstractions --version 8.1.5-preview-10                
#r "nuget: Encamina.Enmarcha.SemanticKernel.Abstractions, 8.1.5-preview-10"                
#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 Encamina.Enmarcha.SemanticKernel.Abstractions as a Cake Addin
#addin nuget:?package=Encamina.Enmarcha.SemanticKernel.Abstractions&version=8.1.5-preview-10&prerelease

// Install Encamina.Enmarcha.SemanticKernel.Abstractions as a Cake Tool
#tool nuget:?package=Encamina.Enmarcha.SemanticKernel.Abstractions&version=8.1.5-preview-10&prerelease                

Semantic Kernel - Abstractions

Nuget package

This project mainly contains abstractions used by other ENMARCHA NuGet packages. Additionally, it includes extension methods and utilities primarily related to Semantic Kernel.

Setup

Nuget package

First, install NuGet. Then, install Encamina.Enmarcha.SemanticKernel.Abstractions from the package manager console:

PM> Install-Package Encamina.Enmarcha.SemanticKernel.Abstractions

.NET CLI:

Install .NET CLI. Next, install Encamina.Enmarcha.SemanticKernel.Abstractions from the .NET CLI:

dotnet add package Encamina.Enmarcha.SemanticKernel.Abstractions

How to use

In addition to the abstractions such as interfaces or abstract classes, which have their implementations in other ENMARCHA NuGets (for example, IMemoryManager/MemoryManager), there are some utilities that can be used directly.

ILengthFunctions

// Entry point
var tokenCount = ILengthFunctions.LengthByTokenCount("This text contains 5 tokens");
// tokenCount = 5

The above code returns the number of tokens in the text using the GPT-3 tokenizer.

SemanticKernelOptions

// ...
  "SemanticKernelOptions": {
    "ChatModelName": "gpt-35-turbo", // Name (sort of a unique identifier) of the model to use for chat
    "ChatModelDeploymentName": "gpt-35-turbo", // Model deployment name on the LLM (for example OpenAI) to use for chat
    "EmbeddingsModelName": "text-embedding-ada-002", // Name (sort of a unique identifier) of the model to use for embeddings
    "EmbeddingsModelDeploymentName": "text-embedding-ada-002", // Model deployment name on the LLM (for example OpenAI) to use for embeddings
    "Endpoint": "https://your-url.openai.azure.com/", // Uri for an LLM resource (like OpenAI). This should include protocol and hostname.
    "Key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", // Key credential used to authenticate to an LLM resource
    // ....
  },
// ...

The above section is taken from a JSON file that is typically added to the appsettings.json. This provides the necessary configurations for Semantic Kernel to operate.

Once these configurations are defined, they can be added to the application's configuration.

var builder = WebApplication.CreateBuilder(new WebApplicationOptions
{
    // ...
});

// ...

// Or others configuration providers...
builder.Configuration.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);

builder.Services.AddOptions<SemanticKernelOptions>().Bind(builder.Configuration.GetSection(nameof(SemanticKernelOptions)))
    .ValidateDataAnnotations()
    .ValidateOnStart();

SKContextExtensions

This class provides some static methods to obtain information/functionality about SKContext.

// ...

var resultContext = await kernel.RunAsync(contextVariables);

// Extensions method from SKContextExtensions
resultContext.ValidateAndThrowIfErrorOccurred();
var maxWordCount = resultContext.GetContextVariable("dummycontextvariable");
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 netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen 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 (4)

Showing the top 4 NuGet packages that depend on Encamina.Enmarcha.SemanticKernel.Abstractions:

Package Downloads
Encamina.Enmarcha.SemanticKernel

Package Description

Encamina.Enmarcha.SemanticKernel.Plugins.Chat

Package Description

Encamina.Enmarcha.SemanticKernel.Connectors.Memory

Package Description

Encamina.Enmarcha.SemanticKernel.Plugins.Memory

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
8.2.0 705 10/22/2024
8.2.0-preview-01-m01 166 9/17/2024
8.1.9-preview-03 244 11/19/2024
8.1.9-preview-02 121 10/22/2024
8.1.9-preview-01 389 10/4/2024
8.1.8 338 9/23/2024
8.1.8-preview-07 807 9/12/2024
8.1.8-preview-06 320 9/11/2024
8.1.8-preview-05 168 9/10/2024
8.1.8-preview-04 470 8/16/2024
8.1.8-preview-03 238 8/13/2024
8.1.8-preview-02 164 8/13/2024
8.1.8-preview-01 175 8/12/2024
8.1.7 175 8/7/2024
8.1.7-preview-09 272 7/3/2024
8.1.7-preview-08 150 7/2/2024
8.1.7-preview-07 150 6/10/2024
8.1.7-preview-06 134 6/10/2024
8.1.7-preview-05 172 6/6/2024
8.1.7-preview-04 140 6/6/2024
8.1.7-preview-03 166 5/24/2024
8.1.7-preview-02 142 5/10/2024
8.1.7-preview-01 170 5/8/2024
8.1.6 1,513 5/7/2024
8.1.6-preview-08 122 5/2/2024
8.1.6-preview-07 155 4/29/2024
8.1.6-preview-06 520 4/26/2024
8.1.6-preview-05 163 4/24/2024
8.1.6-preview-04 185 4/22/2024
8.1.6-preview-03 143 4/22/2024
8.1.6-preview-02 199 4/17/2024
8.1.6-preview-01 251 4/15/2024
8.1.5 179 4/15/2024
8.1.5-preview-15 157 4/10/2024
8.1.5-preview-14 184 3/20/2024
8.1.5-preview-13 137 3/18/2024
8.1.5-preview-12 170 3/13/2024
8.1.5-preview-11 150 3/13/2024
8.1.5-preview-10 165 3/13/2024
8.1.5-preview-09 123 3/12/2024
8.1.5-preview-08 168 3/12/2024
8.1.5-preview-07 166 3/8/2024
8.1.5-preview-06 378 3/8/2024
8.1.5-preview-05 154 3/7/2024
8.1.5-preview-04 161 3/7/2024
8.1.5-preview-03 162 3/7/2024
8.1.5-preview-02 268 2/28/2024
8.1.5-preview-01 221 2/19/2024
8.1.4 332 2/15/2024
8.1.3 208 2/13/2024
8.1.3-preview-07 152 2/13/2024
8.1.3-preview-06 159 2/12/2024
8.1.3-preview-05 167 2/9/2024
8.1.3-preview-04 177 2/8/2024
8.1.3-preview-03 141 2/7/2024
8.1.3-preview-02 151 2/2/2024
8.1.3-preview-01 147 2/2/2024
8.1.2 289 2/1/2024
8.1.2-preview-9 164 1/22/2024
8.1.2-preview-8 139 1/19/2024
8.1.2-preview-7 146 1/19/2024
8.1.2-preview-6 152 1/19/2024
8.1.2-preview-5 140 1/19/2024
8.1.2-preview-4 146 1/19/2024
8.1.2-preview-3 148 1/18/2024
8.1.2-preview-2 188 1/18/2024
8.1.2-preview-16 149 1/31/2024
8.1.2-preview-15 143 1/31/2024
8.1.2-preview-14 270 1/25/2024
8.1.2-preview-13 142 1/25/2024
8.1.2-preview-12 152 1/23/2024
8.1.2-preview-11 155 1/23/2024
8.1.2-preview-10 123 1/22/2024
8.1.2-preview-1 136 1/18/2024
8.1.1 218 1/18/2024
8.1.0 155 1/18/2024
8.0.3 328 12/29/2023
8.0.1 204 12/14/2023
8.0.0 236 12/7/2023
6.0.4.3 295 12/29/2023
6.0.4.2 278 12/20/2023
6.0.4.1 323 12/19/2023
6.0.4 294 12/4/2023
6.0.3.20 238 11/27/2023
6.0.3.19 244 11/22/2023