Class ParameterMetadata

Namespace

SemanticPluginForge.Core

Assembly

SemanticPluginForge.Core.dll

Metadata for a parameter of a function.

public class ParameterMetadata : ParameterMetadataBase

Inheritance

object

ParameterMetadataBase

ParameterMetadata

Inherited Members

ParameterMetadataBase.Description

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 ParameterMetadata class with the name of the parameter.

Constructors

ParameterMetadata(string)

Metadata for a parameter of a function.

public ParameterMetadata(string name)

Parameters

name string

The name of the parameter.

Remarks

Initializes a new instance of the ParameterMetadata class with the name of the parameter.

Properties

DefaultValue

Gets the default value of the parameter.

public object? DefaultValue { get; init; }

Property Value

object

Remarks

If it is set and Suppress is set to true, the parameter won't be visible to LLM to resolve the value, but, the default value will be used.

IsRequired

Gets a value indicating whether the parameter is required.

public bool? IsRequired { get; init; }

Property Value

bool?

Name

Gets the name of the parameter.

public string Name { get; }

Property Value

string

Suppress

Gets if the parameter should be suppressed from the function.

public bool Suppress { get; init; }

Property Value

bool

Remarks

If the parameter is suppressed, but DefaultValue is set, the parameter won't be visible to LLM to resolve the value, but, the default value will be used.