Computation

Defines an expression and its answer

APIs.ioEngineeringPlatform

Properties

Name Type Description
expression string The math or conversion expression. If the query contains a request to convert units of measure (for example, meters to feet), this field contains the from units and value contains the to units. If the
value string The expression's answer.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-computation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Computation",
  "title": "Computation",
  "required": [
    "expression",
    "value"
  ],
  "properties": {
    "expression": {
      "type": "string",
      "description": "The math or conversion expression. If the query contains a request to convert units of measure (for example, meters to feet), this field contains the from units and value contains the to units. If the query contains a mathematical expression such as 2+2, this field contains the expression and value contains the answer. Note that mathematical expressions may be normalized. For example, if the query was sqrt(4^2+8^2), the normalized expression may be sqrt((4^2)+(8^2)). If the user's query is a math question and the textDecorations query parameter is set to true, the expression string may include formatting markers. For example, if the user's query is log(2), the normalized expression includes the subscript markers. For more information, see Hit Highlighting."
    },
    "value": {
      "type": "string",
      "description": "The expression's answer."
    }
  },
  "description": "Defines an expression and its answer",
  "allOf": [
    {
      "$ref": "#/components/schemas/Answer"
    }
  ]
}