Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DeployedModel

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/representations.rb

Overview

A deployment of a Model. Endpoints contain one or more DeployedModels.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1DeployedModel

Returns a new instance of GoogleCloudAiplatformV1DeployedModel.



7750
7751
7752
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7750

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#automatic_resources ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AutomaticResources

A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. Corresponds to the JSON property automaticResources

Returns:



7621
7622
7623
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7621

def automatic_resources
  @automatic_resources
end

#checkpoint_id ⇒ String

The checkpoint id of the model. Corresponds to the JSON property checkpointId

Returns:

  • (String) 


7626
7627
7628
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7626

def checkpoint_id
  @checkpoint_id
end

#create_time ⇒ String

Output only. Timestamp when the DeployedModel was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


7631
7632
7633
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7631

def create_time
  @create_time
end

#dedicated_resources ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DedicatedResources

A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. Corresponds to the JSON property dedicatedResources

Returns:



7637
7638
7639
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7637

def dedicated_resources
  @dedicated_resources
end

#disable_container_logging ⇒ Boolean Also known as: disable_container_logging?

For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send stderr and stdout streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to Cloud Logging pricing. User can disable container logging by setting this flag to true. Corresponds to the JSON property disableContainerLogging

Returns:

  • (Boolean) 


7646
7647
7648
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7646

def disable_container_logging
  @disable_container_logging
end

#disable_explanations ⇒ Boolean Also known as: disable_explanations?

If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec. Corresponds to the JSON property disableExplanations

Returns:

  • (Boolean) 


7653
7654
7655
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7653

def disable_explanations
  @disable_explanations
end

#display_name ⇒ String

The display name of the DeployedModel. If not provided upon creation, the Model's display_name is used. Corresponds to the JSON property displayName

Returns:

  • (String) 


7660
7661
7662
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7660

def display_name
  @display_name
end

#enable_access_logging ⇒ Boolean Also known as: enable_access_logging?

If true, online prediction access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each prediction request. Note that logs may incur a cost, especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option. Corresponds to the JSON property enableAccessLogging

Returns:

  • (Boolean) 


7669
7670
7671
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7669

def enable_access_logging
  @enable_access_logging
end

#explanation_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExplanationSpec

Specification of Model explanation. Corresponds to the JSON property explanationSpec

Returns:



7675
7676
7677
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7675

def explanation_spec
  @explanation_spec
end

#faster_deployment_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FasterDeploymentConfig

Configuration for faster model deployment. Corresponds to the JSON property fasterDeploymentConfig

Returns:



7680
7681
7682
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7680

def faster_deployment_config
  @faster_deployment_config
end

#gdc_connected_model ⇒ String

GDC pretrained / Gemini model name. The model name is a plain model name, e.g. gemini-1.5-flash-002. Corresponds to the JSON property gdcConnectedModel

Returns:

  • (String) 


7686
7687
7688
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7686

def gdc_connected_model
  @gdc_connected_model
end

#id ⇒ String

Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are /[0-9]/. Corresponds to the JSON property id

Returns:

  • (String) 


7693
7694
7695
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7693

def id
  @id
end

#model ⇒ String

The resource name of the Model that this is the deployment of. Note that the Model may be in a different location than the DeployedModel's Endpoint. The resource name may contain version id or version alias to specify the version. Example: projects/project/locations/location/models/model@2 or projects/project/locations/location/models/model@golden if no version is specified, the default version will be deployed. Corresponds to the JSON property model

Returns:

  • (String) 


7703
7704
7705
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7703

def model
  @model
end

#model_version_id ⇒ String

Output only. The version ID of the model that is deployed. Corresponds to the JSON property modelVersionId

Returns:

  • (String) 


7708
7709
7710
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7708

def model_version_id
  @model_version_id
end

#private_endpoints ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PrivateEndpoints

PrivateEndpoints proto is used to provide paths for users to send requests privately. To send request via private service access, use predict_http_uri, explain_http_uri or health_http_uri. To send request via private service connect, use service_attachment. Corresponds to the JSON property privateEndpoints

Returns:



7716
7717
7718
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7716

def private_endpoints
  @private_endpoints
end

#service_account ⇒ String

The service account that the DeployedModel's container runs as. Specify the email address of the service account. If this service account is not specified, the container runs as a service account that doesn't have access to the resource project. Users deploying the Model must have the iam.serviceAccounts. actAs permission on this service account. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


7725
7726
7727
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7725

def 
  @service_account
end

#shared_resources ⇒ String

The resource name of the shared DeploymentResourcePool to deploy on. Format: projects/project/locations/location/deploymentResourcePools/ deployment_resource_pool` Corresponds to the JSON propertysharedResources`

Returns:

  • (String) 


7732
7733
7734
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7732

def shared_resources
  @shared_resources
end

#speculative_decoding_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SpeculativeDecodingSpec

Configuration for Speculative Decoding. Corresponds to the JSON property speculativeDecodingSpec

Returns:



7737
7738
7739
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7737

def speculative_decoding_spec
  @speculative_decoding_spec
end

#status ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DeployedModelStatus

Runtime status of the deployed model. Corresponds to the JSON property status

Returns:



7742
7743
7744
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7742

def status
  @status
end

#system_labels ⇒ Hash<String,String>

System labels to apply to Model Garden deployments. System labels are managed by Google for internal use only. Corresponds to the JSON property systemLabels

Returns:

  • (Hash<String,String>) 


7748
7749
7750
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7748

def system_labels
  @system_labels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7755

def update!(**args)
  @automatic_resources = args[:automatic_resources] if args.key?(:automatic_resources)
  @checkpoint_id = args[:checkpoint_id] if args.key?(:checkpoint_id)
  @create_time = args[:create_time] if args.key?(:create_time)
  @dedicated_resources = args[:dedicated_resources] if args.key?(:dedicated_resources)
  @disable_container_logging = args[:disable_container_logging] if args.key?(:disable_container_logging)
  @disable_explanations = args[:disable_explanations] if args.key?(:disable_explanations)
  @display_name = args[:display_name] if args.key?(:display_name)
  @enable_access_logging = args[:enable_access_logging] if args.key?(:enable_access_logging)
  @explanation_spec = args[:explanation_spec] if args.key?(:explanation_spec)
  @faster_deployment_config = args[:faster_deployment_config] if args.key?(:faster_deployment_config)
  @gdc_connected_model = args[:gdc_connected_model] if args.key?(:gdc_connected_model)
  @id = args[:id] if args.key?(:id)
  @model = args[:model] if args.key?(:model)
  @model_version_id = args[:model_version_id] if args.key?(:model_version_id)
  @private_endpoints = args[:private_endpoints] if args.key?(:private_endpoints)
  @service_account = args[:service_account] if args.key?(:service_account)
  @shared_resources = args[:shared_resources] if args.key?(:shared_resources)
  @speculative_decoding_spec = args[:speculative_decoding_spec] if args.key?(:speculative_decoding_spec)
  @status = args[:status] if args.key?(:status)
  @system_labels = args[:system_labels] if args.key?(:system_labels)
end