GET
/
customers
/
{CUSTOMER_ID}
/
ai
/
models
GET Models
curl --request GET \
  --url https:/api.lucidworks.com/customers/{CUSTOMER_ID}/ai/models \
  --header 'Content-Type: application/json' \
  --data '{}'
[
  {
    "id": "<string>",
    "name": "<string>",
    "category": "<string>",
    "modelType": "<string>",
    "description": "<string>",
    "region": "<string>",
    "vectorSize": "<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": "2023-11-07T05:31:56Z",
    "trainingCompleted": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "deployments": [
      {
        "id": "1af001c0-cabc-4430-b3b1-c1d8f632e87a",
        "region": "us-southcarolina",
        "state": "<string>",
        "deployedAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
]

Path Parameters

​
CUSTOMER_ID
string
required

Unique identifier derived from confidential client information.

Body

application/json · getModels · object

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

Response

200 - application/json

OK

​
id
string

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.

​
name
string

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

​
category
string

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

​
modelType
string

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.

​
description
string

The description of the model.

​
region
string

The geographic region specified when the custom model was trained.

​
vectorSize
string

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

​
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 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.

​
trainingStarted
string<date-time>

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

​
trainingCompleted
string<date-time>

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

​
createdBy
string

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

​
deployments
deployments · object[]

This array is only returned for deployed custom models, so these fields are not included for pre-trained models.