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

Obtient la liste de tous les modèles personnalisés.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
dataStore

string

Obligatoire. Nom de la ressource du magasin de données parent, par exemple projects/*/locations/global/collections/default_collection/dataStores/default_data_store. Ce champ permet d'identifier le data store à partir duquel extraire les modèles.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour la méthode SearchTuningService.ListCustomModels.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "models": [
    {
      object (CustomTuningModel)
    }
  ]
}
Champs
models[]

object (CustomTuningModel)

Liste des modèles d'ajustement personnalisés.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la page Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource dataStore :

  • discoveryengine.dataStores.listCustomModels

Pour en savoir plus, consultez la documentation IAM.

CustomTuningModel

Métadonnées décrivant un modèle ajusté personnalisé.

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "modelVersion": string,
  "modelState": enum (ModelState),
  "createTime": string,
  "trainingStartTime": string,
  "metrics": {
    string: number,
    ...
  },
  "errorMessage": string
}
Champs
name

string

Obligatoire. Nom complet de la ressource du modèle.

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

Le modèle doit être une chaîne alphanumérique de 40 caractères maximum.
displayName

string

Nom à afficher pour le modèle.
modelVersion

string (int64 format)

Version du modèle.
modelState

enum (ModelState)

État du modèle (par exemple, TRAINING ou TRAINING_FAILED).
createTime
(deprecated)

string (Timestamp format)

Obsolète : Timestamp de création du modèle.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
trainingStartTime

string (Timestamp format)

Timestamp de démarrage de l'entraînement du modèle.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
metrics

map (key: string, value: number)

Métriques du modèle entraîné.
errorMessage

string

Actuellement, ce champ n'est renseigné que si l'état du modèle est INPUT_VALIDATION_FAILED.

ModelState

État du modèle.

Enums
MODEL_STATE_UNSPECIFIED Valeur par défaut.
TRAINING_PAUSED L'entraînement du modèle est suspendu.
TRAINING Le modèle est en cours d'entraînement.
TRAINING_COMPLETE L'entraînement du modèle s'est terminé correctement.
READY_FOR_SERVING Le modèle est prêt à être utilisé.
TRAINING_FAILED L'entraînement du modèle a échoué.
NO_IMPROVEMENT L'entraînement du modèle s'est terminé correctement, mais les métriques ne se sont pas améliorées.
INPUT_VALIDATION_FAILED La validation des données d'entrée a échoué. L'entraînement du modèle n'a pas démarré.