POST
/
customers
/
{CUSTOMER_ID}
/
ai
/
models
POST Models
curl --request POST \
  --url https:/api.lucidworks.com/customers/{CUSTOMER_ID}/ai/models \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "modelType": "<string>",
  "region": "<string>",
  "trainingData": {
    "catalog": "<string>",
    "signals": "<string>"
  },
  "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.trn_batch_size": 123,
    "trainer_config.num_epochs": 1,
    "trainer_config.monitor_patience": 8,
    "trainer_config.encoder_config.emb_spdp": 0.3,
    "trainer_config.encoder_config.emb_trainable": true
  },
  "trainingDataCredentials": {
    "serviceAccountKey": "<string>"
  }
}'
{
  "id": "<string>",
  "name": "<string>",
  "modelType": "<string>",
  "category": "<string>",
  "description": "<string>",
  "region": "<string>",
  "trainingData": {
    "catalog": "<string>",
    "signals": "<string>"
  },
  "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.trn_batch_size": 123,
    "trainer_config.num_epochs": 1,
    "trainer_config.monitor_patience": 8,
    "trainer_config.encoder_config.emb_spdp": 0.3,
    "trainer_config.encoder_config.emb_trainable": true
  },
  "state": "<string>",
  "trainingStarted": "<string>",
  "trainingCompleted": "<string>",
  "createdBy": "<string>"
}

Path Parameters

CUSTOMER_ID
string
required

Unique identifier derived from confidential client information.

Body

application/json
name
string

The user-friendly name of the model.

modelType
string

The name of the custom model.

region
string

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

trainingData
object

The location of the training data in Google Cloud Storage (GCS).

config
object

The configuration parameters passed to the model training job.

trainingDataCredentials
object

The credentials used to access the training data URLs.

Response

200 - application/json

OK

id
string

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

name
string

The user-friendly name of the model.

modelType
string

The name of the model.

category
string

The object that specifies the model is custom.

description
string

The description of the model.

region
string

The geographic region specified when the custom model was trained.

trainingData
object

The location of the training data in Google Cloud Storage (GCS).

config
object

The configuration parameters passed to the model training job.

state
string

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

trainingStarted
string

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

trainingCompleted
string

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

createdBy
string

The user who created the model.