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

取得所有自訂模型的清單。

HTTP 要求

GET https://discoveryengine.googleapis.com/v1/{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 標準化，並使用 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 標準化，並使用 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 輸入資料驗證失敗。模型訓練未開始。