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

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 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: 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

string

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

parameters:
  type: object
  properties:
    property_name:
      type: string
      description: A string value
      pattern: ^[a-z]+$

JSON

{
  "parameters": {
    "type": "object",
    "properties": {
      "property_name": {
        "type": "string",
        "description": "A string value",
        "pattern": "^[a-z]+$"
      }
    }
  }
}

integer

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

parameters:
  type: object
  properties:
    property_name:
      type: integer
      description: An integer value
      default: 10

JSON

{
  "parameters": {
    "type": "object",
    "properties": {
      "property_name": {
        "type": "integer",
        "description": "An integer value",
        "default": 10
      }
    }
  }
}

number

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

parameters:
  type: object
  properties:
    property_name:
      type: number
      description: A number value
      default: 10.5

JSON

{
  "parameters": {
    "type": "object",
    "properties": {
      "property_name": {
        "type": "number",
        "description": "A number value",
        "default": 10.5
      }
    }
  }
}

boolean

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

parameters:
  type: object
  properties:
    property_name:
      type: boolean
      description: A boolean value

JSON

{
  "parameters": {
    "type": "object",
    "properties": {
      "property_name": {
        "type": "boolean",
        "description": "A boolean value"
      }
    }
  }
}

array

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
defaultOptional	array	-	The default array value
nullableOptional	boolean	false	Whether the property can be null

Example

YAML

parameters:
  type: object
  properties:
    property_name:
      type: array
      description: Array of strings and objects
      items:
        - type: string
          description: A single string value that must be one of the possible values
          default: "one"
          enum:
            - "one"
            - "two"
            - "three"
        - type: object
          description: An object with a required property, `desired_value`, that must be one of the possible values
          required:
            - desired_value
          properties:
            desired_value:
              type: string
              description: A single string value that must be one of the possible values
              enum:
                - "four"
                - "five"
                - "six"

JSON

{
  "parameters": {
    "type": "object",
    "properties": {
      "property_name": {
        "type": "array",
        "description": "Array of strings and objects",
        "items": [
          {
            "type": "string",
            "description": "A single string value that must be one of the possible values",
            "default": "one",
            "enum": [
              "one",
              "two",
              "three"
            ]
          },
          {
            "type": "object",
            "description": "An object with a required property, `desired_value`, that must be one of the possible values",
            "required": [
              "desired_value"
            ],
            "properties": {
              "desired_value": {
                "type": "string",
                "description": "A single string value that must be one of the possible values",
                "enum": [
                  "four",
                  "five",
                  "six"
                ]
              }
            }
          }
        ]
      }
    }
  }
}

object

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 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

parameters:
  type: object
  properties:
    name:
      type: string
      description: The user's name
    age:
      type: integer
      description: The user's age
    address:
      type: object
      description: The user's address
      properties:
        street:
          type: string
          description: The user's street address
        city:
          type: string
          description: The user's city
      required:
        - street
        - city

JSON

{
  "parameters": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string",
        "description": "The user's name"
      },
      "age": {
        "type": "integer",
        "description": "The user's age"
      },
      "address": {
        "type": "object",
        "description": "The user's address",
        "properties": {
          "street": {
            "type": "string",
            "description": "The user's street address"
          },
          "city": {
            "type": "string",
            "description": "The user's city"
          }
        },
        "required": [
          "street",
          "city"
        ]
      }
    }
  }
}

oneOf

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

Example

YAML

parameters:
  type: object
  properties:
    property_name:
      oneOf:
        - type: string
          description: A string value
        - type: integer
          description: An integer value

JSON

{
  "parameters": {
    "type": "object",
    "properties": {
      "property_name": {
        "oneOf": [
          {
            "type": "string",
            "description": "A string value"
          },
          {
            "type": "integer",
            "description": "An integer value"
          }
        ]
      }
    }
  }
}

allOf

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

Example

YAML

parameters:
  type: object
  properties:
    property_name:
      allOf:
        - type: string
          description: A string value
        - type: integer
          description: An integer value

JSON

{
  "parameters": {
    "type": "object",
    "properties": {
      "property_name": {
        "allOf": [
          {
            "type": "string",
            "description": "A string value"
          },
          {
            "type": "integer",
            "description": "An integer value"
          }
        ]
      }
    }
  }
}

anyOf

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

Example

YAML

parameters:
  type: object
  properties:
    property_name:
      anyOf:
        - type: string
          description: A string value
        - type: integer
          description: An integer value

JSON

{
  "parameters": {
    "type": "object",
    "properties": {
      "property_name": {
        "anyOf": [
          {
            "type": "string",
            "description": "A string value"
          },
          {
            "type": "integer",
            "description": "An integer value"
          }
        ]
      }
    }
  }
}

const

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

parameters:
  type: object
  properties:
    property_name:
      const: "constant_value"

JSON

{
  "parameters": {
    "type": "object",
    "properties": {
      "property_name": {
        "const": "constant_value"
      }
    }
  }
}