Class FunctionParameter

Namespace

Glitch9.AIDevKit.Components

Represents a single parameter in a function declaration.

[Serializable]
public class FunctionParameter

Inheritance

object

FunctionParameter

Constructors

FunctionParameter(JsonSchemaType, string, JsonSchemaType?)

public FunctionParameter(JsonSchemaType type, string name, JsonSchemaType? elementType = null)

Parameters

type JsonSchemaType

name string

elementType JsonSchemaType?

FunctionParameter(string, Type)

public FunctionParameter(string name, Type paramType)

Parameters

name string

paramType Type

Properties

Description

Parameter description.

public string Description { get; }

Property Value

string

ElementType

For array types, defines the element type.

public JsonSchemaType ElementType { get; }

Property Value

JsonSchemaType

EnumValues

If the parameter is an enum, its valid values.

public string[] EnumValues { get; }

Property Value

string[]

IsRequired

Whether the parameter is required.

public bool IsRequired { get; }

Property Value

bool

Name

The parameter name.

public string Name { get; }

Property Value

string

Type

The JSON-compatible data type.

public JsonSchemaType Type { get; }

Property Value

JsonSchemaType