Share via


KernelParameterMetadata Class

Definition

Provides read-only metadata for a KernelFunction parameter.

public sealed class KernelParameterMetadata
type KernelParameterMetadata = class
Public NotInheritable Class KernelParameterMetadata
Inheritance
KernelParameterMetadata

Constructors

KernelParameterMetadata(KernelParameterMetadata)

Initializes a KernelParameterMetadata as a copy of another KernelParameterMetadata.

KernelParameterMetadata(String)

Initializes the KernelParameterMetadata for a parameter with the specified name.

Properties

DefaultValue

Gets the default value of the parameter.

Description

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

IsRequired

Gets whether the parameter is required.

Name

Gets the name of the function.

ParameterType

Gets the .NET type of the parameter.

Schema

Gets a JSON Schema describing the parameter's type.

Applies to