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

Ruft eine Liste aller benutzerdefinierten Modelle ab.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
dataStore

string

Erforderlich. Der Ressourcenname des übergeordneten Datenspeichers, z. B. projects/*/locations/global/collections/default_collection/dataStores/default_data_store. Mit diesem Feld wird der Datenspeicher angegeben, aus dem die Modelle abgerufen werden sollen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für die Methode SearchTuningService.ListCustomModels.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "models": [
    {
      object (CustomTuningModel)
    }
  ]
}
Felder
models[]

object (CustomTuningModel)

Liste der benutzerdefinierten Abstimmungsmodelle.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource dataStore:

  • discoveryengine.dataStores.listCustomModels

Weitere Informationen finden Sie in der IAM-Dokumentation.

CustomTuningModel

Metadaten, die ein benutzerdefiniertes Modell beschreiben.

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

string

Erforderlich. Der vollständig qualifizierte Ressourcenname des Modells.

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

Das Modell muss ein alphanumerischer String mit maximal 40 Zeichen sein.
displayName

string

Der Anzeigename des Modells.
modelVersion

string (int64 format)

Die Version des Modells.
modelState

enum (ModelState)

Der Status des Modells (z.B.TRAINING oder TRAINING_FAILED).
createTime
(deprecated)

string (Timestamp format)

Veraltet: Zeitstempel für die Erstellung des Modells.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
trainingStartTime

string (Timestamp format)

Zeitstempel, zu dem das Modelltraining initiiert wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
metrics

map (key: string, value: number)

Die Messwerte des trainierten Modells.
errorMessage

string

Derzeit wird dieses Feld nur ausgefüllt, wenn der Modellstatus INPUT_VALIDATION_FAILED ist.

ModelState

Der Status des Modells.

Enums
MODEL_STATE_UNSPECIFIED Standardwert.
TRAINING_PAUSED Das Modell befindet sich im pausierten Trainingsstatus.
TRAINING Das Modell wird derzeit trainiert.
TRAINING_COMPLETE Das Modell wurde erfolgreich trainiert.
READY_FOR_SERVING Das Modell ist bereit für die Bereitstellung.
TRAINING_FAILED Das Modelltraining ist fehlgeschlagen.
NO_IMPROVEMENT Das Modelltraining wurde erfolgreich abgeschlossen, aber die Messwerte haben sich nicht verbessert.
INPUT_VALIDATION_FAILED Die Validierung der Eingabedaten ist fehlgeschlagen. Das Modelltraining wurde nicht gestartet.