hubvibe-io.com

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "The 200 body of every paid /work call. `result` is the worker's own output (its schema is per route); everything else is the same on every /work route. A receipt for the job is at `receipt_url`.",
  "properties": {
    "attribution": {
      "$ref": "#/components/schemas/Attribution"
    },
    "billing_warning": {
      "description": "Present only when the charge was recorded with a caveat.",
      "examples": [
        "settlement pending"
      ],
      "type": "string"
    },
    "price_usd": {
      "description": "What this call cost, in USD.",
      "examples": [
        0.02
      ],
      "type": "number"
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    },
    "receipt_id": {
      "description": "Receipt id for this job.",
      "examples": [
        "rcpt_9f1c2b3a4d5e6f70"
      ],
      "type": "string"
    },
    "receipt_url": {
      "description": "Where to fetch the machine-readable receipt (free, no payment).",
      "examples": [
        "/work/receipts/rcpt_9f1c2b3a4d5e6f70"
      ],
      "type": "string"
    },
    "result": {
      "properties": {
        "columns": {
          "description": "AI.FORECAST output columns.",
          "examples": [
            [
              "state_name",
              "forecast_timestamp",
              "forecast_value",
              "confidence_level",
              "prediction_interval_lower_bound",
              "prediction_interval_upper_bound",
              "ai_forecast_status"
            ]
          ],
          "items": {
            "description": "AI.FORECAST output column.",
            "examples": [
              "forecast_timestamp"
            ],
            "type": "string"
          },
          "type": "array"
        },
        "data_col": {
          "description": "Value column forecast.",
          "examples": [
            "confirmed_cases"
          ],
          "type": "string"
        },
        "gib_processed": {
          "description": "Gibibytes BigQuery scanned; the metered cost basis.",
          "examples": [
            0.012
          ],
          "type": "number"
        },
        "horizon": {
          "description": "Forecast points requested.",
          "examples": [
            10
          ],
          "type": "integer"
        },
        "row_count": {
          "description": "Rows returned.",
          "examples": [
            10
          ],
          "type": "integer"
        },
        "rows": {
          "description": "Forecast rows.",
          "examples": [
            [
              {
                "confidence_level": "0.95",
                "forecast_timestamp": "2023-03-24 00:00:00",
                "forecast_value": "8631745.2",
                "state_name": "Texas"
              }
            ]
          ],
          "items": {
            "additionalProperties": true,
            "description": "One forecast point.",
            "examples": [
              {
                "confidence_level": "0.95",
                "forecast_timestamp": "2023-03-24 00:00:00",
                "forecast_value": "8631745.2",
                "state_name": "Texas"
              }
            ],
            "properties": {},
            "required": [],
            "type": "object"
          },
          "type": "array"
        },
        "table": {
          "description": "Source table.",
          "examples": [
            "bigquery-public-data.covid19_nyt.us_states"
          ],
          "type": "string"
        },
        "timestamp_col": {
          "description": "Timestamp column.",
          "examples": [
            "date"
          ],
          "type": "string"
        }
      },
      "required": [
        "table",
        "timestamp_col",
        "data_col",
        "horizon",
        "columns",
        "rows",
        "row_count",
        "gib_processed"
      ],
      "type": "object"
    },
    "status": {
      "const": "ok",
      "description": "Present only on a delivered result.",
      "type": "string"
    },
    "worker": {
      "description": "Catalog name of the worker that ran.",
      "examples": [
        "market.quote"
      ],
      "type": "string"
    }
  },
  "required": [
    "status",
    "worker",
    "price_usd",
    "result",
    "provenance",
    "receipt_id",
    "receipt_url"
  ],
  "title": "data.forecast response",
  "type": "object"
}