Class FunctionMetadata

Namespace

SemanticPluginForge.Core

Assembly

SemanticPluginForge.Core.dll

This model contains all necessary information to make changes to the KernelFunction.

public class FunctionMetadata

Inheritance

object

FunctionMetadata

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Initializes a new instance of the FunctionMetadata class with the name of the function.

Constructors

FunctionMetadata(string)

This model contains all necessary information to make changes to the KernelFunction.

public FunctionMetadata(string name)

Parameters

name string

The name of the function.

Remarks

Initializes a new instance of the FunctionMetadata class with the name of the function.

Properties

AdditionalProperties

Gets any additional properties associated with the function.

public ReadOnlyDictionary<string, object?>? AdditionalProperties { get; init; }

Property Value

ReadOnlyDictionary<string, object>

Description

Gets the description of the function, suitable for use in describing the purpose to a model.

public string? Description { get; init; }

Property Value

string

Name

Gets the name of the function. This name should match the name of the function in the plugin. It is used to identify the function in the plugin and to call it.

public string Name { get; init; }

Property Value

string

OverrideFunctionName

Gets the name of the function to override in the plugin. This is used to specify a different name for the function in the plugin than the one defined in the actual plugin.

public string? OverrideFunctionName { get; init; }

Property Value

string

Parameters

Gets the parameters of the function.

public IReadOnlyList<ParameterMetadata>? Parameters { get; init; }

Property Value

IReadOnlyList<ParameterMetadata>

ReturnParameter

Gets the return parameter of the function.

public ReturnParameterMetadata? ReturnParameter { get; init; }

Property Value

ReturnParameterMetadata

Suppress

Gets if the function should be suppressed from the plugin.

public bool Suppress { get; init; }

Property Value

bool