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) | ## Parameters The parameters object defines the function parameters that will be passed to the AI. | Name | Type | Default | Description | |:--|:--|:--|:| | type Required | string | - | Defines the top-level type of the parameters. Must be set to object | | properties Required | object | - | An object containing the [properties](#properties) definitions to be passed to the function | | required Optional | string[] | - | Array of required property names from the properties object | ## Properties The properties object defines the input data that will be passed to the function. It supports different types of parameters, each with their own set of configuration options. The property name is a key in the properties object that is user-defined. | Name | Type | Default | Description | |:--|:--|:--|:| | [key: string] Required | object | - | An object with dynamic property names, where:
| ### Schema Types String Properties
| Name | Type | Default | Description | |:--|:--|:--|:| | type Required | string | - | The type of property the AI is passing to the function. Must be set to string | | description Optional | string | - | A description of the property | | enum Optional | string[] | - | An array of strings that are the possible values | | defaultOptional | string | - | The default string value | | patternOptional | string | - | Regular expression pattern for the string value to match | | nullableOptional | boolean | false | Whether the property can be null | #### Example yaml andJSON parameters: type: object properties: property_name: type: string pattern: ^[a-z]+$ Integer Properties
| Name | Type | Default | Description | |:--|:--|:--|:| | typeRequired | string | - | The type of parameter the AI is passing to the function. Must be set to integer | | descriptionOptional | string | - | A description of the property | | enumOptional | integer[] | - | An array of integers that are the possible values | | defaultOptional | integer | - | The default integer value | | nullableOptional | boolean | false | Whether the property can be null | #### Example yaml andJSON parameters: type: object properties: property_name: type: integer default: 10 Number Properties
| Name | Type | Default | Description | |:--|:--|:--|:| | typeRequired | string | - | The type of parameter the AI is passing to the function. Must be set to number | | descriptionOptional | string | - | A description of the property | | enumOptional | number[] | - | An array of numbers that are the possible values | | defaultOptional | number | - | The default number value | | nullableOptional | boolean | false | Whether the property can be null | #### Example yaml andJSON parameters: type: object properties: property_name: type: number default: 10.5 Boolean Properties
| Name | Type | Default | Description | |:--|:--|:--|:| | typeRequired | string | - | The type of parameter the AI is passing to the function. Must be set to boolean | | descriptionOptional | string | - | A description of the property | | defaultOptional | boolean | - | The default boolean value | | nullableOptional | boolean | false | Whether the property can be null | #### Example yaml andJSON parameters: type: object properties: property_name: type: boolean Array Properties
| Name | Type | Default | Description | |:--|:--|:--|:| | typeRequired | string | - | The type of parameter(s) the AI is passing to the function. Must be set to array | | descriptionOptional | string | - | A description of the property | | itemsRequired | object | - | An array of items. These items must be one of the valid [schema types](#schema-types) | | defaultOptional | array | - | The default array value | | nullableOptional | boolean | false | Whether the property can be null | #### Example yaml andJSON parameters: type: object properties: property_name: type: array items: - type: string default: one enum: - one - two - three - type: object required: - desired_value properties: desired_value: type: string enum: - four - five - six Object Properties
| Name | Type | Default | Description | |:--|:--|:--|:| | typeRequired | string | - | The type of parameter(s) the AI is passing to the function. Must be set to object | | descriptionOptional | string | - | A description of the property | | propertiesOptional | object | - | An object that contains the [properties](#properties) definitions to be passed to the function. | | requiredOptional | string[] | - | The property names that are required for the properties object | | defaultOptional | object | - | The default object value | | nullableOptional | boolean | false | Whether the property can be null | #### Example yaml andJSON parameters: type: object properties: name: type: string age: type: integer address: type: object properties: street: type: string city: type: string required: - street - city oneOf Property
Specifies that the data must be valid against exactly one of the provided schemas. | Name | Type | Default | Description | |:--|:--|:--|:| | oneOf Required | array | - | An array of schemas where exactly one must be valid.
The value must be a valid [schema type](#schema-types) | #### Example yaml andJSON parameters: type: object properties: property_name: oneOf: - type: string - type: integer allOf Property
Specifies that the data must be valid against all of the provided schemas. | Name | Type | Default | Description | |:--|:--|:--|:| | allOf Required | array | - | An array of schemas where all must be valid.
The value must be a valid [schema type](#schema-types) | #### Example yaml andJSON parameters: type: object properties: property_name: allOf: - type: string - type: integer anyOf Property
Specifies that the data must be valid against at least one of the provided schemas. | Name | Type | Default | Description | |:--|:--|:--|:| | anyOf Required | array | - | An array of schemas where at least one must be valid.
The value must be a valid [schema type](#schema-types) | #### Example yaml andJSON parameters: type: object properties: property_name: anyOf: - type: string - type: integer const Property
Specifies an exact value that the data must match. | Name | Type | Default | Description | |:--|:--|:--|:| | const Required | any | - | The value that will be set as a constant value for the property | #### Example yaml andJSON parameters: type: object properties: property_name: const: constant_value