Class GoogleCloudAiplatformV1beta1Model
A trained machine learning Model.
Implements
Inherited Members
Namespace: Google.Apis.Aiplatform.v1beta1.Data
Assembly: Google.Apis.Aiplatform.v1beta1.dll
Syntax
public class GoogleCloudAiplatformV1beta1Model : IDirectResponseSchema
Properties
ArtifactUri
Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.
Declaration
[JsonProperty("artifactUri")]
public virtual string ArtifactUri { get; set; }
Property Value
Type | Description |
---|---|
string |
BaseModelSource
Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.
Declaration
[JsonProperty("baseModelSource")]
public virtual GoogleCloudAiplatformV1beta1ModelBaseModelSource BaseModelSource { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudAiplatformV1beta1ModelBaseModelSource |
ContainerSpec
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.
Declaration
[JsonProperty("containerSpec")]
public virtual GoogleCloudAiplatformV1beta1ModelContainerSpec ContainerSpec { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudAiplatformV1beta1ModelContainerSpec |
CreateTime
object representation of CreateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
CreateTimeDateTimeOffset
DateTimeOffset representation of CreateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
CreateTimeRaw
Output only. Timestamp when this Model was uploaded into Vertex AI.
Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
DeployedModels
Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
Declaration
[JsonProperty("deployedModels")]
public virtual IList<GoogleCloudAiplatformV1beta1DeployedModelRef> DeployedModels { get; set; }
Property Value
Type | Description |
---|---|
IList<GoogleCloudAiplatformV1beta1DeployedModelRef> |
Description
The description of the Model.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type | Description |
---|---|
string |
DisplayName
Required. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters.
Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("encryptionSpec")]
public virtual GoogleCloudAiplatformV1beta1EncryptionSpec EncryptionSpec { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudAiplatformV1beta1EncryptionSpec |
ExplanationSpec
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.
Declaration
[JsonProperty("explanationSpec")]
public virtual GoogleCloudAiplatformV1beta1ExplanationSpec ExplanationSpec { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudAiplatformV1beta1ExplanationSpec |
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.
Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, string> |
Metadata
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.
Declaration
[JsonProperty("metadata")]
public virtual object Metadata { get; set; }
Property Value
Type | Description |
---|---|
object |
MetadataArtifact
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}
.
Declaration
[JsonProperty("metadataArtifact")]
public virtual string MetadataArtifact { get; set; }
Property Value
Type | Description |
---|---|
string |
MetadataSchemaUri
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.
Declaration
[JsonProperty("metadataSchemaUri")]
public virtual string MetadataSchemaUri { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("modelSourceInfo")]
public virtual GoogleCloudAiplatformV1beta1ModelSourceInfo ModelSourceInfo { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudAiplatformV1beta1ModelSourceInfo |
Name
The resource name of the Model.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
OriginalModelInfo
Output only. If this Model is a copy of another Model, this contains info about the original.
Declaration
[JsonProperty("originalModelInfo")]
public virtual GoogleCloudAiplatformV1beta1ModelOriginalModelInfo OriginalModelInfo { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudAiplatformV1beta1ModelOriginalModelInfo |
PredictSchemata
The schemata that describe formats of the Model's predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain.
Declaration
[JsonProperty("predictSchemata")]
public virtual GoogleCloudAiplatformV1beta1PredictSchemata PredictSchemata { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudAiplatformV1beta1PredictSchemata |
SatisfiesPzi
Output only. Reserved for future use.
Declaration
[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }
Property Value
Type | Description |
---|---|
bool? |
SatisfiesPzs
Output only. Reserved for future use.
Declaration
[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }
Property Value
Type | Description |
---|---|
bool? |
SupportedDeploymentResourcesTypes
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.
Declaration
[JsonProperty("supportedDeploymentResourcesTypes")]
public virtual IList<string> SupportedDeploymentResourcesTypes { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |
SupportedExportFormats
Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.
Declaration
[JsonProperty("supportedExportFormats")]
public virtual IList<GoogleCloudAiplatformV1beta1ModelExportFormat> SupportedExportFormats { get; set; }
Property Value
Type | Description |
---|---|
IList<GoogleCloudAiplatformV1beta1ModelExportFormat> |
SupportedInputStorageFormats
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.
Declaration
[JsonProperty("supportedInputStorageFormats")]
public virtual IList<string> SupportedInputStorageFormats { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |
SupportedOutputStorageFormats
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.
Declaration
[JsonProperty("supportedOutputStorageFormats")]
public virtual IList<string> SupportedOutputStorageFormats { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |
TrainingPipeline
Output only. The resource name of the TrainingPipeline that uploaded this Model, if any.
Declaration
[JsonProperty("trainingPipeline")]
public virtual string TrainingPipeline { get; set; }
Property Value
Type | Description |
---|---|
string |
UpdateTime
object representation of UpdateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
UpdateTimeDateTimeOffset
DateTimeOffset representation of UpdateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
UpdateTimeRaw
Output only. Timestamp when this Model was most recently updated.
Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
VersionAliases
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{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.
Declaration
[JsonProperty("versionAliases")]
public virtual IList<string> VersionAliases { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |
VersionCreateTime
object representation of VersionCreateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use VersionCreateTimeDateTimeOffset instead.")]
public virtual object VersionCreateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
VersionCreateTimeDateTimeOffset
DateTimeOffset representation of VersionCreateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? VersionCreateTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
VersionCreateTimeRaw
Output only. Timestamp when this version was created.
Declaration
[JsonProperty("versionCreateTime")]
public virtual string VersionCreateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
VersionDescription
The description of this version.
Declaration
[JsonProperty("versionDescription")]
public virtual string VersionDescription { get; set; }
Property Value
Type | Description |
---|---|
string |
VersionId
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.
Declaration
[JsonProperty("versionId")]
public virtual string VersionId { get; set; }
Property Value
Type | Description |
---|---|
string |
VersionUpdateTime
object representation of VersionUpdateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use VersionUpdateTimeDateTimeOffset instead.")]
public virtual object VersionUpdateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
VersionUpdateTimeDateTimeOffset
DateTimeOffset representation of VersionUpdateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? VersionUpdateTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
VersionUpdateTimeRaw
Output only. Timestamp when this version was most recently updated.
Declaration
[JsonProperty("versionUpdateTime")]
public virtual string VersionUpdateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |