Chilkat Online Tools

autoit / Salesforce Platform APIs / Predict

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

; The following JSON is sent in the request body.

; {
;   "predictionDefinition": "<PREDICTION_DEFINITION_ID>",
;   "type": "RawData",
;   "columnNames": [
;     "Quantity",
;     "Category",
;     "Sub_Category",
;     "Sales",
;     "Profit_per_Order"
;   ],
;   "rows": [
;     [
;       "2",
;       "Furniture",
;       "Chairs",
;       "300",
;       "10"
;     ]
;   ]
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("predictionDefinition","<PREDICTION_DEFINITION_ID>")
$oJson.UpdateString("type","RawData")
$oJson.UpdateString("columnNames[0]","Quantity")
$oJson.UpdateString("columnNames[1]","Category")
$oJson.UpdateString("columnNames[2]","Sub_Category")
$oJson.UpdateString("columnNames[3]","Sales")
$oJson.UpdateString("columnNames[4]","Profit_per_Order")
$oJson.UpdateString("rows[0][0]","2")
$oJson.UpdateString("rows[0][1]","Furniture")
$oJson.UpdateString("rows[0][2]","Chairs")
$oJson.UpdateString("rows[0][3]","300")
$oJson.UpdateString("rows[0][4]","10")

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"

Local $oResp = $oHttp.PostJson3("https://domain.com/services/data/v{{version}}/smartdatadiscovery/predict","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)

; {
;   "predictionDefinition": "1OR5Y0000010ws8",
;   "predictions": [
;     {
;       "model": {
;         "id": "1Ot5Y0000010wzNSAQ"
;       },
;       "prediction": {
;         "middleValues": [
;         ],
;         "total": 88.52494255547592
;       },
;       "prescriptions": [
;       ],
;       "status": "Success"
;     }
;   ],
;   "settings": {
;     "maxMiddleValues": 0,
;     "maxPrescriptions": 0,
;     "prescriptionImpactPercentage": 0
;   }
; }

; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Local $sId
Local $sTotal
Local $status
Local $iJ
Local $iCount_j

Local $sPredictionDefinition = $oJResp.StringOf("predictionDefinition")
Local $iMaxMiddleValues = $oJResp.IntOf("settings.maxMiddleValues")
Local $iMaxPrescriptions = $oJResp.IntOf("settings.maxPrescriptions")
Local $iPrescriptionImpactPercentage = $oJResp.IntOf("settings.prescriptionImpactPercentage")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("predictions")
While $i < $iCount_i
    $oJResp.I = $i
    $sId = $oJResp.StringOf("predictions[i].model.id")
    $sTotal = $oJResp.StringOf("predictions[i].prediction.total")
    $status = $oJResp.StringOf("predictions[i].status")
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("predictions[i].prediction.middleValues")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $iJ = $iJ + 1
    Wend
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("predictions[i].prescriptions")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $iJ = $iJ + 1
    Wend
    $i = $i + 1
Wend

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "predictionDefinition": "<PREDICTION_DEFINITION_ID>",
    "type": "RawData",
    "columnNames": [
        "Quantity",
        "Category",
        "Sub_Category",
        "Sales",
        "Profit_per_Order"
    ],
    "rows": [
        [
            "2",
            "Furniture",
            "Chairs",
            "300",
            "10"
        ]
    ]
}'
https://domain.com/services/data/v{{version}}/smartdatadiscovery/predict

Postman Collection Item JSON

{
  "name": "Predict",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"predictionDefinition\": \"<PREDICTION_DEFINITION_ID>\",\n    \"type\": \"RawData\",\n    \"columnNames\": [\n        \"Quantity\",\n        \"Category\",\n        \"Sub_Category\",\n        \"Sales\",\n        \"Profit_per_Order\"\n    ],\n    \"rows\": [\n        [\n            \"2\",\n            \"Furniture\",\n            \"Chairs\",\n            \"300\",\n            \"10\"\n        ]\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predict",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "smartdatadiscovery",
        "predict"
      ]
    },
    "description": "Get available prediction definitions."
  },
  "response": [
    {
      "name": "Predict",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"predictionDefinition\": \"1OR5Y0000010ws8WAA\",\n    \"type\": \"RawData\",\n    \"columnNames\": [\n        \"Quantity\",\n        \"Category\",\n        \"Sub_Category\",\n        \"Sales\",\n        \"Profit_per_Order\"\n    ],\n    \"rows\": [\n        [\n            \"2\",\n            \"Furniture\",\n            \"Chairs\",\n            \"300\",\n            \"10\"\n        ]\n    ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predict",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "smartdatadiscovery",
            "predict"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 04 Mar 2021 13:53:39 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536002; includeSubDomains"
        },
        {
          "key": "Expect-CT",
          "value": "max-age=86400, report-uri=\"https://a.forcesslreports.com/Expect-CT-report/00D5Y000001crJvm\""
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"predictionDefinition\": \"1OR5Y0000010ws8\",\n    \"predictions\": [\n        {\n            \"model\": {\n                \"id\": \"1Ot5Y0000010wzNSAQ\"\n            },\n            \"prediction\": {\n                \"middleValues\": [],\n                \"total\": 88.52494255547592\n            },\n            \"prescriptions\": [],\n            \"status\": \"Success\"\n        }\n    ],\n    \"settings\": {\n        \"maxMiddleValues\": 0,\n        \"maxPrescriptions\": 0,\n        \"prescriptionImpactPercentage\": 0\n    }\n}"
    }
  ]
}