Class FunctionParameterContract

Namespace

AutoGen.Core

Assembly

AutoGen.Core.dll

public class FunctionParameterContract

Inheritance

object

FunctionParameterContract

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

DefaultValue

The default value of the parameter.

public object? DefaultValue { get; set; }

Property Value

object

Description

The description of the parameter. This will be extracted from the param section of the structured comment if available. Otherwise, the description will be null.

public string? Description { get; set; }

Property Value

string

IsRequired

If the parameter is a required parameter.

public bool IsRequired { get; set; }

Property Value

bool

Name

The name of the parameter.

public string? Name { get; set; }

Property Value

string

ParameterType

The type of the parameter.

[JsonIgnore]
public Type? ParameterType { get; set; }

Property Value

Type

Operators

implicit operator AIFunctionParameterMetadata(FunctionParameterContract)

public static implicit operator AIFunctionParameterMetadata(FunctionParameterContract contract)

Parameters

contract FunctionParameterContract

Returns

AIFunctionParameterMetadata

implicit operator FunctionParameterContract(AIFunctionParameterMetadata)

public static implicit operator FunctionParameterContract(AIFunctionParameterMetadata metadata)

Parameters

metadata AIFunctionParameterMetadata

Returns

FunctionParameterContract