public sealed class ExplainRequest : IMessage<ExplainRequest>, IEquatable<ExplainRequest>, IDeepCloneable<ExplainRequest>, IBufferMessage, IMessageReference documentation and code samples for the Cloud AI Platform v1beta1 API class ExplainRequest.
Request message for [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
Implements
IMessageExplainRequest, IEquatableExplainRequest, IDeepCloneableExplainRequest, IBufferMessage, IMessageNamespace
Google.Cloud.AIPlatform.V1Beta1Assembly
Google.Cloud.AIPlatform.V1Beta1.dll
Constructors
ExplainRequest()
public ExplainRequest()ExplainRequest(ExplainRequest)
public ExplainRequest(ExplainRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ExplainRequest |
Properties
ConcurrentExplanationSpecOverride
public MapField<string, ExplanationSpecOverride> ConcurrentExplanationSpecOverride { get; }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.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringExplanationSpecOverride |
|
DeployedModelId
public string DeployedModelId { get; set; }If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding [Endpoint.traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split].
| Property Value | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
string |
|
EndpointAsEndpointName
public EndpointName EndpointAsEndpointName { get; set; }EndpointName-typed view over the Endpoint resource name property.
| Property Value | |
|---|---|
| Type | Description |
EndpointName |
|
ExplanationSpecOverride
public ExplanationSpecOverride ExplanationSpecOverride { get; set; }If specified, overrides the [explanation_spec][google.cloud.aiplatform.v1beta1.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 | |
|---|---|
| Type | Description |
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.v1beta1.DeployedModel.model] [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri].
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldValue |
|
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.v1beta1.DeployedModel.model] [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] [parameters_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri].
| Property Value | |
|---|---|
| Type | Description |
Value |
|