KernelPlugin Class

Definition

Namespace:

Microsoft.SemanticKernel

Assembly:

Microsoft.SemanticKernel.Abstractions.dll

Package:

Microsoft.SemanticKernel.Abstractions v1.45.0

Represents a plugin that may be registered with a Kernel.

public abstract class KernelPlugin : System.Collections.Generic.IEnumerable<Microsoft.SemanticKernel.KernelFunction>

type KernelPlugin = class
    interface seq<KernelFunction>
    interface IEnumerable

Public MustInherit Class KernelPlugin
Implements IEnumerable(Of KernelFunction)

Inheritance

Object

KernelPlugin

Implements

IEnumerable<KernelFunction> IEnumerable

Remarks

A plugin is a named read-only collection of functions. There is a many-to-many relationship between plugins and functions: a plugin may contain any number of functions, and a function may exist in any number of plugins.

Constructors

KernelPlugin(String, String)

Initializes the new plugin from the provided name, description, and function collection.

Properties

Description	Gets a description of the plugin.
FunctionCount	Gets the number of functions in this plugin.
Item[String]	Gets the function in the plugin with the specified name.
Name	Gets the name of the plugin.

Methods

AsAIFunctions(Kernel)	Produces an AIFunction for every KernelFunction in this plugin.
Contains(KernelFunction)	Gets whether the plugin contains a function.
Contains(String)	Gets whether the plugin contains a function with the specified name.
GetEnumerator()	Returns an enumerator that iterates through the collection.
GetFunctionsMetadata()	Gets a collection of KernelFunctionMetadata instances, one for every function in this plugin.
TryGetFunction(String, KernelFunction)	Finds a function in the plugin by name.

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.