KernelPluginExtensions.TryGetFunction Method

Reference

Definition

Namespace:: Microsoft.SemanticKernel

Assembly:: Microsoft.SemanticKernel.Abstractions.dll

Package:: Microsoft.SemanticKernel.Abstractions v1.20.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets a function from the collection by plugin and function names.

public static bool TryGetFunction (this Microsoft.SemanticKernel.IReadOnlyKernelPluginCollection plugins, string? pluginName, string functionName, out Microsoft.SemanticKernel.KernelFunction? func);

static member TryGetFunction : Microsoft.SemanticKernel.IReadOnlyKernelPluginCollection * string * string * KernelFunction -> bool

<Extension()>
Public Function TryGetFunction (plugins As IReadOnlyKernelPluginCollection, pluginName As String, functionName As String, ByRef func As KernelFunction) As Boolean

Parameters

plugins: IReadOnlyKernelPluginCollection

The collection.

pluginName: String

The name of the plugin storing the function.

functionName: String

The name of the function.

func: KernelFunction

The function, if found.

Returns

Boolean

true if the specified plugin was found and the specified function was found in that plugin; otherwise, false.

Remarks

If pluginName is null or entirely whitespace, all plugins are searched for a function with the specified name, and the first one found is returned.

Applies to

Share via