REST Resource: projects.locations.models Stay organized with collections Save and categorize content based on your preferences.
Resource: Model
A trained machine learning Model.
namestringThe resource name of the Model.
versionIdstringOutput 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.
versionAliases[]stringuser provided version aliases so that a model version can be referenced via alias (i.e.projects/{project}/locations/{location}/models/{modelId}@{version_alias} instead of auto-generated version id (i.e.projects/{project}/locations/{location}/models/{modelId}@{versionId}). The format is [a-z][a-zA-Z0-9-]{0,126}[a-z0-9] to distinguish from versionId. 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.
versionCreateTimestring (Timestamp format)Output only. timestamp when this version was created.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".
versionUpdateTimestring (Timestamp format)Output only. timestamp when this version was most recently updated.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".
displayNamestringRequired. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters.
descriptionstringThe description of the Model.
versionDescriptionstringThe description of this version.
defaultCheckpointIdstringThe default checkpoint id of a model version.
predictSchemataobject (PredictSchemata)The schemata that describe formats of the Model's predictions and explanations as given and returned viaPredictionService.Predict andPredictionService.Explain.
metadataSchemaUristringImmutable. 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.2Schema 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.
metadatavalue (Value format)Immutable. An additional information about the Model; the schema of the metadata can be found inmetadataSchema. Unset if the Model does not have any additional information.
supportedExportFormats[]object (ExportFormat)Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.
trainingPipelinestringOutput only. The resource name of the TrainingPipeline that uploaded this Model, if any.
pipelineJobstringOptional. This field is populated if the model is produced by a pipeline job.
containerSpecobject (ModelContainerSpec)Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested uponModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models.
artifactUristringImmutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.
supportedDeploymentResourcesTypes[]enum (DeploymentResourcesType)Output only. When this Model is deployed, its prediction resources are described by theprediction_resources field of theEndpoint.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 anEndpoint and does not support online predictions (PredictionService.Predict orPredictionService.Explain). Such a Model can serve predictions by using aBatchPredictionJob, if it has at least one entry each insupportedInputStorageFormats andsupportedOutputStorageFormats.
supportedInputStorageFormats[]stringOutput only. The formats this Model supports inBatchPredictionJob.input_config. IfPredictSchemata.instance_schema_uri exists, the instances should be given as per that schema.
The possible formats are:
jsonlThe JSON Lines format, where each instance is a single line. usesGcsSource.csvThe 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. usesGcsSource.tf-recordThe TFRecord format, where each instance is a single record in tfrecord syntax. usesGcsSource.tf-record-gzipSimilar totf-record, but the file is gzipped. usesGcsSource.bigqueryEach instance is a single row in BigQuery. usesBigQuerySource.file-listEach line of the file is the location of an instance to process, usesgcsSourcefield of theInputConfigobject.
If this Model doesn't support any of these formats it means it cannot be used with aBatchPredictionJob. However, if it hassupportedDeploymentResourcesTypes, it could serve online predictions by usingPredictionService.Predict orPredictionService.Explain.
supportedOutputStorageFormats[]stringOutput only. The formats this Model supports inBatchPredictionJob.output_config. If bothPredictSchemata.instance_schema_uri andPredictSchemata.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:
jsonlThe JSON Lines format, where each prediction is a single line. usesGcsDestination.csvThe 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. usesGcsDestination.bigqueryEach prediction is a single row in a BigQuery table, usesBigQueryDestination.
If this Model doesn't support any of these formats it means it cannot be used with aBatchPredictionJob. However, if it hassupportedDeploymentResourcesTypes, it could serve online predictions by usingPredictionService.Predict orPredictionService.Explain.
createTimestring (Timestamp format)Output only. timestamp when this Model was uploaded into Vertex AI.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".
updateTimestring (Timestamp format)Output only. timestamp when this Model was most recently updated.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".
deployedModels[]object (DeployedModelRef)Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to endpoints in different Locations.
explanationSpecobject (ExplanationSpec)The default explanation specification for this Model.
The Model can be used forrequesting explanation after beingdeployed if it is populated. The Model can be used forbatch explanation if it is populated.
All fields of the explanationSpec can be overridden byexplanationSpec ofDeployModelRequest.deployed_model, orexplanationSpec ofBatchPredictionJob.
If the default explanation specification is not set for this Model, this Model can still be used forrequesting explanation by settingexplanationSpec ofDeployModelRequest.deployed_model and forbatch explanation by settingexplanationSpec ofBatchPredictionJob.
etagstringUsed to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labelsmap (key: string, value: string)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.
Seehttps://goo.gl/xmQnxf for more information and examples of labels.
dataStatsobject (DataStats)Stats of data used for training or evaluating the Model.
Only populated when the Model is trained by a TrainingPipeline withdata_input_config.
encryptionSpecobject (EncryptionSpec)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.
modelSourceInfoobject (ModelSourceInfo)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.
originalModelInfoobject (OriginalModelInfo)Output only. If this Model is a copy of another Model, this contains info about the original.
metadataArtifactstringOutput only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern isprojects/{project}/locations/{location}/metadataStores/{metadataStore}/artifacts/{artifact}.
baseModelSourceobject (BaseModelSource)Optional. user input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.
satisfiesPzsbooleanOutput only. reserved for future use.
satisfiesPzibooleanOutput only. reserved for future use.
checkpoints[]object (Checkpoint)Optional. Output only. The checkpoints of the model.
| JSON representation |
|---|
{"name":string,"versionId":string,"versionAliases":[string],"versionCreateTime":string,"versionUpdateTime":string,"displayName":string,"description":string,"versionDescription":string,"defaultCheckpointId":string,"predictSchemata":{object ( |
ExportFormat
Represents export format supported by the Model. All formats export to Google Cloud Storage.
idstringOutput only. The id of the export format. The possible format IDs are:
tfliteUsed for Android mobile devices.edgetpu-tfliteUsed forEdge TPU devices.tf-saved-modelA tensorflow model in SavedModel format.tf-jsATensorFlow.js model that can be used in the browser and in Node.js using JavaScript.core-mlUsed for iOS mobile devices.custom-trainedA Model that was uploaded or trained by custom code.genieA tuned Model Garden model.
exportableContents[]enum (ExportableContent)Output only. The content of this Model that may be exported.
| JSON representation |
|---|
{"id":string,"exportableContents":[enum ( |
ExportableContent
The Model content that can be exported.
| Enums | |
|---|---|
EXPORTABLE_CONTENT_UNSPECIFIED | Should not be used. |
ARTIFACT | Model artifact and any of its supported files. Will be exported to the location specified by theartifactDestination field of theExportModelRequest.output_config object. |
IMAGE | The container image that is to be used when deploying this Model. Will be exported to the location specified by theimageDestination field of theExportModelRequest.output_config object. |
DeploymentResourcesType
Identifies a type of Model's prediction resources.
| Enums | |
|---|---|
DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED | Should not be used. |
DEDICATED_RESOURCES | Resources that are dedicated to theDeployedModel, and that need a higher degree of manual configuration. |
AUTOMATIC_RESOURCES | Resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. |
SHARED_RESOURCES | Resources that can be shared by multipleDeployedModels. A pre-configuredDeploymentResourcePool is required. |
DeployedModelRef
Points to a DeployedModel.
endpointstringImmutable. A resource name of an Endpoint.
deployedModelIdstringImmutable. An id of a DeployedModel in the above Endpoint.
checkpointIdstringImmutable. The id of the Checkpoint deployed in the DeployedModel.
| JSON representation |
|---|
{"endpoint":string,"deployedModelId":string,"checkpointId":string} |
DataStats
Stats of data used for train or evaluate the Model.
trainingDataItemsCountstring (int64 format)Number of DataItems that were used for training this Model.
validationDataItemsCountstring (int64 format)Number of DataItems that were used for validating this Model during training.
testDataItemsCountstring (int64 format)Number of DataItems that were used for evaluating this Model. If the Model is evaluated multiple times, this will be the number of test DataItems used by the first evaluation. If the Model is not evaluated, the number is 0.
trainingAnnotationsCountstring (int64 format)Number of Annotations that are used for training this Model.
validationAnnotationsCountstring (int64 format)Number of Annotations that are used for validating this Model during training.
testAnnotationsCountstring (int64 format)Number of Annotations that are used for evaluating this Model. If the Model is evaluated multiple times, this will be the number of test Annotations used by the first evaluation. If the Model is not evaluated, the number is 0.
| JSON representation |
|---|
{"trainingDataItemsCount":string,"validationDataItemsCount":string,"testDataItemsCount":string,"trainingAnnotationsCount":string,"validationAnnotationsCount":string,"testAnnotationsCount":string} |
ModelSourceInfo
Detail description of the source information of the model.
sourceTypeenum (ModelSourceType)type of the model source.
copybooleanIf this Model is copy of another Model. If true thensourceType pertains to the original.
| JSON representation |
|---|
{"sourceType":enum ( |
ModelSourceType
Source of the model. Different fromobjective field, thisModelSourceType enum indicates the source from which the model was accessed or obtained, whereas theobjective indicates the overall aim or function of this model.
| Enums | |
|---|---|
MODEL_SOURCE_TYPE_UNSPECIFIED | Should not be used. |
AUTOML | The Model is uploaded by automl training pipeline. |
CUSTOM | The Model is uploaded by user or custom training pipeline. |
BQML | The Model is registered and sync'ed from BigQuery ML. |
MODEL_GARDEN | The Model is saved or tuned from Model Garden. |
GENIE | The Model is saved or tuned from Genie. |
CUSTOM_TEXT_EMBEDDING | The Model is uploaded by text embedding finetuning pipeline. |
MARKETPLACE | The Model is saved or tuned from Marketplace. |
OriginalModelInfo
Contains information about the original Model if this Model is a copy.
modelstringOutput only. The resource name of the Model this Model is a copy of, including the revision. Format:projects/{project}/locations/{location}/models/{modelId}@{versionId}
| JSON representation |
|---|
{"model":string} |
BaseModelSource
user input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.
sourceUnion typesource can be only one of the following:modelGardenSourceobject (ModelGardenSource)Source information of Model Garden models.
genieSourceobject (GenieSource)Information about the base model of Genie models.
| JSON representation |
|---|
{// source"modelGardenSource":{object ( |
ModelGardenSource
Contains information about the source of the models generated from Model Garden.
publicModelNamestringRequired. The model garden source model resource name.
versionIdstringOptional. The model garden source model version id.
skipHfModelCachebooleanOptional. Whether to avoid pulling the model from the HF cache.
| JSON representation |
|---|
{"publicModelName":string,"versionId":string,"skipHfModelCache":boolean} |
GenieSource
Contains information about the source of the models generated from Generative AI Studio.
baseModelUristringRequired. The public base model URI.
| JSON representation |
|---|
{"baseModelUri":string} |
Checkpoint
Methods | |
|---|---|
| Copies an already existing Vertex AI Model into the specified Location. |
| Deletes a Model. |
| Deletes a Model version. |
| Exports a trained, exportable Model to a location specified by the user. |
| Gets a Model. |
| Gets the access control policy for a resource. |
| Lists Models in a Location. |
| Lists checkpoints of the specified model version. |
| Lists versions of the specified model. |
| Merges a set of aliases for a Model version. |
| Updates a Model. |
| Sets the access control policy on the specified resource. |
| Returns permissions that a caller has on the specified resource. |
| Incrementally update the dataset used for an examples model. |
| Uploads a Model artifact into Vertex AI. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-22 UTC.