LUlucidworks
Manage models

Create a model

Create a custom model and start a training job. The custom model cannot be modified after it is created.

post/customers/{CUSTOMER_ID}/ai/models

Request

Request body

namestring

The user-friendly name of the model.

modelTypestring

The name of the custom model.

regionstring

The geographic region specified when the custom model is being trained.

Example request

{
  "config": {
    "dataset_config": "mlp_ecommerce",
    "trainer_config": "mlp_ecommerce",
    "trainer_config/text_processor_config": "word_en",
    "trainer_config.encoder_config.rnn_names_list": [
      "gru"
    ],
    "trainer_config.encoder_config.rnn_units_list": [
      128
    ],
    "trainer_config.num_epochs": 1,
    "trainer_config.monitor_patience": 8,
    "trainer_config.encoder_config.emb_spdp": 0.3
  }
}

Response

OK

idstring

The identifier of the model. The value is the universally unique identified (UUID) that is the primary key for the model.

namestring

The user-friendly name of the model.

modelTypestring

The name of the model.

categorystring

The object that specifies the model is custom.

descriptionstring

The description of the model.

regionstring

The geographic region specified when the custom model was trained.

statestring

This field specifies the current status of the custom model. The value is TRAINING.

trainingStartedstring

The date and time the training started. This field only applies to custom models.

trainingCompletedstring

The date and time the training completed. This field only applies to custom models.

createdBystring

The user who created the model.

Example response

{
  "config": {
    "dataset_config": "mlp_ecommerce",
    "trainer_config": "mlp_ecommerce",
    "trainer_config/text_processor_config": "word_en",
    "trainer_config.encoder_config.rnn_names_list": [
      "gru"
    ],
    "trainer_config.encoder_config.rnn_units_list": [
      128
    ],
    "trainer_config.num_epochs": 1,
    "trainer_config.monitor_patience": 8,
    "trainer_config.encoder_config.emb_spdp": 0.3
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.