Vapi · Schema

OpenAIFunctionParameters

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
type string This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.
properties object This provides a description of the properties required by the function. JSON Schema can be used to specify expectations for each property. Refer to [this doc](https://ajv.js.org/json-schema.html#json-
required array This specifies the properties that are required by the function.
View JSON Schema on GitHub

JSON Schema

vapi-openaifunctionparameters-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OpenAIFunctionParameters",
  "title": "OpenAIFunctionParameters",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.",
      "enum": [
        "object"
      ]
    },
    "properties": {
      "type": "object",
      "description": "This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonSchema"
      }
    },
    "required": {
      "description": "This specifies the properties that are required by the function.",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "type",
    "properties"
  ]
}