Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Model (v0.45.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Model.

A trained machine learning Model.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#artifact_uri

def artifact_uri() -> ::String
Returns
  • (::String) — Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.

#artifact_uri=

def artifact_uri=(value) -> ::String
Parameter
  • value (::String) — Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.
Returns
  • (::String) — Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.

#base_model_source

def base_model_source() -> ::Google::Cloud::AIPlatform::V1::Model::BaseModelSource
Returns

#base_model_source=

def base_model_source=(value) -> ::Google::Cloud::AIPlatform::V1::Model::BaseModelSource
Parameter
Returns

#container_spec

def container_spec() -> ::Google::Cloud::AIPlatform::V1::ModelContainerSpec
Returns

#container_spec=

def container_spec=(value) -> ::Google::Cloud::AIPlatform::V1::ModelContainerSpec
Parameter
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#data_stats

def data_stats() -> ::Google::Cloud::AIPlatform::V1::Model::DataStats
Returns

#data_stats=

def data_stats=(value) -> ::Google::Cloud::AIPlatform::V1::Model::DataStats
Parameter
  • value (::Google::Cloud::AIPlatform::V1::Model::DataStats) — Stats of data used for training or evaluating the Model.

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

Returns

#deployed_models

def deployed_models() -> ::Array<::Google::Cloud::AIPlatform::V1::DeployedModelRef>
Returns

#description

def description() -> ::String
Returns
  • (::String) — The description of the Model.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — The description of the Model.
Returns
  • (::String) — The description of the Model.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters.
Returns
  • (::String) — Required. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters.

#encryption_spec

def encryption_spec() -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec
Returns

#encryption_spec=

def encryption_spec=(value) -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec
Parameter
Returns

#etag

def etag() -> ::String
Returns
  • (::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Returns
  • (::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

#explanation_spec

def explanation_spec() -> ::Google::Cloud::AIPlatform::V1::ExplanationSpec
Returns

#explanation_spec=

def explanation_spec=(value) -> ::Google::Cloud::AIPlatform::V1::ExplanationSpec
Parameter
Returns

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::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.

    See https://goo.gl/xmQnxf for more information and examples of labels.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::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.

    See https://goo.gl/xmQnxf for more information and examples of labels.

Returns
  • (::Google::Protobuf::Map{::String => ::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.

    See https://goo.gl/xmQnxf for more information and examples of labels.

#metadata

def metadata() -> ::Google::Protobuf::Value
Returns
  • (::Google::Protobuf::Value) — 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.

#metadata=

def metadata=(value) -> ::Google::Protobuf::Value
Parameter
  • value (::Google::Protobuf::Value) — 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.
Returns
  • (::Google::Protobuf::Value) — 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.

#metadata_artifact

def metadata_artifact() -> ::String
Returns
  • (::String) — 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}.

#metadata_schema_uri

def metadata_schema_uri() -> ::String
Returns
  • (::String) — 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.

#metadata_schema_uri=

def metadata_schema_uri=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#model_source_info

def model_source_info() -> ::Google::Cloud::AIPlatform::V1::ModelSourceInfo
Returns

#name

def name() -> ::String
Returns
  • (::String) — The resource name of the Model.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The resource name of the Model.
Returns
  • (::String) — The resource name of the Model.

#original_model_info

def original_model_info() -> ::Google::Cloud::AIPlatform::V1::Model::OriginalModelInfo
Returns

#pipeline_job

def pipeline_job() -> ::String
Returns
  • (::String) — Optional. This field is populated if the model is produced by a pipeline job.

#pipeline_job=

def pipeline_job=(value) -> ::String
Parameter
  • value (::String) — Optional. This field is populated if the model is produced by a pipeline job.
Returns
  • (::String) — Optional. This field is populated if the model is produced by a pipeline job.

#predict_schemata

def predict_schemata() -> ::Google::Cloud::AIPlatform::V1::PredictSchemata
Returns

#predict_schemata=

def predict_schemata=(value) -> ::Google::Cloud::AIPlatform::V1::PredictSchemata
Parameter
Returns

#satisfies_pzi

def satisfies_pzi() -> ::Boolean
Returns
  • (::Boolean) — Output only. Reserved for future use.

#satisfies_pzs

def satisfies_pzs() -> ::Boolean
Returns
  • (::Boolean) — Output only. Reserved for future use.

#supported_deployment_resources_types

def supported_deployment_resources_types() -> ::Array<::Google::Cloud::AIPlatform::V1::Model::DeploymentResourcesType>
Returns

#supported_export_formats

def supported_export_formats() -> ::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat>
Returns

#supported_input_storage_formats

def supported_input_storage_formats() -> ::Array<::String>
Returns

#supported_output_storage_formats

def supported_output_storage_formats() -> ::Array<::String>
Returns

#training_pipeline

def training_pipeline() -> ::String
Returns
  • (::String) — Output only. The resource name of the TrainingPipeline that uploaded this Model, if any.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#version_aliases

def version_aliases() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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.

#version_aliases=

def version_aliases=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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.
Returns
  • (::Array<::String>) — 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.

#version_create_time

def version_create_time() -> ::Google::Protobuf::Timestamp
Returns

#version_description

def version_description() -> ::String
Returns
  • (::String) — The description of this version.

#version_description=

def version_description=(value) -> ::String
Parameter
  • value (::String) — The description of this version.
Returns
  • (::String) — The description of this version.

#version_id

def version_id() -> ::String
Returns
  • (::String) — 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.

#version_update_time

def version_update_time() -> ::Google::Protobuf::Timestamp
Returns