parameters | SignalWire

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

Properties

functions[].parameters

object

An object that accepts the following properties.

parameters.type

stringRequired

Defines the top-level type of the parameters. Must be set to "object"

parameters.properties

objectRequired

An object containing the properties definitions to be passed to the function

properties.{property_name}

objectRequired

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. An object with dynamic property names, where:

Keys: User-defined strings, that set the property name.
Values: Must be one of the valid schema types. Learn more about valid schema types from the JSON Schema documentation

Schema Types

Each property in the properties object must use one of the following schema types:

string

integer

number

boolean

array

object

oneOf

allOf

anyOf

const

{property_name}.type

stringRequired

The type of property the AI is passing to the function. Must be set to "string"

{property_name}.description

string

A description of the property

{property_name}.enum

string[]

An array of strings that are the possible values

{property_name}.default

string

The default string value

{property_name}.pattern

string

Regular expression pattern for the string value to match

{property_name}.nullable

booleanDefaults to false

Whether the property can be null

1 parameters:
2   type: object
3   properties:
4     property_name:
5       type: string
6       description: A string value
7       pattern: ^[a-z]+$

parameters.required

string[]

Array of required property names from the properties object