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

获取所有自定义模型的列表。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
dataStore

string

必需。父级数据存储区的资源名称，例如 projects/*/locations/global/collections/default_collection/dataStores/default_data_store。此字段用于标识要从中提取模型的数据存储区。

请求正文

请求正文必须为空。

响应正文

SearchTuningService.ListCustomModels 方法的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "models": [
    {
      object (CustomTuningModel)
    }
  ]
}
字段
models[]

object (CustomTuningModel)

自定义调优模型列表。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅 Authentication Overview。

IAM 权限

需要拥有 dataStore 资源的以下 IAM 权限：

  • discoveryengine.dataStores.listCustomModels

如需了解详情，请参阅 IAM 文档。

CustomTuningModel

用于描述自定义调优模型的元数据。

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "modelVersion": string,
  "modelState": enum (ModelState),
  "createTime": string,
  "trainingStartTime": string,
  "metrics": {
    string: number,
    ...
  },
  "errorMessage": string
}
字段
name

string

必需。模型的完全限定资源名称。

格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/customTuningModels/{custom_tuning_model}。

型号必须是字母数字字符串，长度上限为 40 个字符。
displayName

string

模型的显示名称。
modelVersion

string (int64 format)

模型的版本。
modelState

enum (ModelState)

模型所处的状态（例如 TRAINING 或 TRAINING_FAILED）。
createTime
(deprecated)

string (Timestamp format)

已弃用：模型创建时的时间戳。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
trainingStartTime

string (Timestamp format)

模型训练启动的时间戳。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
metrics

map (key: string, value: number)

已训练模型的指标。
errorMessage

string

目前，仅当模型状态为 INPUT_VALIDATION_FAILED 时，系统才会填充此字段。

ModelState

模型的状态。

枚举
MODEL_STATE_UNSPECIFIED 默认值。
TRAINING_PAUSED 模型处于暂停训练状态。
TRAINING 模型目前正在训练中。
TRAINING_COMPLETE 模型已成功完成训练。
READY_FOR_SERVING 模型已准备好进行部署。
TRAINING_FAILED 模型训练失败。
NO_IMPROVEMENT 模型训练已成功完成，但指标未得到改善。
INPUT_VALIDATION_FAILED 输入数据验证失败。模型训练未开始。