AIFunctionParameterMetadata Class

Definition

Namespace:

Microsoft.Extensions.AI

Assembly:

Microsoft.Extensions.AI.Abstractions.dll

Package:

Microsoft.Extensions.AI.Abstractions v9.0.0-preview.9.24556.5

Provides read-only metadata for a AIFunction parameter.

public ref class AIFunctionParameterMetadata sealed

public sealed class AIFunctionParameterMetadata

type AIFunctionParameterMetadata = class

Public NotInheritable Class AIFunctionParameterMetadata

Inheritance

Object

AIFunctionParameterMetadata

Constructors

AIFunctionParameterMetadata(AIFunctionParameterMetadata)	Initializes a new instance of the AIFunctionParameterMetadata class as a copy of another AIFunctionParameterMetadata.
AIFunctionParameterMetadata(String)	Initializes a new instance of the AIFunctionParameterMetadata class for a parameter with the specified name.

Properties

DefaultValue	Gets the default value of the parameter.
Description	Gets a description of the parameter, suitable for use in describing the purpose to a model.
HasDefaultValue	Gets a value indicating whether the parameter has a default value.
IsRequired	Gets a value indicating whether the parameter is required.
Name	Gets the name of the parameter.
ParameterType	Gets the .NET type of the parameter.
Schema	Gets a JSON Schema describing the parameter's type.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)