1. REST API Reference for AI Services
  2. Tasks
  3. Model Training

Train the Model

post

/utility/train

Trains the model based on the configurations set by you and the data acquired by the data service.

In the request body, the contents of additional_data depend on the storage_type value:

  • When storage_type is set to object_storage, the additional_data object must include the bucket and namespace fields.
  • When storage_type is set to pvc, the additional_data object must include the path field set to the path of the metadata.json file.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

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 : algorithm
Type: array
Specifies the list of algorithms to train.
Show Source
Nested Schema : storage_details
Type: array
Provides the storage location and access details for the stored data.
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Match All
Defines an algorithm and its training configuration.
Show Source
Nested Schema : Discriminator: @type-allOf[1]
Type: object
Defines an algorithm and its training configuration.
Show Source
Nested Schema : hyper_parameters
Type: object
Specifies hyperparameters to override the default values. Available parameters vary by algorithm.
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Match All
Specifies the storage location and connection details.
Show Source
Nested Schema : Discriminator: @type-allOf[1]
Type: object
Specifies the storage location and connection details.
Show Source
Nested Schema : storage_connection_details
Type: array
Specifies the connection parameters for the storage location.
Show Source
Nested Schema : items
Type: object
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

Match All
Specifies the output returned by the operation.
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
Specifies the output returned by the operation.
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

This example shows the cURL command for sending a Train Model request:

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

where:

  • hostname is the host name of the application server.

  • port is the port for the application server.

  • file.json is the JSON file that specifies the algorithms, training settings, and storage details.

Example of the Request Body

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

{
  "@type": "TrainRequest",
  "algorithm": [
    {
      "@type": "Algorithms",
      "algo": "knn",
      "model_dir": "model/",
      "model_name": "recommend_knn",
      "hyper_parameters": {
        "k_value": 5
      }
    },
    {
      "@type": "Algorithms",
      "algo": "cosine",
      "model_dir": "model/",
      "model_name": "recommend_cosine",
      "hyper_parameters": {
        "k_value": 5
      }
    },
    {
      "@type": "Algorithms",
      "algo": "dnn",
      "model_dir": "model/",
      "model_name": "dnn",
      "hyper_parameters": {
        "test_size": 0.2,
        "epochs": 150,
        "batch_size": 16,
        "loss": "categorical_crossentropy",
        "optimizer": "rmsprop",
        "learning_rate": 0.001,
        "final_activation": "softmax"
      }
    },
    {
      "@type": "Algorithms",
      "algo": "dnn_mh",
      "model_dir": "model/",
      "model_name": "dnn_mh",
      "hyper_parameters": {
        "test_size": 0.2,
        "epochs": 150,
        "batch_size": 16,
        "loss": "categorical_crossentropy",
        "optimizer": "rmsprop",
        "learning_rate": 0.001,
        "final_activation": "softmax"
      }
    },
    {
      "@type": "Algorithms",
      "algo": "xgboost",
      "model_dir": "model/",
      "model_name": "ece_outage",
      "hyper_parameters": {
        "test_size": 0.2,
        "n_estimators": 300,
        "max_depth": 4,
        "learning_rate": 0.04,
        "subsample": 0.9,
        "colsample_bytree": 0.85,
        "reg_alpha": 0.25,
        "reg_lambda": 2.0,
        "eval_metric": "mlogloss",
        "tree_method": "hist"
      }
    }
  ],
  "sample": true,
  "storage_details": [
    {
      "@type": "StorageDetails",
      "storage_type": "object_storage",
      "required_data": [
        "account_data",
        "balance_group_data",
        "service_data",
        "purchased_product_data",
        "product_data",
        "deal_data",
        "plan_data",
        "rate_data",
        "event_data",
        "deal_data_2",
        "over_usage_data",
        "usage_details"
      ],
      "additional_details": {
        "bucket": "sample-for-dataflow",
        "namespace": "adcdefghijk"
      }
    }
  ]
}

Example of the Response Body

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

{
  "@type": "TrainResponse",
  "status": "Training Complete / Exception Stack trace"
}
Back to Top