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

Obtiene una lista de todos los modelos personalizados.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
dataStore

string

Obligatorio. Nombre de recurso del almacén de datos superior, como projects/*/locations/global/collections/default_collection/dataStores/default_data_store. Este campo se usa para identificar el almacén de datos del que se deben obtener los modelos.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta del método SearchTuningService.ListCustomModels.

Si la solicitud se realiza correctamente, el cuerpo de la respuesta proporciona datos con la siguiente estructura:

Representación JSON 
{
  "models": [
    {
      object (CustomTuningModel)
    }
  ]
}
Campos
models[]

object (CustomTuningModel)

Lista de modelos de ajuste personalizados.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso dataStore:

  • discoveryengine.dataStores.listCustomModels

Para obtener más información, consulta la documentación de gestión de identidades y accesos.

CustomTuningModel

Metadatos que describen un modelo ajustado personalizado.

Representación JSON 
{
  "name": string,
  "displayName": string,
  "modelVersion": string,
  "modelState": enum (ModelState),
  "createTime": string,
  "trainingStartTime": string,
  "metrics": {
    string: number,
    ...
  },
  "errorMessage": string
}
Campos
name

string

Obligatorio. Nombre completo del recurso del modelo.

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

El modelo debe ser una cadena alfanumérica de 40 caracteres como máximo.
displayName

string

Nombre visible del modelo.
modelVersion

string (int64 format)

La versión del modelo.
modelState

enum (ModelState)

El estado en el que se encuentra el modelo (por ejemplo, TRAINING o TRAINING_FAILED).
createTime
(deprecated)

string (Timestamp format)

Obsoleto: marca de tiempo de creación del modelo.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
trainingStartTime

string (Timestamp format)

Marca de tiempo en la que se inició el entrenamiento del modelo.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
metrics

map (key: string, value: number)

Las métricas del modelo entrenado.
errorMessage

string

Actualmente, solo se rellena si el estado del modelo es INPUT_VALIDATION_FAILED.

ModelState

El estado del modelo.

Enumeraciones
MODEL_STATE_UNSPECIFIED Valor predeterminado.
TRAINING_PAUSED El modelo está en un estado de entrenamiento en pausa.
TRAINING El modelo se está entrenando.
TRAINING_COMPLETE El modelo ha completado correctamente el entrenamiento.
READY_FOR_SERVING El modelo está listo para publicarse.
TRAINING_FAILED No se ha podido entrenar el modelo.
NO_IMPROVEMENT El entrenamiento del modelo se ha completado correctamente, pero las métricas no han mejorado.
INPUT_VALIDATION_FAILED No se ha podido validar la entrada de datos. No se ha iniciado el entrenamiento del modelo.