REST Resource: projects.locations.instances.models

Resource: Model

Model represents a trained model.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "state": enum (State),
  "engineVersion": string,
  "engineConfig": string,
  "primaryDataset": string,
  "endTime": string,
  "lineOfBusiness": enum (LineOfBusiness)
}
Fields
name

string

Output only. The resource name of the Model. format: "/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}"

createTime

string (Timestamp format)

Output only. The timestamp of creation of this resource.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. The timestamp of the most recent update of this resource.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

Labels

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

state

enum (State)

Output only. State of the model (creating, active, deleting, etc.)

engineVersion

string

Output only. The EngineVersion used in training this model. This is output only, and is determined from the EngineConfig used.

engineConfig

string

Required. The resource name of the EngineConfig the model training will be based on. Format: "/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engineConfig}"

primaryDataset

string

Required. The resource name of the Primary Dataset used in this model training. For information about how primary and auxiliary datasets are used, refer to the engine version's documentation. Format: "/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}"

endTime

string (Timestamp format)

Required. End_time specifies the latest time from which labels are used and from which data is used to generate features for training. End_time should be no later than the end of the dateRange of the dataset.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

lineOfBusiness

enum (LineOfBusiness)

Output only. The line of business (Retail/Commercial) this model is used for. Determined by EngineConfig, cannot be set by user.

State

The possible states of a resource.

Enums
STATE_UNSPECIFIED State is unspecified, should not occur.
CREATING The resource has not finished being created.
ACTIVE The resource is active/ready to be used.
UPDATING The resource is in the process of being updated.
DELETING The resource is in the process of being deleted.

Methods

create

Creates a model.

delete

Deletes a model.

exportMetadata

Export governance information for Model resource.

get

Gets a model.

list

Lists models.

patch

Updates the parameters of a single Model.