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

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

Request message for ModelGardenService.Deploy.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#deploy_config

def deploy_config() -> ::Google::Cloud::AIPlatform::V1::DeployRequest::DeployConfig

Returns

• (::Google::Cloud::AIPlatform::V1::DeployRequest::DeployConfig) — Optional. The deploy config to use for the deployment. If not specified, the default deploy config will be used.

#deploy_config=

def deploy_config=(value) -> ::Google::Cloud::AIPlatform::V1::DeployRequest::DeployConfig

Parameter

• value (::Google::Cloud::AIPlatform::V1::DeployRequest::DeployConfig) — Optional. The deploy config to use for the deployment. If not specified, the default deploy config will be used.

Returns

• (::Google::Cloud::AIPlatform::V1::DeployRequest::DeployConfig) — Optional. The deploy config to use for the deployment. If not specified, the default deploy config will be used.

#destination

def destination() -> ::String

Returns

• (::String) — Required. The resource name of the Location to deploy the model in. Format: projects/{project}/locations/{location}

#destination=

def destination=(value) -> ::String

Parameter

• value (::String) — Required. The resource name of the Location to deploy the model in. Format: projects/{project}/locations/{location}

Returns

• (::String) — Required. The resource name of the Location to deploy the model in. Format: projects/{project}/locations/{location}

#endpoint_config

def endpoint_config() -> ::Google::Cloud::AIPlatform::V1::DeployRequest::EndpointConfig

Returns

• (::Google::Cloud::AIPlatform::V1::DeployRequest::EndpointConfig) — Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used.

#endpoint_config=

def endpoint_config=(value) -> ::Google::Cloud::AIPlatform::V1::DeployRequest::EndpointConfig

Parameter

• value (::Google::Cloud::AIPlatform::V1::DeployRequest::EndpointConfig) — Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used.

Returns

• (::Google::Cloud::AIPlatform::V1::DeployRequest::EndpointConfig) — Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used.

#hugging_face_model_id

def hugging_face_model_id() -> ::String

Returns

• (::String) — The Hugging Face model to deploy. Format: Hugging Face model ID like google/gemma-2-2b-it.

  Note: The following fields are mutually exclusive: hugging_face_model_id, publisher_model_name. If a field in that set is populated, all other fields in the set will automatically be cleared.

#hugging_face_model_id=

def hugging_face_model_id=(value) -> ::String

Parameter

• value (::String) — The Hugging Face model to deploy. Format: Hugging Face model ID like google/gemma-2-2b-it.

  Note: The following fields are mutually exclusive: hugging_face_model_id, publisher_model_name. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::String) — The Hugging Face model to deploy. Format: Hugging Face model ID like google/gemma-2-2b-it.

  Note: The following fields are mutually exclusive: hugging_face_model_id, publisher_model_name. If a field in that set is populated, all other fields in the set will automatically be cleared.

#model_config

def model_config() -> ::Google::Cloud::AIPlatform::V1::DeployRequest::ModelConfig

Returns

• (::Google::Cloud::AIPlatform::V1::DeployRequest::ModelConfig) — Optional. The model config to use for the deployment. If not specified, the default model config will be used.

#model_config=

def model_config=(value) -> ::Google::Cloud::AIPlatform::V1::DeployRequest::ModelConfig

Parameter

• value (::Google::Cloud::AIPlatform::V1::DeployRequest::ModelConfig) — Optional. The model config to use for the deployment. If not specified, the default model config will be used.

Returns

• (::Google::Cloud::AIPlatform::V1::DeployRequest::ModelConfig) — Optional. The model config to use for the deployment. If not specified, the default model config will be used.

#publisher_model_name

def publisher_model_name() -> ::String

Returns

• (::String) — The Model Garden model to deploy. Format: publishers/{publisher}/models/{publisher_model}@{version_id}, or publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001.

  Note: The following fields are mutually exclusive: publisher_model_name, hugging_face_model_id. If a field in that set is populated, all other fields in the set will automatically be cleared.

#publisher_model_name=

def publisher_model_name=(value) -> ::String

Parameter

• value (::String) — The Model Garden model to deploy. Format: publishers/{publisher}/models/{publisher_model}@{version_id}, or publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001.

  Note: The following fields are mutually exclusive: publisher_model_name, hugging_face_model_id. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::String) — The Model Garden model to deploy. Format: publishers/{publisher}/models/{publisher_model}@{version_id}, or publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001.

  Note: The following fields are mutually exclusive: publisher_model_name, hugging_face_model_id. If a field in that set is populated, all other fields in the set will automatically be cleared.