Vapi · Schema

AssistantMessageEvaluationContinuePlan

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
exitOnFailureEnabled boolean This is whether the evaluation should exit if the assistant message evaluates to false. By default, it is false and the evaluation will continue. @default false
contentOverride string This is the content that will be used in the conversation for this assistant turn moving forward if provided. It will override the content received from the model.
toolCallsOverride array This is the tool calls that will be used in the conversation for this assistant turn moving forward if provided. It will override the tool calls received from the model.
View JSON Schema on GitHub

JSON Schema

vapi-assistantmessageevaluationcontinueplan-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AssistantMessageEvaluationContinuePlan",
  "title": "AssistantMessageEvaluationContinuePlan",
  "type": "object",
  "properties": {
    "exitOnFailureEnabled": {
      "type": "boolean",
      "description": "This is whether the evaluation should exit if the assistant message evaluates to false.\nBy default, it is false and the evaluation will continue.\n@default false"
    },
    "contentOverride": {
      "type": "string",
      "description": "This is the content that will be used in the conversation for this assistant turn moving forward if provided.\nIt will override the content received from the model.",
      "example": "The weather in San Francisco is sunny.",
      "maxLength": 1000
    },
    "toolCallsOverride": {
      "description": "This is the tool calls that will be used in the conversation for this assistant turn moving forward if provided.\nIt will override the tool calls received from the model.",
      "example": "[{ name: \"get_weather\", arguments: { city: \"San Francisco\" } }]",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ChatEvalAssistantMessageMockToolCall"
      }
    }
  }
}