Class ExplainRequest (2.3.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class ExplainRequest : IMessage<ExplainRequest>, IEquatable<ExplainRequest>, IDeepCloneable<ExplainRequest>, IBufferMessage, IMessage

Request message for [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].

Inheritance

Object > ExplainRequest

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

ExplainRequest()

public ExplainRequest()

ExplainRequest(ExplainRequest)

public ExplainRequest(ExplainRequest other)
Parameter
NameDescription
otherExplainRequest

Properties

DeployedModelId

public string DeployedModelId { get; set; }

If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].

Property Value
TypeDescription
String

Endpoint

public string Endpoint { get; set; }

Required. The name of the Endpoint requested to serve the explanation. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

Property Value
TypeDescription
String

EndpointAsEndpointName

public EndpointName EndpointAsEndpointName { get; set; }

EndpointName-typed view over the Endpoint resource name property.

Property Value
TypeDescription
EndpointName

ExplanationSpecOverride

public ExplanationSpecOverride ExplanationSpecOverride { get; set; }

If specified, overrides the [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of the DeployedModel. Can be used for explaining prediction results with different configurations, such as:

  • Explaining top-5 predictions results as opposed to top-1;
  • Increasing path count or step count of the attribution methods to reduce approximate errors;
  • Using different baselines for explaining the prediction results.
Property Value
TypeDescription
ExplanationSpecOverride

Instances

public RepeatedField<Value> Instances { get; }

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][google.cloud.aiplatform.v1.DeployedModel.model] [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].

Property Value
TypeDescription
RepeatedField<Value>

Parameters

public Value Parameters { get; set; }

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model] [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].

Property Value
TypeDescription
Value