Vapi · Schema

ToolCallResultMessageWarning

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
type string The kind of warning. Currently: - `oversized-tool-response`: the tool's serialized response exceeded the recommended size and is likely to bloat the model context, increasing latency and risking trunc
tokenCount number The estimated number of tokens in the serialized tool response.
threshold number The threshold (in tokens) above which the warning is raised.
View JSON Schema on GitHub

JSON Schema

vapi-toolcallresultmessagewarning-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ToolCallResultMessageWarning",
  "title": "ToolCallResultMessageWarning",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The kind of warning. Currently:\n- `oversized-tool-response`: the tool's serialized response exceeded the\n  recommended size and is likely to bloat the model context, increasing\n  latency and risking truncation of earlier instructions.",
      "enum": [
        "oversized-tool-response"
      ]
    },
    "tokenCount": {
      "type": "number",
      "description": "The estimated number of tokens in the serialized tool response."
    },
    "threshold": {
      "type": "number",
      "description": "The threshold (in tokens) above which the warning is raised."
    }
  },
  "required": [
    "type",
    "tokenCount",
    "threshold"
  ]
}