Vapi · Schema

TextInsightFromCallTable

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
name string This is the name of the Insight.
type string This is the type of the Insight. It is required to be `text` to create a text insight.
formula object Formulas are mathematical expressions applied on the data returned by the queries to transform them before being used to create the insight. The formulas needs to be a valid mathematical expression, s
timeRange object
queries array These are the queries to run to generate the insight. For Text Insights, we only allow a single query, or require a formula if multiple queries are provided
View JSON Schema on GitHub

JSON Schema

vapi-textinsightfromcalltable-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TextInsightFromCallTable",
  "title": "TextInsightFromCallTable",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "This is the name of the Insight.",
      "minLength": 1,
      "maxLength": 255
    },
    "type": {
      "type": "string",
      "description": "This is the type of the Insight.\nIt is required to be `text` to create a text insight.",
      "enum": [
        "text"
      ]
    },
    "formula": {
      "type": "object",
      "description": "Formulas are mathematical expressions applied on the data returned by the queries to transform them before being used to create the insight.\nThe formulas needs to be a valid mathematical expression, supported by MathJS - https://mathjs.org/docs/expressions/syntax.html\nA formula is created by using the query names as the variable.\nThe formulas must contain at least one query name in the LiquidJS format {{query_name}} or {{['query name']}} which will be substituted with the query result.\nFor example, if you have 2 queries, 'Was Booking Made' and 'Average Call Duration', you can create a formula like this:\n```\n{{['Query 1']}} / {{['Query 2']}} * 100\n```\n\n```\n({{[Query 1]}} * 10) + {{[Query 2]}}\n```\nThis will take the\n\nYou can also use the query names as the variable in the formula.",
      "items": {
        "$ref": "#/components/schemas/InsightFormula"
      }
    },
    "timeRange": {
      "$ref": "#/components/schemas/InsightTimeRange"
    },
    "queries": {
      "type": "array",
      "description": "These are the queries to run to generate the insight.\nFor Text Insights, we only allow a single query, or require a formula if multiple queries are provided",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/JSONQueryOnCallTableWithStringTypeColumn",
            "title": "JSONQueryOnCallTableWithStringTypeColumn"
          },
          {
            "$ref": "#/components/schemas/JSONQueryOnCallTableWithNumberTypeColumn",
            "title": "JSONQueryOnCallTableWithNumberTypeColumn"
          },
          {
            "$ref": "#/components/schemas/JSONQueryOnCallTableWithStructuredOutputColumn",
            "title": "JSONQueryOnCallTableWithStructuredOutputColumn"
          }
        ]
      }
    }
  },
  "required": [
    "type",
    "queries"
  ]
}