Google Cloud Ai Platform V1 Client - Class Model (1.32.1)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Model.

A trained machine learning Model.

Generated from protobuf message google.cloud.aiplatform.v1.Model

Constructor.

The resource name of the Model.

The resource name of the Model.

Output only. Immutable. The version ID of the model.

A new version is committed when a new model version is uploaded or trained under an existing model id. It is an auto-incrementing decimal number in string representation.

Output only. Immutable. The version ID of the model.

A new version is committed when a new model version is uploaded or trained under an existing model id. It is an auto-incrementing decimal number in string representation.

User provided version aliases so that a model version can be referenced via alias (i.e.

projects/{project}/locations/{location}/models/{model_id}@{version_alias} instead of auto-generated version id (i.e. projects/{project}/locations/{location}/models/{model_id}@{version_id}) . The format is [a-z][a-zA-Z0-9-]{0,126}[a-z0-9] to distinguish from version_id. A default version alias will be created for the first version of the model, and there must be exactly one default version alias for a model.

User provided version aliases so that a model version can be referenced via alias (i.e.

projects/{project}/locations/{location}/models/{model_id}@{version_alias} instead of auto-generated version id (i.e. projects/{project}/locations/{location}/models/{model_id}@{version_id}) . The format is [a-z][a-zA-Z0-9-]{0,126}[a-z0-9] to distinguish from version_id. A default version alias will be created for the first version of the model, and there must be exactly one default version alias for a model.

Output only. Timestamp when this version was created.

Output only. Timestamp when this version was created.

Output only. Timestamp when this version was most recently updated.

Output only. Timestamp when this version was most recently updated.

Required. The display name of the Model.

The name can be up to 128 characters long and can consist of any UTF-8 characters.

Required. The display name of the Model.

The name can be up to 128 characters long and can consist of any UTF-8 characters.

The description of the Model.

The description of the Model.

The description of this version.

The description of this version.

The default checkpoint id of a model version.

The default checkpoint id of a model version.

The schemata that describe formats of the Model's predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain .

The schemata that describe formats of the Model's predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain .

Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object .

AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object .

AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema .

Unset if the Model does not have any additional information.

Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema .

Unset if the Model does not have any additional information.

Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.

Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.

Output only. The resource name of the TrainingPipeline that uploaded this Model, if any.

Output only. The resource name of the TrainingPipeline that uploaded this Model, if any.

Optional. This field is populated if the model is produced by a pipeline job.

Optional. This field is populated if the model is produced by a pipeline job.

Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel , and all binaries it contains are copied and stored internally by Vertex AI.

Not required for AutoML Models.

Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel , and all binaries it contains are copied and stored internally by Vertex AI.

Not required for AutoML Models.

Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.

Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.

Output only. When this Model is deployed, its prediction resources are described by the prediction_resources field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions ( PredictionService.Predict or PredictionService.Explain ).

Such a Model can serve predictions by using a BatchPredictionJob , if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats .

Output only. When this Model is deployed, its prediction resources are described by the prediction_resources field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions ( PredictionService.Predict or PredictionService.Explain ).

Such a Model can serve predictions by using a BatchPredictionJob , if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats .

Output only. The formats this Model supports in BatchPredictionJob.input_config .

If PredictSchemata.instance_schema_uri exists, the instances should be given as per that schema. The possible formats are:

• jsonl The JSON Lines format, where each instance is a single line. Uses GcsSource .
• csv The CSV format, where each instance is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsSource .
• tf-record The TFRecord format, where each instance is a single record in tfrecord syntax. Uses GcsSource .
• tf-record-gzip Similar to tf-record , but the file is gzipped. Uses GcsSource .
• bigquery Each instance is a single row in BigQuery. Uses BigQuerySource .
• file-list Each line of the file is the location of an instance to process, uses gcs_source field of the InputConfig object. If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob . However, if it has supported_deployment_resources_types , it could serve online predictions by using PredictionService.Predict or PredictionService.Explain .

Output only. The formats this Model supports in BatchPredictionJob.input_config .

If PredictSchemata.instance_schema_uri exists, the instances should be given as per that schema. The possible formats are:

• jsonl The JSON Lines format, where each instance is a single line. Uses GcsSource .
• csv The CSV format, where each instance is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsSource .
• tf-record The TFRecord format, where each instance is a single record in tfrecord syntax. Uses GcsSource .
• tf-record-gzip Similar to tf-record , but the file is gzipped. Uses GcsSource .
• bigquery Each instance is a single row in BigQuery. Uses BigQuerySource .
• file-list Each line of the file is the location of an instance to process, uses gcs_source field of the InputConfig object. If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob . However, if it has supported_deployment_resources_types , it could serve online predictions by using PredictionService.Predict or PredictionService.Explain .

Output only. The formats this Model supports in BatchPredictionJob.output_config .

If both PredictSchemata.instance_schema_uri and PredictSchemata.prediction_schema_uri exist, the predictions are returned together with their instances. In other words, the prediction has the original instance data first, followed by the actual prediction content (as per the schema). The possible formats are:

• jsonl The JSON Lines format, where each prediction is a single line. Uses GcsDestination .
• csv The CSV format, where each prediction is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsDestination .
• bigquery Each prediction is a single row in a BigQuery table, uses BigQueryDestination . If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob . However, if it has supported_deployment_resources_types , it could serve online predictions by using PredictionService.Predict or PredictionService.Explain .

Output only. The formats this Model supports in BatchPredictionJob.output_config .

If both PredictSchemata.instance_schema_uri and PredictSchemata.prediction_schema_uri exist, the predictions are returned together with their instances. In other words, the prediction has the original instance data first, followed by the actual prediction content (as per the schema). The possible formats are:

• jsonl The JSON Lines format, where each prediction is a single line. Uses GcsDestination .
• csv The CSV format, where each prediction is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsDestination .
• bigquery Each prediction is a single row in a BigQuery table, uses BigQueryDestination . If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob . However, if it has supported_deployment_resources_types , it could serve online predictions by using PredictionService.Predict or PredictionService.Explain .

Output only. Timestamp when this Model was uploaded into Vertex AI.

Output only. Timestamp when this Model was uploaded into Vertex AI.

Output only. Timestamp when this Model was most recently updated.

Output only. Timestamp when this Model was most recently updated.

Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.

Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.

The default explanation specification for this Model.

The Model can be used for requesting explanation after being deployed if it is populated. The Model can be used for batch explanation if it is populated. All fields of the explanation_spec can be overridden by explanation_spec of DeployModelRequest.deployed_model , or explanation_spec of BatchPredictionJob . If the default explanation specification is not set for this Model, this Model can still be used for requesting explanation by setting explanation_spec of DeployModelRequest.deployed_model and for batch explanation by setting explanation_spec of BatchPredictionJob .

The default explanation specification for this Model.

The Model can be used for requesting explanation after being deployed if it is populated. The Model can be used for batch explanation if it is populated. All fields of the explanation_spec can be overridden by explanation_spec of DeployModelRequest.deployed_model , or explanation_spec of BatchPredictionJob . If the default explanation specification is not set for this Model, this Model can still be used for requesting explanation by setting explanation_spec of DeployModelRequest.deployed_model and for batch explanation by setting explanation_spec of BatchPredictionJob .

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

The labels with user-defined metadata to organize your Models.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.

The labels with user-defined metadata to organize your Models.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.

Stats of data used for training or evaluating the Model.

Only populated when the Model is trained by a TrainingPipeline with data_input_config .

Stats of data used for training or evaluating the Model.

Only populated when the Model is trained by a TrainingPipeline with data_input_config .

Customer-managed encryption key spec for a Model. If set, this Model and all sub-resources of this Model will be secured by this key.

Customer-managed encryption key spec for a Model. If set, this Model and all sub-resources of this Model will be secured by this key.

Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.

Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.

Output only. If this Model is a copy of another Model, this contains info about the original.

Output only. If this Model is a copy of another Model, this contains info about the original.

Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact} .

Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact} .

Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.

Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.

Output only. Reserved for future use.

Output only. Reserved for future use.

Output only. Reserved for future use.

Output only. Reserved for future use.

Optional. Output only. The checkpoints of the model.

Optional. Output only. The checkpoints of the model.