Sign in

v1

latestOpenAPI 3.0.32026-07-2659199427.5 KB
Manage models

List all models

Fetch the list of pre-trained and custom models.

get/customers/{CUSTOMER_ID}/ai/models

Request body

GetModels required

GET https://api.lucidworks.com/customers/{CUSTOMER_ID}/ai/models

Response

OK

idstring

The identifier of the model. For:

  • Pre-trained models, the value options are multilinguallm, text-encoder, or clip-encoder.

  • Custom models, the value is the universally unique identified (UUID) that is the primary key for the model.

namestring

The name of the custom model. This field only applies to custom models.

categorystring

The object that specifies if the model is pre-trained (shared) or custom. Valid options are pre-trained (shared) or custom.

modelTypestring

The name of the modelType. For:

  • Pre-trained models, the value is the same as the id value. The value options are multilinguallm, text-encoder, or clip-encoder.

  • Custom models, the value is the name of the model.

descriptionstring

The description of the model.

regionstring

The geographic region specified when the custom model was trained.

vectorSizestring

The number of elements and objects in the custom model. This field only applies to custom models.

statestring

This field specifies the current status of the model. For:

  • Pre-trained (shared) models, the only value is:

    • AVAILABLE - The model was successfully trained and is ready to be deployed.

  • Custom models, the value can be:

    • TRAINING - The custom model is being trained.

    • TRAINING_FAILED - The model training failed.

    • AVAILABLE - The model was successfully trained and is ready to be deployed.

trainingStartedstring date-time

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

trainingCompletedstring date-time

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

createdBystring

The user who created the model. This field only applies to custom models.

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
    },
    "deployments": [
      {
        "id": "1af001c0-cabc-4430-b3b1-c1d8f632e87a",
        "region": "us-southcarolina"
      }
    ]
  }
]