Class FunctionParameter
Represents a single parameter in a function declaration.
Inheritance
object
FunctionParameter
Namespace: Glitch9.AIDevKit.Components
Assembly: .dll
Syntax
[Serializable]
public class FunctionParameterConstructors
FunctionParameter(JsonSchemaType, string, JsonSchemaType?)
Declaration
public FunctionParameter(JsonSchemaType type, string name, JsonSchemaType? elementType = null)Parameters
| Type | Name | Description |
|---|---|---|
| JsonSchemaType | type | |
| string | name | |
| JsonSchemaType? | elementType |
FunctionParameter(string, Type)
Declaration
public FunctionParameter(string name, Type paramType)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | |
| Type | paramType |
Properties
Description
Parameter description.
Declaration
public string Description { get; }Property Value
| Type | Description |
|---|---|
| string |
ElementType
For array types, defines the element type.
Declaration
public JsonSchemaType ElementType { get; }Property Value
| Type | Description |
|---|---|
| JsonSchemaType |
EnumValues
If the parameter is an enum, its valid values.
Declaration
public string[] EnumValues { get; }Property Value
| Type | Description |
|---|---|
| string[] |
IsRequired
Whether the parameter is required.
Declaration
public bool IsRequired { get; }Property Value
| Type | Description |
|---|---|
| bool |
Name
The parameter name.
Declaration
public string Name { get; }Property Value
| Type | Description |
|---|---|
| string |
Type
The JSON-compatible data type.
Declaration
public JsonSchemaType Type { get; }Property Value
| Type | Description |
|---|---|
| JsonSchemaType |