1. REST API Reference for AI Services
  2. Tasks
  3. Prediction Service

Get Predictions

post

/utility/predict

Creates a prediction for an account using the specified algorithm.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Additional Properties Allowed: true
Match All
Specifies the input parameters for the request.
Show Source
  • Extensible
    Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
  • type
    Specifies the input parameters for the request.
Nested Schema : Extensible
Type: object
Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
Show Source
Nested Schema : type
Type: object
Specifies the input parameters for the request.
Show Source
Nested Schema : model_names
Type: array
Lists the algorithms to use for the prediction service - knn, dnn, or cosine.
Show Source
Examples

Back to Top

Response

200 Response

The request was completed successfully. If the system throws a runtime error, the response code 200 is returned alongside the error message in the response body.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Additional Properties Allowed: true
Match All
Returns the result output.
Show Source
Nested Schema : Extensible
Type: object
Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
Show Source
Nested Schema : Discriminator: @type-allOf[1]
Type: object
Additional Properties Allowed: true
Returns the result output.
Show Source
Nested Schema : predictions
Type: array
Recommendations returned by each algorithm.
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "PredictionDetails":"#/components/schemas/PredictionDetails" } }
    Additional Properties Allowed: true
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Additional Properties Allowed: true
Match All
Provides the details for a recommendation.
Show Source
Nested Schema : Discriminator: @type-allOf[1]
Type: object
Additional Properties Allowed: true
Provides the details for a recommendation.
Show Source
Nested Schema : top_results
Type: array
Lists the recommendation results.
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Additional Properties Allowed: true
Match All
Lists the predicted outcomes.
Show Source
Nested Schema : Discriminator: @type-allOf[1]
Type: object
Additional Properties Allowed: true
Lists the predicted outcomes.
Show Source

400 Response

The server received a bad request.
Body ()
Root Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Match All
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Show Source
  • Extensible
    Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
  • Discriminator: @type-allOf[1]
    Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Nested Schema : Extensible
Type: object
Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
Show Source
Nested Schema : Discriminator: @type-allOf[1]
Type: object
Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Show Source

401 Response

The request is not authorized.
Body ()
Root Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Match All
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Show Source
  • Extensible
    Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
  • Discriminator: @type-allOf[1]
    Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Nested Schema : Extensible
Type: object
Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
Show Source
Nested Schema : Discriminator: @type-allOf[1]
Type: object
Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Show Source

403 Response

The request is forbidden.
Body ()
Root Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Match All
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Show Source
  • Extensible
    Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
  • Discriminator: @type-allOf[1]
    Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Nested Schema : Extensible
Type: object
Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
Show Source
Nested Schema : Discriminator: @type-allOf[1]
Type: object
Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Show Source

404 Response

The resource was not found.
Body ()
Root Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Match All
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Show Source
  • Extensible
    Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
  • Discriminator: @type-allOf[1]
    Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Nested Schema : Extensible
Type: object
Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
Show Source
Nested Schema : Discriminator: @type-allOf[1]
Type: object
Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Show Source

405 Response

The method is not allowed.
Body ()
Root Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Match All
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Show Source
  • Extensible
    Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
  • Discriminator: @type-allOf[1]
    Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Nested Schema : Extensible
Type: object
Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
Show Source
Nested Schema : Discriminator: @type-allOf[1]
Type: object
Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Show Source

409 Response

The server received a conflict.
Body ()
Root Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Match All
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Show Source
  • Extensible
    Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
  • Discriminator: @type-allOf[1]
    Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Nested Schema : Extensible
Type: object
Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
Show Source
Nested Schema : Discriminator: @type-allOf[1]
Type: object
Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Show Source

500 Response

The system has received an Internal Server Error.
Body ()
Root Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Match All
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Show Source
  • Extensible
    Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
  • Discriminator: @type-allOf[1]
    Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Nested Schema : Extensible
Type: object
Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
Show Source
Nested Schema : Discriminator: @type-allOf[1]
Type: object
Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Show Source

501 Response

The service was not implemented.
Body ()
Root Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Match All
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Show Source
  • Extensible
    Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
  • Discriminator: @type-allOf[1]
    Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Nested Schema : Extensible
Type: object
Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
Show Source
Nested Schema : Discriminator: @type-allOf[1]
Type: object
Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Show Source

503 Response

The service is not available.
Body ()
Root Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Match All
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Show Source
  • Extensible
    Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
  • Discriminator: @type-allOf[1]
    Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Nested Schema : Extensible
Type: object
Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
Show Source
Nested Schema : Discriminator: @type-allOf[1]
Type: object
Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).
Show Source
Back to Top

