Class ExplainRequest (0.2.0)

publicfinalclass ExplainRequestextendsGeneratedMessageV3implementsExplainRequestOrBuilder

Request message for PredictionService.Explain.

Protobuf type google.cloud.vertexai.v1beta1.ExplainRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ExplainRequest

Implements

ExplainRequestOrBuilder

Inherited Members

publicstaticfinalintCONCURRENT_EXPLANATION_SPEC_OVERRIDE_FIELD_NUMBER

publicstaticfinalintDEPLOYED_MODEL_ID_FIELD_NUMBER

publicstaticfinalintENDPOINT_FIELD_NUMBER

publicstaticfinalintEXPLANATION_SPEC_OVERRIDE_FIELD_NUMBER

publicstaticfinalintINSTANCES_FIELD_NUMBER

publicstaticfinalintPARAMETERS_FIELD_NUMBER

publicstaticExplainRequestgetDefaultInstance()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicstaticExplainRequest.BuildernewBuilder()

publicstaticExplainRequest.BuildernewBuilder(ExplainRequestprototype)

publicstaticExplainRequestparseDelimitedFrom(InputStreaminput)

publicstaticExplainRequestparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticExplainRequestparseFrom(byte[]data)

publicstaticExplainRequestparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)

publicstaticExplainRequestparseFrom(ByteStringdata)

publicstaticExplainRequestparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)

publicstaticExplainRequestparseFrom(CodedInputStreaminput)

publicstaticExplainRequestparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticExplainRequestparseFrom(InputStreaminput)

publicstaticExplainRequestparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticExplainRequestparseFrom(ByteBufferdata)

publicstaticExplainRequestparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)

publicstaticParser<ExplainRequest>parser()

publicbooleancontainsConcurrentExplanationSpecOverride(Stringkey)

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.

map<string, .google.cloud.vertexai.v1beta1.ExplanationSpecOverride> concurrent_explanation_spec_override = 6 [(.google.api.field_behavior) = OPTIONAL];

publicbooleanequals(Objectobj)

AbstractMessage.equals(Object other)

publicMap<String,ExplanationSpecOverride>getConcurrentExplanationSpecOverride()

Use #getConcurrentExplanationSpecOverrideMap() instead.

publicintgetConcurrentExplanationSpecOverrideCount()

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.

map<string, .google.cloud.vertexai.v1beta1.ExplanationSpecOverride> concurrent_explanation_spec_override = 6 [(.google.api.field_behavior) = OPTIONAL];

publicMap<String,ExplanationSpecOverride>getConcurrentExplanationSpecOverrideMap()

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.

map<string, .google.cloud.vertexai.v1beta1.ExplanationSpecOverride> concurrent_explanation_spec_override = 6 [(.google.api.field_behavior) = OPTIONAL];

publicExplanationSpecOverridegetConcurrentExplanationSpecOverrideOrDefault(Stringkey,ExplanationSpecOverridedefaultValue)

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.

map<string, .google.cloud.vertexai.v1beta1.ExplanationSpecOverride> concurrent_explanation_spec_override = 6 [(.google.api.field_behavior) = OPTIONAL];

publicExplanationSpecOverridegetConcurrentExplanationSpecOverrideOrThrow(Stringkey)

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.

map<string, .google.cloud.vertexai.v1beta1.ExplanationSpecOverride> concurrent_explanation_spec_override = 6 [(.google.api.field_behavior) = OPTIONAL];

publicExplainRequestgetDefaultInstanceForType()

publicStringgetDeployedModelId()

If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding Endpoint.traffic_split.

string deployed_model_id = 3;

publicByteStringgetDeployedModelIdBytes()

If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding Endpoint.traffic_split.

string deployed_model_id = 3;

publicStringgetEndpoint()

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

string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

publicByteStringgetEndpointBytes()

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

string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

publicExplanationSpecOverridegetExplanationSpecOverride()

If specified, overrides the 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.

.google.cloud.vertexai.v1beta1.ExplanationSpecOverride explanation_spec_override = 5;

publicExplanationSpecOverrideOrBuildergetExplanationSpecOverrideOrBuilder()

If specified, overrides the 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.

.google.cloud.vertexai.v1beta1.ExplanationSpecOverride explanation_spec_override = 5;

publicValuegetInstances(intindex)

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.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

publicintgetInstancesCount()

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.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

publicList<Value>getInstancesList()

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.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

publicValueOrBuildergetInstancesOrBuilder(intindex)

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.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

publicList<?extendsValueOrBuilder>getInstancesOrBuilderList()

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.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

publicValuegetParameters()

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.

.google.protobuf.Value parameters = 4;

publicValueOrBuildergetParametersOrBuilder()

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.

.google.protobuf.Value parameters = 4;

publicParser<ExplainRequest>getParserForType()

GeneratedMessageV3.getParserForType()

publicintgetSerializedSize()

GeneratedMessageV3.getSerializedSize()

publicbooleanhasExplanationSpecOverride()

If specified, overrides the 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.

.google.cloud.vertexai.v1beta1.ExplanationSpecOverride explanation_spec_override = 5;

publicbooleanhasParameters()

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.

.google.protobuf.Value parameters = 4;

publicinthashCode()

AbstractMessage.hashCode()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.internalGetFieldAccessorTable()

protectedMapFieldinternalGetMapField(intnumber)

GeneratedMessageV3.internalGetMapField(int fieldNumber)

publicfinalbooleanisInitialized()

GeneratedMessageV3.isInitialized()

publicExplainRequest.BuildernewBuilderForType()

protectedExplainRequest.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

publicExplainRequest.BuildertoBuilder()

publicvoidwriteTo(CodedOutputStreamoutput)

GeneratedMessageV3.writeTo(CodedOutputStream output)