Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::DeployRequest::ModelConfig (v1.27.0)

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

The model config to use for the deployment.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#accept_eula

def accept_eula() -> ::Boolean
Returns
  • (::Boolean) — Optional. Whether the user accepts the End User License Agreement (EULA) for the model.

#accept_eula=

def accept_eula=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether the user accepts the End User License Agreement (EULA) for the model.
Returns
  • (::Boolean) — Optional. Whether the user accepts the End User License Agreement (EULA) for the model.

#container_spec

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

#container_spec=

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

#hugging_face_access_token

def hugging_face_access_token() -> ::String
Returns
  • (::String) — Optional. The Hugging Face read access token used to access the model artifacts of gated models.

#hugging_face_access_token=

def hugging_face_access_token=(value) -> ::String
Parameter
  • value (::String) — Optional. The Hugging Face read access token used to access the model artifacts of gated models.
Returns
  • (::String) — Optional. The Hugging Face read access token used to access the model artifacts of gated models.

#hugging_face_cache_enabled

def hugging_face_cache_enabled() -> ::Boolean
Returns
  • (::Boolean) — Optional. If true, the model will deploy with a cached version instead of directly downloading the model artifacts from Hugging Face. This is suitable for VPC-SC users with limited internet access.

#hugging_face_cache_enabled=

def hugging_face_cache_enabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If true, the model will deploy with a cached version instead of directly downloading the model artifacts from Hugging Face. This is suitable for VPC-SC users with limited internet access.
Returns
  • (::Boolean) — Optional. If true, the model will deploy with a cached version instead of directly downloading the model artifacts from Hugging Face. This is suitable for VPC-SC users with limited internet access.

#model_display_name

def model_display_name() -> ::String
Returns
  • (::String) — Optional. The user-specified display name of the uploaded model. If not set, a default name will be used.

#model_display_name=

def model_display_name=(value) -> ::String
Parameter
  • value (::String) — Optional. The user-specified display name of the uploaded model. If not set, a default name will be used.
Returns
  • (::String) — Optional. The user-specified display name of the uploaded model. If not set, a default name will be used.

#model_user_id

def model_user_id() -> ::String
Returns
  • (::String) — Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. When not provided, Vertex AI will generate a value for this ID. When Model Registry model is provided, this field will be ignored.

    This value may be up to 63 characters, and valid characters are [a-z0-9_-]. The first character cannot be a number or hyphen.

#model_user_id=

def model_user_id=(value) -> ::String
Parameter
  • value (::String) — Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. When not provided, Vertex AI will generate a value for this ID. When Model Registry model is provided, this field will be ignored.

    This value may be up to 63 characters, and valid characters are [a-z0-9_-]. The first character cannot be a number or hyphen.

Returns
  • (::String) — Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. When not provided, Vertex AI will generate a value for this ID. When Model Registry model is provided, this field will be ignored.

    This value may be up to 63 characters, and valid characters are [a-z0-9_-]. The first character cannot be a number or hyphen.