Skip to content

README.md

Latest commit

 

History

History
145 lines (103 loc) · 7.43 KB

README.md

File metadata and controls

145 lines (103 loc) · 7.43 KB

Get Started with Semantic Kernel ⚡

OpenAI / Azure OpenAI API keys

To run the LLM prompts and semantic functions in the examples below, make sure you have an OpenAI API Key or Azure OpenAI Service Key.

Nuget package

Here is a quick example of how to use Semantic Kernel from a C# console app. First, let's create a new project, targeting .NET 6 or newer, and add the Microsoft.SemanticKernel nuget package to your project from the command prompt in Visual Studio:

dotnet add package Microsoft.SemanticKernel

Running prompts with input parameters

Copy and paste the following code into your project, with your Azure OpenAI key in hand:

using Microsoft.SemanticKernel;
using Microsoft.SemanticKernel.Connectors.OpenAI;

var builder = Kernel.CreateBuilder();

builder.AddAzureOpenAIChatCompletion(
         "gpt-35-turbo",                      // Azure OpenAI Deployment Name
         "https://contoso.openai.azure.com/", // Azure OpenAI Endpoint
         "...your Azure OpenAI Key...");      // Azure OpenAI Key

// Alternative using OpenAI
//builder.AddOpenAIChatCompletion(
//         "gpt-3.5-turbo",                  // OpenAI Model name
//         "...your OpenAI API Key...");     // OpenAI API Key

var kernel = builder.Build();

var prompt = @"{{$input}}

One line TLDR with the fewest words.";

var summarize = kernel.CreateFunctionFromPrompt(prompt, executionSettings: new OpenAIPromptExecutionSettings { MaxTokens = 100 });

string text1 = @"
1st Law of Thermodynamics - Energy cannot be created or destroyed.
2nd Law of Thermodynamics - For a spontaneous process, the entropy of the universe increases.
3rd Law of Thermodynamics - A perfect crystal at zero Kelvin has zero entropy.";

string text2 = @"
1. An object at rest remains at rest, and an object in motion remains in motion at constant speed and in a straight line unless acted on by an unbalanced force.
2. The acceleration of an object depends on the mass of the object and the amount of force applied.
3. Whenever one object exerts a force on another object, the second object exerts an equal and opposite on the first.";

Console.WriteLine(await kernel.InvokeAsync(summarize, new() { ["input"] = text1 }));

Console.WriteLine(await kernel.InvokeAsync(summarize, new() { ["input"] = text2 }));

// Output:
//   Energy conserved, entropy increases, zero entropy at 0K.
//   Objects move in response to forces.

Semantic Kernel Notebooks

The repository contains also a few C# Jupyter notebooks that demonstrates how to get started with the Semantic Kernel.

See here for the full list, with requirements and setup instructions.

  1. Getting started
  2. Loading and configuring Semantic Kernel
  3. Running AI prompts from file
  4. Creating Semantic Functions at runtime (i.e. inline functions)
  5. Using Kernel Arguments to Build a Chat Experience
  6. Creating and Executing Plans
  7. Building Memory with Embeddings
  8. Creating images with DALL-E 3
  9. Chatting with ChatGPT and Images
  10. BingSearch using Kernel

Semantic Kernel Samples

The repository also contains the following code samples:

Type Description
GettingStarted Take this step by step tutorial to get started with the Semantic Kernel and get introduced to the key concepts.
GettingStartedWithAgents Take this step by step tutorial to get started with the Semantic Kernel Agents and get introduced to the key concepts.
Concepts This section contains focussed samples which illustrate all of the concepts included in the Semantic Kernel.
Demos Look here to find a sample which demonstrates how to use many of Semantic Kernel features.
LearnResources Code snippets that are related to online documentation sources like Microsoft Learn, DevBlogs and others

Nuget packages

Semantic Kernel provides a set of nuget packages to allow extending the core with more features, such as connectors to services and plugins to perform specific actions. Unless you need to optimize which packages to include in your app, you will usually start by installing this meta-package first:

  • Microsoft.SemanticKernel

This meta package includes core packages and OpenAI connectors, allowing to run most samples and build apps with OpenAI and Azure OpenAI.

Packages included in Microsoft.SemanticKernel:

  1. Microsoft.SemanticKernel.Abstractions: contains common interfaces and classes used by the core and other SK components.
  2. Microsoft.SemanticKernel.Core: contains the core logic of SK, such as prompt engineering, semantic memory and semantic functions definition and orchestration.
  3. Microsoft.SemanticKernel.Connectors.OpenAI: connectors to OpenAI and Azure OpenAI, allowing to run semantic functions, chats, text to image with GPT3, GPT3.5, GPT4, DALL-E3.

Other SK packages available at nuget.org:

  1. Microsoft.SemanticKernel.Connectors.Qdrant: Qdrant connector for plugins and semantic memory.
  2. Microsoft.SemanticKernel.Connectors.Sqlite: SQLite connector for plugins and semantic memory
  3. Microsoft.SemanticKernel.Plugins.Document: Document Plugin: Word processing, OpenXML, etc.
  4. Microsoft.SemanticKernel.Plugins.MsGraph: Microsoft Graph Plugin: access your tenant data, schedule meetings, send emails, etc.
  5. Microsoft.SemanticKernel.Plugins.OpenApi: OpenAPI Plugin.
  6. Microsoft.SemanticKernel.Plugins.Web: Web Plugin: search the web, download files, etc.

Enhancing Documentation

Detailed Explanations and Examples

We have added more detailed explanations and examples to the existing documentation files to help users understand the various features of the repository. These explanations and examples provide a deeper understanding of how to use the Semantic Kernel effectively.

Code Snippets and Usage Examples

To further assist users, we have included more code snippets and usage examples in the documentation. These snippets and examples demonstrate how to use the different features of the repository in practical scenarios.

Repository Structure Explanation

We have added a section that explains the structure of the repository and the purpose of each directory and file. This section helps users navigate the repository and understand the organization of the codebase.