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

Obtém uma lista de todos os modelos personalizados.

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
dataStore

string

Obrigatório. O nome do recurso da loja de dados principal, como projects/*/locations/global/collections/default_collection/dataStores/default_data_store. Este campo é usado para identificar o armazenamento de dados a partir do qual os modelos devem ser obtidos.

Corpo do pedido

O corpo do pedido tem de estar vazio.

Corpo da resposta

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

Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:

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

object (CustomTuningModel)

Lista de modelos de ajuste personalizado.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de 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 do recurso totalmente qualificado do modelo.

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

O modelo tem de ser uma string alfanumérica com um limite de 40 carateres.
displayName

string

O nome a apresentar do modelo.
modelVersion

string (int64 format)

A versão do modelo.
modelState

enum (ModelState)

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

string (Timestamp format)

Descontinuado: data/hora de criação do modelo.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
trainingStartTime

string (Timestamp format)

Indicação de tempo em que a preparação do modelo foi iniciada.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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 preparado.
errorMessage

string

Atualmente, este campo só é preenchido se o estado do modelo for INPUT_VALIDATION_FAILED.

ModelState

O estado do modelo.

Enumerações
MODEL_STATE_UNSPECIFIED Valor predefinido.
TRAINING_PAUSED O modelo está num estado de preparação pausado.
TRAINING O modelo está atualmente a ser preparado.
TRAINING_COMPLETE O modelo concluiu a preparação com êxito.
READY_FOR_SERVING O modelo está pronto para publicação.
TRAINING_FAILED Falha na preparação do modelo.
NO_IMPROVEMENT A preparação do modelo foi concluída com êxito, mas as métricas não melhoraram.
INPUT_VALIDATION_FAILED A validação dos dados de entrada falhou. A preparação do modelo não foi iniciada.