Discovery Engine API . projects . locations . collections . dataStores . customModels

Instance Methods

close()

Close httplib2 connections.

list(dataStore, x__xgafv=None)

Gets a list of all the custom models.

Method Details

close()
Close httplib2 connections.
list(dataStore, x__xgafv=None)
Gets a list of all the custom models.

Args:
  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. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for SearchTuningService.ListCustomModels method.
  "models": [ # List of custom tuning models.
    { # Metadata that describes a custom tuned model.
      "createTime": "A String", # Deprecated: Timestamp the Model was created at.
      "displayName": "A String", # The display name of the model.
      "errorMessage": "A String", # Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.
      "metrics": { # The metrics of the trained model.
        "a_key": 3.14,
      },
      "modelState": "A String", # The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
      "modelVersion": "A String", # The version of the model.
      "name": "A String", # Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters.
      "trainingStartTime": "A String", # Timestamp the model training was initiated.
    },
  ],
}