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

すべてのカスタムモデルのリストを取得します。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 入力データの検証に失敗しました。モデルのトレーニングが開始されませんでした。