REST リソース: projects.locations.models

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

リソース: Model

トレーニングされた機械学習モデルを表す API proto。

JSON 表現

{
  "name": string,
  "displayName": string,
  "datasetId": string,
  "createTime": string,
  "updateTime": string,
  "deploymentState": enum(DeploymentState),

  // Union field model_metadata can be only one of the following:
  "imageClassificationModelMetadata": {
    object(ImageClassificationModelMetadata)
  },
  "textClassificationModelMetadata": {
    object(TextClassificationModelMetadata)
  },
  "translationModelMetadata": {
    object(TranslationModelMetadata)
  }
  // End of list of possible types for union field model_metadata.
}
フィールド
name

string

出力のみ。モデルのリソース名。形式: projects/{project_id}/locations/{locationId}/models/{modelId}

displayName

string

必須。インターフェースに表示するモデル名。名前は最長 32 文字で、ASCII ラテン文字の A~Z と a~z、アンダースコア(_)、ASCII 数字 0~9 のみを使用できます。

datasetId

string

必須。モデルの作成に使用されたデータセットのリソース ID。データセットは、同じ祖先プロジェクトとロケーションに由来する必要があります。

createTime

string (Timestamp format)

出力のみ。このモデルが作成されたときのタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

出力のみ。このモデルが最後に更新されたときのタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"

deploymentState

enum(DeploymentState)

出力のみ。モデルのデプロイ状態。モデルは、デプロイされていないと予測リクエストを処理できません。

共用体フィールド model_metadata。必須。問題のタイプに固有のモデル メタデータ。モデルのトレーニングに使用されたデータセットのメタデータ タイプと一致する必要があります。model_metadata は、次のいずれかになります。
imageClassificationModelMetadata

object(ImageClassificationModelMetadata)

画像分類モデルのメタデータ。

textClassificationModelMetadata

object(TextClassificationModelMetadata)

テキスト分類モデルのメタデータ。

translationModelMetadata

object(TranslationModelMetadata)

翻訳モデルのメタデータ。

ImageClassificationModelMetadata

画像分類のモデル メタデータ。

JSON 表現

{
  "baseModelId": string,
  "trainBudget": string,
  "trainCost": string,
  "stopReason": string
}
フィールド
baseModelId

string

省略可。base モデルの ID。指定すると、base モデルに基づいて新しいモデルが作成されます。指定がない場合は、新しいモデルがまったく新規に作成されます。base モデルは、作成する新しいモデルと同じ projectlocation に存在すると想定されます。

trainBudget

string (int64 format)

必須。このモデル作成のトレーニング予算。実際の trainCost はこの値以下になります。

trainCost

string (int64 format)

出力のみ。このモデル作成の実際のトレーニング コスト。このモデルが base モデルから作成されている場合、base モデルの作成に要したトレーニング コストは含まれません。

stopReason

string

出力のみ。BUDGET_REACHED、MODEL_CONVERGED など、このモデルの作成オペレーションが停止した理由。

TextClassificationModelMetadata

テキスト分類に固有のモデル メタデータ。

TranslationModelMetadata

翻訳に固有のモデル メタデータ。

JSON 表現

{
  "baseModel": string,
  "sourceLanguageCode": string,
  "targetLanguageCode": string
}
フィールド
baseModel

string

カスタムモデルのトレーニングのベースラインとして使用するモデルのリソース名。設定しない場合、Google 翻訳で提供されるデフォルトのベースモデルが使用されます。形式: projects/{project_id}/locations/{locationId}/models/{modelId}

sourceLanguageCode

string

出力のみ。データセットから推定されます。トレーニングに使用されるソース言語(BCP-47 言語コード)。

targetLanguageCode

string

出力のみ。トレーニングに使用されるターゲット言語(BCP-47 言語コード)。

DeploymentState

モデルのデプロイ状態。

列挙値
DEPLOYMENT_STATE_UNSPECIFIED 使用しないでください。未指定の列挙値にはこの値がデフォルトで設定されます。
DEPLOYED モデルはデプロイされています。
UNDEPLOYED モデルはデプロイされていません。

メソッド

create

モデルを作成します。

delete

モデルを削除します。

deploy

モデルをデプロイします。

get

モデルを取得します。

list

モデルをリストします。

predict

予測を実施します。

undeploy

モデルをデプロイ解除します。