Skip to main content

functions.argument

The argument object is used to define the input data that will be passed to the function.

NameTypeDefaultDescription
argumentRequiredobject-An object that contains the argument Parameters.

argument Parameters

NameTypeDefaultDescription
typeRequiredstring-The type of argument the AI is passing to the function.
Possible Values: "string", "object".
propertiesRequiredobject-An object that contains the properties Parameters.

properties

The properties object is used to define the properties of the argument. A user-defined key is used to define the property, and the value is an object that defines the type and description of the argument.

properties Parameters

NameTypeDefaultDescription
[key: string]Requiredobject-The user-defined key for the property.
[key: string].typeRequiredstring-The type of the property.
Possible Values: "string", "object".
[key: string].descriptionRequiredstring-A description of the property.