Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExplainRequest

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

Overview

Request message for PredictionService.Explain.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1ExplainRequest

Returns a new instance of GoogleCloudAiplatformV1beta1ExplainRequest.



6529
6530
6531
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 6529

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

Instance Attribute Details

#concurrent_explanation_spec_override ⇒ Hash<String,Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExplanationSpecOverride>

Optional. This field is the same as the one above, but supports multiple explanations to occur in parallel. The key can be any string. Each override will be run against the model, then its explanations will be grouped together. Note - these explanations are run In Addition to the default Explanation in the deployed model. Corresponds to the JSON property concurrentExplanationSpecOverride

Returns:



6499
6500
6501
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 6499

def concurrent_explanation_spec_override
  @concurrent_explanation_spec_override
end

#deployed_model_id ⇒ String

If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding Endpoint.traffic_split. Corresponds to the JSON property deployedModelId

Returns:

  • (String) 


6505
6506
6507
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 6505

def deployed_model_id
  @deployed_model_id
end

#explanation_spec_override ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExplanationSpecOverride

The ExplanationSpec entries that can be overridden at online explanation time. Corresponds to the JSON property explanationSpecOverride

Returns:



6510
6511
6512
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 6510

def explanation_spec_override
  @explanation_spec_override
end

#instances ⇒ Array<Object>

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri. Corresponds to the JSON property instances

Returns:

  • (Array<Object>) 


6520
6521
6522
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 6520

def instances
  @instances
end

#parameters ⇒ Object

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri. Corresponds to the JSON property parameters

Returns:

  • (Object) 


6527
6528
6529
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 6527

def parameters
  @parameters
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6534
6535
6536
6537
6538
6539
6540
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 6534

def update!(**args)
  @concurrent_explanation_spec_override = args[:concurrent_explanation_spec_override] if args.key?(:concurrent_explanation_spec_override)
  @deployed_model_id = args[:deployed_model_id] if args.key?(:deployed_model_id)
  @explanation_spec_override = args[:explanation_spec_override] if args.key?(:explanation_spec_override)
  @instances = args[:instances] if args.key?(:instances)
  @parameters = args[:parameters] if args.key?(:parameters)
end