Salesforce · Schema

Predict

Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

Properties

Name Type Description
predictionDefinition string
predictions array
settings object
View JSON Schema on GitHub

JSON Schema

salesforce-predict-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "predictionDefinition": {
      "type": "string",
      "example": "example_value"
    },
    "predictions": {
      "type": "array",
      "description": "",
      "example": [],
      "items": {
        "type": "object",
        "properties": {
          "model": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "example": "abc123"
              }
            },
            "required": [
              "id"
            ]
          },
          "prediction": {
            "type": "object",
            "properties": {
              "middleValues": {
                "type": "array",
                "description": "",
                "example": [],
                "items": {
                  "type": "string"
                }
              },
              "total": {
                "type": "number",
                "example": 42
              }
            },
            "required": [
              "middleValues",
              "total"
            ]
          },
          "prescriptions": {
            "type": "array",
            "description": "",
            "example": [],
            "items": {
              "type": "string"
            }
          },
          "status": {
            "type": "string",
            "example": "example_value"
          }
        },
        "required": [
          "model",
          "prediction",
          "prescriptions",
          "status"
        ]
      }
    },
    "settings": {
      "type": "object",
      "properties": {
        "maxMiddleValues": {
          "type": "integer",
          "example": 10
        },
        "maxPrescriptions": {
          "type": "integer",
          "example": 10
        },
        "prescriptionImpactPercentage": {
          "type": "integer",
          "example": 10
        }
      },
      "required": [
        "maxMiddleValues",
        "maxPrescriptions",
        "prescriptionImpactPercentage"
      ]
    }
  },
  "required": [
    "predictionDefinition",
    "predictions",
    "settings"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Predict"
}