Vapi · Schema

CreateTestSuiteTestVoiceDto

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
scorers array These are the scorers used to evaluate the test.
type string This is the type of the test, which must be voice.
script string This is the script to be used for the voice test.
numAttempts number This is the number of attempts allowed for the test.
name string This is the name of the test.
View JSON Schema on GitHub

JSON Schema

vapi-createtestsuitetestvoicedto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateTestSuiteTestVoiceDto",
  "title": "CreateTestSuiteTestVoiceDto",
  "type": "object",
  "properties": {
    "scorers": {
      "type": "array",
      "description": "These are the scorers used to evaluate the test.",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/TestSuiteTestScorerAI",
            "title": "AI"
          }
        ]
      }
    },
    "type": {
      "type": "string",
      "description": "This is the type of the test, which must be voice.",
      "enum": [
        "voice"
      ],
      "maxLength": 100
    },
    "script": {
      "type": "string",
      "description": "This is the script to be used for the voice test.",
      "maxLength": 10000
    },
    "numAttempts": {
      "type": "number",
      "description": "This is the number of attempts allowed for the test.",
      "minimum": 1,
      "maximum": 10
    },
    "name": {
      "type": "string",
      "description": "This is the name of the test.",
      "maxLength": 80
    }
  },
  "required": [
    "scorers",
    "type",
    "script"
  ]
}