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 usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
dataStore

string

Obligatorio. Es el nombre del recurso del almacén de datos principal, como projects/*/locations/global/collections/default_collection/dataStores/default_data_store. Este campo se usa para identificar el almacén de datos desde el que se recuperarán los modelos.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para el método SearchTuningService.ListCustomModels.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

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

object (CustomTuningModel)

Es la lista de modelos con ajustes personalizados.

Permisos de autorización

Se necesita 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 Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso dataStore:

  • discoveryengine.dataStores.listCustomModels

Para obtener más información, consulta la documentación de IAM.

CustomTuningModel

Son los metadatos que describen un modelo ajustado de forma personalizada.

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. Es el nombre del recurso del modelo completamente calificado.

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

El modelo debe ser una cadena alfanumérica con un límite de 40 caracteres.
displayName

string

Es el nombre visible del modelo.
modelVersion

string (int64 format)

Es la versión del modelo.
modelState

enum (ModelState)

Es el estado en el que se encuentra el modelo (p.ej.,TRAINING o TRAINING_FAILED).
createTime
(deprecated)

string (Timestamp format)

Obsoleto: Marca de tiempo en la que se creó el modelo.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “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)

Es la marca de tiempo en la que se inició el entrenamiento de modelos.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “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)

Son las métricas del modelo entrenado.
errorMessage

string

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

ModelState

Es el estado del modelo.

Enums
MODEL_STATE_UNSPECIFIED Valor predeterminado.
TRAINING_PAUSED El modelo está en estado de entrenamiento pausado.
TRAINING Actualmente, se está entrenando el modelo.
TRAINING_COMPLETE El modelo completó el entrenamiento correctamente.
READY_FOR_SERVING El modelo está listo para la entrega.
TRAINING_FAILED No se pudo completar el entrenamiento de modelos.
NO_IMPROVEMENT El entrenamiento de modelos finalizó correctamente, pero las métricas no mejoraron.
INPUT_VALIDATION_FAILED No se pudo validar los datos de entrada. No se inició el entrenamiento del modelo.