public final class ExplanationMetadata extends com.google.protobuf.GeneratedMessageV3 implements ExplanationMetadataOrBuilder
Metadata describing the Model's input and output for explanation.Protobuf type
google.cloud.vertexai.v1.ExplanationMetadata| Modifier and Type | Class and Description |
|---|---|
static class |
ExplanationMetadata.Builder
Metadata describing the Model's input and output for explanation.
|
static class |
ExplanationMetadata.InputMetadata
Metadata of the input of a feature.
|
static interface |
ExplanationMetadata.InputMetadataOrBuilder |
static class |
ExplanationMetadata.OutputMetadata
Metadata of the prediction output to be explained.
|
static interface |
ExplanationMetadata.OutputMetadataOrBuilder |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
FEATURE_ATTRIBUTIONS_SCHEMA_URI_FIELD_NUMBER |
static int |
INPUTS_FIELD_NUMBER |
static int |
LATENT_SPACE_SOURCE_FIELD_NUMBER |
static int |
OUTPUTS_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsInputs(String key)
Required.
|
boolean |
containsOutputs(String key)
Required.
|
boolean |
equals(Object obj) |
static ExplanationMetadata |
getDefaultInstance() |
ExplanationMetadata |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getFeatureAttributionsSchemaUri()
Points to a YAML file stored on Google Cloud Storage describing the format
of the [feature
attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions].
|
com.google.protobuf.ByteString |
getFeatureAttributionsSchemaUriBytes()
Points to a YAML file stored on Google Cloud Storage describing the format
of the [feature
attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions].
|
Map<String,ExplanationMetadata.InputMetadata> |
getInputs()
Deprecated.
|
int |
getInputsCount()
Required.
|
Map<String,ExplanationMetadata.InputMetadata> |
getInputsMap()
Required.
|
ExplanationMetadata.InputMetadata |
getInputsOrDefault(String key,
ExplanationMetadata.InputMetadata defaultValue)
Required.
|
ExplanationMetadata.InputMetadata |
getInputsOrThrow(String key)
Required.
|
String |
getLatentSpaceSource()
Name of the source to generate embeddings for example based explanations.
|
com.google.protobuf.ByteString |
getLatentSpaceSourceBytes()
Name of the source to generate embeddings for example based explanations.
|
Map<String,ExplanationMetadata.OutputMetadata> |
getOutputs()
Deprecated.
|
int |
getOutputsCount()
Required.
|
Map<String,ExplanationMetadata.OutputMetadata> |
getOutputsMap()
Required.
|
ExplanationMetadata.OutputMetadata |
getOutputsOrDefault(String key,
ExplanationMetadata.OutputMetadata defaultValue)
Required.
|
ExplanationMetadata.OutputMetadata |
getOutputsOrThrow(String key)
Required.
|
com.google.protobuf.Parser<ExplanationMetadata> |
getParserForType() |
int |
getSerializedSize() |
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
boolean |
isInitialized() |
static ExplanationMetadata.Builder |
newBuilder() |
static ExplanationMetadata.Builder |
newBuilder(ExplanationMetadata prototype) |
ExplanationMetadata.Builder |
newBuilderForType() |
protected ExplanationMetadata.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static ExplanationMetadata |
parseDelimitedFrom(InputStream input) |
static ExplanationMetadata |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ExplanationMetadata |
parseFrom(byte[] data) |
static ExplanationMetadata |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ExplanationMetadata |
parseFrom(ByteBuffer data) |
static ExplanationMetadata |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ExplanationMetadata |
parseFrom(com.google.protobuf.ByteString data) |
static ExplanationMetadata |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ExplanationMetadata |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ExplanationMetadata |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ExplanationMetadata |
parseFrom(InputStream input) |
static ExplanationMetadata |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ExplanationMetadata> |
parser() |
ExplanationMetadata.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int INPUTS_FIELD_NUMBER
public static final int OUTPUTS_FIELD_NUMBER
public static final int FEATURE_ATTRIBUTIONS_SCHEMA_URI_FIELD_NUMBER
public static final int LATENT_SPACE_SOURCE_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public int getInputsCount()
ExplanationMetadataOrBuilderRequired. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs]. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions] are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in [instance][google.cloud.aiplatform.v1.ExplainRequest.instances].
map<string, .google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];
getInputsCount in interface ExplanationMetadataOrBuilderpublic boolean containsInputs(String key)
Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs]. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions] are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in [instance][google.cloud.aiplatform.v1.ExplainRequest.instances].
map<string, .google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];
containsInputs in interface ExplanationMetadataOrBuilder@Deprecated public Map<String,ExplanationMetadata.InputMetadata> getInputs()
getInputsMap() instead.getInputs in interface ExplanationMetadataOrBuilderpublic Map<String,ExplanationMetadata.InputMetadata> getInputsMap()
Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs]. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions] are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in [instance][google.cloud.aiplatform.v1.ExplainRequest.instances].
map<string, .google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];
getInputsMap in interface ExplanationMetadataOrBuilderpublic ExplanationMetadata.InputMetadata getInputsOrDefault(String key, ExplanationMetadata.InputMetadata defaultValue)
Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs]. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions] are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in [instance][google.cloud.aiplatform.v1.ExplainRequest.instances].
map<string, .google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];
getInputsOrDefault in interface ExplanationMetadataOrBuilderpublic ExplanationMetadata.InputMetadata getInputsOrThrow(String key)
Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs]. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions] are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in [instance][google.cloud.aiplatform.v1.ExplainRequest.instances].
map<string, .google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];
getInputsOrThrow in interface ExplanationMetadataOrBuilderpublic int getOutputsCount()
ExplanationMetadataOrBuilderRequired. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
map<string, .google.cloud.vertexai.v1.ExplanationMetadata.OutputMetadata> outputs = 2 [(.google.api.field_behavior) = REQUIRED];
getOutputsCount in interface ExplanationMetadataOrBuilderpublic boolean containsOutputs(String key)
Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
map<string, .google.cloud.vertexai.v1.ExplanationMetadata.OutputMetadata> outputs = 2 [(.google.api.field_behavior) = REQUIRED];
containsOutputs in interface ExplanationMetadataOrBuilder@Deprecated public Map<String,ExplanationMetadata.OutputMetadata> getOutputs()
getOutputsMap() instead.getOutputs in interface ExplanationMetadataOrBuilderpublic Map<String,ExplanationMetadata.OutputMetadata> getOutputsMap()
Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
map<string, .google.cloud.vertexai.v1.ExplanationMetadata.OutputMetadata> outputs = 2 [(.google.api.field_behavior) = REQUIRED];
getOutputsMap in interface ExplanationMetadataOrBuilderpublic ExplanationMetadata.OutputMetadata getOutputsOrDefault(String key, ExplanationMetadata.OutputMetadata defaultValue)
Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
map<string, .google.cloud.vertexai.v1.ExplanationMetadata.OutputMetadata> outputs = 2 [(.google.api.field_behavior) = REQUIRED];
getOutputsOrDefault in interface ExplanationMetadataOrBuilderpublic ExplanationMetadata.OutputMetadata getOutputsOrThrow(String key)
Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
map<string, .google.cloud.vertexai.v1.ExplanationMetadata.OutputMetadata> outputs = 2 [(.google.api.field_behavior) = REQUIRED];
getOutputsOrThrow in interface ExplanationMetadataOrBuilderpublic String getFeatureAttributionsSchemaUri()
Points to a YAML file stored on Google Cloud Storage describing the format of the [feature attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
string feature_attributions_schema_uri = 3;getFeatureAttributionsSchemaUri in interface ExplanationMetadataOrBuilderpublic com.google.protobuf.ByteString getFeatureAttributionsSchemaUriBytes()
Points to a YAML file stored on Google Cloud Storage describing the format of the [feature attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
string feature_attributions_schema_uri = 3;getFeatureAttributionsSchemaUriBytes in interface ExplanationMetadataOrBuilderpublic String getLatentSpaceSource()
Name of the source to generate embeddings for example based explanations.
string latent_space_source = 5;getLatentSpaceSource in interface ExplanationMetadataOrBuilderpublic com.google.protobuf.ByteString getLatentSpaceSourceBytes()
Name of the source to generate embeddings for example based explanations.
string latent_space_source = 5;getLatentSpaceSourceBytes in interface ExplanationMetadataOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ExplanationMetadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExplanationMetadata parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExplanationMetadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExplanationMetadata parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExplanationMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExplanationMetadata parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExplanationMetadata parseFrom(InputStream input) throws IOException
IOExceptionpublic static ExplanationMetadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ExplanationMetadata parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ExplanationMetadata parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ExplanationMetadata parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ExplanationMetadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ExplanationMetadata.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ExplanationMetadata.Builder newBuilder()
public static ExplanationMetadata.Builder newBuilder(ExplanationMetadata prototype)
public ExplanationMetadata.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ExplanationMetadata.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ExplanationMetadata getDefaultInstance()
public static com.google.protobuf.Parser<ExplanationMetadata> parser()
public com.google.protobuf.Parser<ExplanationMetadata> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ExplanationMetadata getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.