Examples

Example 1: Predictions Through the REST API

This example shows the cURL command for sending a Predict request through the REST API:

curl -X POST 'http://hostname:port/utility/predict' -H 'Content-Type: application/json' -d @file1.json

where:

  • hostname is the host name of the application server.

  • port is the port for the application server.

  • file1.json is the JSON file that specifies the prediction request.

Request Body

The following example shows the contents of the file1.json file sent as the request body. 

{
  "@type": "PredictRequest",
  "account_id": "2824533",
  "model_names": [
    "recommend_knn",
    "dnn"
  ]
}

Response Body

If successful, the response code 200 is returned with the following response body.

[
  {
    "@type": "PredictResponse",
    "status": "Success",
    "predictions": [
      {
        "@type": "PredictionDetails",
        "algorithm": "knn",
        "model_name": "recommend_knn",
        "account_id": "2824533",
        "present_deal": "Deal 10 - Data Storm",
        "top_results": [
          {
            "@type": "ResultDetails",
            "prediction": "Deal 12 - Data Mini",
            "probability_or_distance": 0.0
          },
          {
            "@type": "ResultDetails",
            "prediction": "Deal 4 - SMS Special",
            "probability_or_distance": 0.0
          },
          {
            "@type": "ResultDetails",
            "prediction": "Deal 3 - CO for Voice 40 ",
            "probability_or_distance": 0.0
          }
        ]
      },
      {
        "@type": "PredictionDetails",
        "algorithm": "dnn",
        "model_name": "dnn",
        "account_id": "2824533",
        "present_deal": "Deal 10 - Data Storm",
        "top_results": [
          {
            "@type": "ResultDetails",
            "prediction": "Deal 1 - Data 30",
            "probability_or_distance": 0.11470177
          },
          {
            "@type": "ResultDetails",
            "prediction": "Deal 11 - Data Blaze",
            "probability_or_distance": 0.11470167
          },
          {
            "@type": "ResultDetails",
            "prediction": "Deal 10 - Data Storm",
            "probability_or_distance": 0.11470162
          }
        ]
      }
    ]
  }
]

Example 2: Predictions Through the MCP Tool

This example shows the cURL command for calling the prediction tool through the MCP endpoint:

curl -X POST 'http://hostname:port/monetization/nbo/v1/mcp' -H 'Content-Type: application/json' -d @file2.json

where:

  • hostname is the host name of the application server.

  • port is the port for the application server.

  • file2.json is the JSON file that specifies the MCP tool call and its prediction arguments.

Request Body

The following example shows the contents of the file2.json file sent as the request body. 

{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "predict-service",
    "arguments": {
      "@type": "PredictRequest",
      "account_id": "2824533",
      "model_names": [
        "recommend_knn",
        "dnn"
      ]
    }
  }
}

Response Body

The following illustrative MCP response expands the abbreviated engineering response using the prediction results from Example 1 for the same inputs. The JSON-RPC response ID matches the request ID.

{
  "jsonrpc": "2.0",
  "id": "1",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"account_id\":\"2824533\",\"status\":\"Success\",\"predictions\":[{\"@type\":\"PredictionDetails\",\"algorithm\":\"knn\",\"model_name\":\"recommend_knn\",\"account_id\":\"2824533\",\"present_deal\":\"Deal 10 - Data Storm\",\"top_results\":[{\"@type\":\"ResultDetails\",\"prediction\":\"Deal 12 - Data Mini\",\"probability_or_distance\":0.0},{\"@type\":\"ResultDetails\",\"prediction\":\"Deal 4 - SMS Special\",\"probability_or_distance\":0.0},{\"@type\":\"ResultDetails\",\"prediction\":\"Deal 3 - CO for Voice 40 \",\"probability_or_distance\":0.0}]},{\"@type\":\"PredictionDetails\",\"algorithm\":\"dnn\",\"model_name\":\"dnn\",\"account_id\":\"2824533\",\"present_deal\":\"Deal 10 - Data Storm\",\"top_results\":[{\"@type\":\"ResultDetails\",\"prediction\":\"Deal 1 - Data 30\",\"probability_or_distance\":0.11470177},{\"@type\":\"ResultDetails\",\"prediction\":\"Deal 11 - Data Blaze\",\"probability_or_distance\":0.11470167},{\"@type\":\"ResultDetails\",\"prediction\":\"Deal 10 - Data Storm\",\"probability_or_distance\":0.11470162}]}]}"
      }
    ],
    "isError": false
  }
}
Back to Top