Method: projects.locations.collections.dataStores.customModels.list

Gets a list of all the custom models.

HTTP request

GET https://discoveryengine.googleapis.com/v1/{dataStore=projects/*/locations/*/collections/*/dataStores/*}/customModels

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
dataStore

string

Required. The resource name of the parent Data Store, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store. This field is used to identify the data store where to fetch the models from.

Request body

The request body must be empty.

Response body

Response message for SearchTuningService.ListCustomModels method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "models": [
    {
      object (CustomTuningModel)
    }
  ]
}
Fields
models[]

object (CustomTuningModel)

List of custom tuning models.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the dataStore resource:

  • discoveryengine.dataStores.listCustomModels

For more information, see the IAM documentation.

CustomTuningModel

Metadata that describes a custom tuned model.

JSON representation 
{
  "name": string,
  "displayName": string,
  "modelVersion": string,
  "modelState": enum (ModelState),
  "createTime": string,
  "trainingStartTime": string,
  "metrics": {
    string: number,
    ...
  },
  "errorMessage": string
}
Fields
name

string

Required. The fully qualified resource name of the model.

Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/customTuningModels/{custom_tuning_model}.

Model must be an alpha-numerical string with limit of 40 characters.
displayName

string

The display name of the model.
modelVersion

string (int64 format)

The version of the model.
modelState

enum (ModelState)

The state that the model is in (e.g.TRAINING or TRAINING_FAILED).
createTime
(deprecated)

string (Timestamp format)

Deprecated: Timestamp the Model was created at.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
trainingStartTime

string (Timestamp format)

Timestamp the model training was initiated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
metrics

map (key: string, value: number)

The metrics of the trained model.
errorMessage

string

Currently this is only populated if the model state is INPUT_VALIDATION_FAILED.

ModelState

The state of the model.

Enums
MODEL_STATE_UNSPECIFIED Default value.
TRAINING_PAUSED The model is in a paused training state.
TRAINING The model is currently training.
TRAINING_COMPLETE The model has successfully completed training.
READY_FOR_SERVING The model is ready for serving.
TRAINING_FAILED The model training failed.
NO_IMPROVEMENT The model training finished successfully but metrics did not improve.
INPUT_VALIDATION_FAILED Input data validation failed. Model training didn't start.