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

Recebe uma lista de todos os modelos personalizados.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
dataStore

string

Obrigatório. O nome do recurso do repositório de dados pai, como projects/*/locations/global/collections/default_collection/dataStores/default_data_store. Esse campo é usado para identificar o repositório de dados de onde os modelos serão extraídos.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para o método SearchTuningService.ListCustomModels.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "models": [
    {
      object (CustomTuningModel)
    }
  ]
}
Campos
models[]

object (CustomTuningModel)

Lista de modelos personalizados.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso dataStore:

  • discoveryengine.dataStores.listCustomModels

Para mais informações, consulte a documentação do IAM.

CustomTuningModel

Metadados que descrevem um modelo ajustado personalizado.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "modelVersion": string,
  "modelState": enum (ModelState),
  "createTime": string,
  "trainingStartTime": string,
  "metrics": {
    string: number,
    ...
  },
  "errorMessage": string
}
Campos
name

string

Obrigatório. O nome totalmente qualificado do recurso do modelo.

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

O modelo precisa ser uma string alfanumérica com limite de 40 caracteres.
displayName

string

O nome de exibição do modelo.
modelVersion

string (int64 format)

A versão do modelo.
modelState

enum (ModelState)

O estado em que o modelo está (por exemplo, TRAINING ou TRAINING_FAILED).
createTime
(deprecated)

string (Timestamp format)

Descontinuado: carimbo de data/hora em que o modelo foi criado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
trainingStartTime

string (Timestamp format)

Carimbo de data/hora em que o treinamento de modelo foi iniciado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "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)

As métricas do modelo treinado.
errorMessage

string

No momento, isso só é preenchido se o estado do modelo for INPUT_VALIDATION_FAILED.

ModelState

O estado do modelo.

Tipos enumerados
MODEL_STATE_UNSPECIFIED Valor padrão.
TRAINING_PAUSED O modelo está em um estado de treinamento pausado.
TRAINING O modelo está em treinamento.
TRAINING_COMPLETE O treinamento do modelo foi concluído.
READY_FOR_SERVING O modelo está pronto para veiculação.
TRAINING_FAILED O treinamento de modelo falhou.
NO_IMPROVEMENT O treinamento de modelo foi concluído, mas as métricas não melhoraram.
INPUT_VALIDATION_FAILED Falha na validação dos dados de entrada. O treinamento do modelo não foi iniciado.