Vapi · Schema

StructuredOutputEvaluationResult

Artificial IntelligenceVoiceAgentsReal-TimeCPaaS

Properties

Name Type Description
structuredOutputId string This is the ID of the structured output that was evaluated. Will be 'inline' for inline structured output definitions.
name string This is the name of the structured output.
extractedValue object This is the value extracted from the call by the structured output.
expectedValue object This is the expected value that was defined in the evaluation plan.
comparator string This is the comparison operator used for evaluation.
passed boolean This indicates whether the evaluation passed (extracted value matched expected value using comparator).
required boolean This indicates whether this evaluation was required for the simulation to pass.
error string This contains any error that occurred during extraction.
isSkipped boolean This indicates whether this evaluation was skipped (e.g., multimodal in chat mode).
skipReason string This contains the reason for skipping the evaluation.
View JSON Schema on GitHub

JSON Schema

vapi-structuredoutputevaluationresult-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/StructuredOutputEvaluationResult",
  "title": "StructuredOutputEvaluationResult",
  "type": "object",
  "properties": {
    "structuredOutputId": {
      "type": "string",
      "description": "This is the ID of the structured output that was evaluated.\nWill be 'inline' for inline structured output definitions."
    },
    "name": {
      "type": "string",
      "description": "This is the name of the structured output."
    },
    "extractedValue": {
      "description": "This is the value extracted from the call by the structured output.",
      "oneOf": [
        {
          "type": "number"
        },
        {
          "type": "string"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ]
    },
    "expectedValue": {
      "description": "This is the expected value that was defined in the evaluation plan.",
      "oneOf": [
        {
          "type": "number"
        },
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    },
    "comparator": {
      "type": "string",
      "description": "This is the comparison operator used for evaluation.",
      "enum": [
        "=",
        "!=",
        ">",
        "<",
        ">=",
        "<="
      ]
    },
    "passed": {
      "type": "boolean",
      "description": "This indicates whether the evaluation passed (extracted value matched expected value using comparator)."
    },
    "required": {
      "type": "boolean",
      "description": "This indicates whether this evaluation was required for the simulation to pass."
    },
    "error": {
      "type": "string",
      "description": "This contains any error that occurred during extraction."
    },
    "isSkipped": {
      "type": "boolean",
      "description": "This indicates whether this evaluation was skipped (e.g., multimodal in chat mode)."
    },
    "skipReason": {
      "type": "string",
      "description": "This contains the reason for skipping the evaluation."
    }
  },
  "required": [
    "structuredOutputId",
    "name",
    "extractedValue",
    "expectedValue",
    "comparator",
    "passed",
    "required"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/vapi-structuredoutputevaluationresult"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.