functions.parameters
The parameters object is used to define the input data that will be passed to the function.
| Name | Type | Default | Description |
|---|---|---|---|
parametersOptional | object | - | An object that contains the parameters. |
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
typeRequired | string | - | The type of parameter the AI is passing to the function. Possible Values: "string", "object". |
propertiesRequired | object | - | An object that contains the properties Parameters. |
properties
The properties object is used to define the properties of the parameters object.
A user-defined key is used to define the property, and the value is an object that defines the type and description of the parameters object.
properties Parameters
| Name | Type | Default | Description |
|---|---|---|---|
[key: string]Required | object | - | The user-defined key for the property. |
[key: string].typeRequired | string | - | The type of the property. Possible Values: "string", "object". |
[key: string].descriptionRequired | string | - | A description of the property. |