publicfinalclass ExamplesextendsGeneratedMessageV3implementsExamplesOrBuilder
Example-based explainability that returns the nearest neighbors from the
provided dataset.
Protobuf type google.cloud.vertexai.v1beta1.Examples
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
EXAMPLE_GCS_SOURCE_FIELD_NUMBER
publicstaticfinalintEXAMPLE_GCS_SOURCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
GCS_SOURCE_FIELD_NUMBER
publicstaticfinalintGCS_SOURCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
NEAREST_NEIGHBOR_SEARCH_CONFIG_FIELD_NUMBER
publicstaticfinalintNEAREST_NEIGHBOR_SEARCH_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
NEIGHBOR_COUNT_FIELD_NUMBER
publicstaticfinalintNEIGHBOR_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
PRESETS_FIELD_NUMBER
publicstaticfinalintPRESETS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
Static Methods
getDefaultInstance()
publicstaticExamplesgetDefaultInstance()
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticExamples.BuildernewBuilder()
newBuilder(Examples prototype)
publicstaticExamples.BuildernewBuilder(Examplesprototype)
| Parameter |
| Name |
Description |
prototype |
Examples
|
publicstaticExamplesparseDelimitedFrom(InputStreaminput)
publicstaticExamplesparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(byte[] data)
publicstaticExamplesparseFrom(byte[]data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticExamplesparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteString data)
publicstaticExamplesparseFrom(ByteStringdata)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticExamplesparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
publicstaticExamplesparseFrom(CodedInputStreaminput)
publicstaticExamplesparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
publicstaticExamplesparseFrom(InputStreaminput)
publicstaticExamplesparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteBuffer data)
publicstaticExamplesparseFrom(ByteBufferdata)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticExamplesparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
parser()
publicstaticParser<Examples>parser()
Methods
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getConfigCase()
publicExamples.ConfigCasegetConfigCase()
getDefaultInstanceForType()
publicExamplesgetDefaultInstanceForType()
getExampleGcsSource()
publicExamples.ExampleGcsSourcegetExampleGcsSource()
The Cloud Storage input instances.
.google.cloud.vertexai.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;
getExampleGcsSourceOrBuilder()
publicExamples.ExampleGcsSourceOrBuildergetExampleGcsSourceOrBuilder()
The Cloud Storage input instances.
.google.cloud.vertexai.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;
getGcsSource()
publicGcsSourcegetGcsSource()
The Cloud Storage locations that contain the instances to be
indexed for approximate nearest neighbor search.
.google.cloud.vertexai.v1beta1.GcsSource gcs_source = 1;
| Returns |
| Type |
Description |
GcsSource |
The gcsSource.
|
getGcsSourceOrBuilder()
publicGcsSourceOrBuildergetGcsSourceOrBuilder()
The Cloud Storage locations that contain the instances to be
indexed for approximate nearest neighbor search.
.google.cloud.vertexai.v1beta1.GcsSource gcs_source = 1;
getNearestNeighborSearchConfig()
publicValuegetNearestNeighborSearchConfig()
The full configuration for the generated index, the semantics are the
same as metadata and
should match
NearestNeighborSearchConfig.
.google.protobuf.Value nearest_neighbor_search_config = 2;
| Returns |
| Type |
Description |
Value |
The nearestNeighborSearchConfig.
|
getNearestNeighborSearchConfigOrBuilder()
publicValueOrBuildergetNearestNeighborSearchConfigOrBuilder()
The full configuration for the generated index, the semantics are the
same as metadata and
should match
NearestNeighborSearchConfig.
.google.protobuf.Value nearest_neighbor_search_config = 2;
getNeighborCount()
publicintgetNeighborCount()
The number of neighbors to return when querying for examples.
int32 neighbor_count = 3;
| Returns |
| Type |
Description |
int |
The neighborCount.
|
getParserForType()
publicParser<Examples>getParserForType()
Overrides
getPresets()
publicPresetsgetPresets()
Simplified preset configuration, which automatically sets configuration
values based on the desired query speed-precision trade-off and modality.
.google.cloud.vertexai.v1beta1.Presets presets = 4;
| Returns |
| Type |
Description |
Presets |
The presets.
|
getPresetsOrBuilder()
publicPresetsOrBuildergetPresetsOrBuilder()
Simplified preset configuration, which automatically sets configuration
values based on the desired query speed-precision trade-off and modality.
.google.cloud.vertexai.v1beta1.Presets presets = 4;
getSerializedSize()
publicintgetSerializedSize()
| Returns |
| Type |
Description |
int |
Overrides
getSourceCase()
publicExamples.SourceCasegetSourceCase()
hasExampleGcsSource()
publicbooleanhasExampleGcsSource()
The Cloud Storage input instances.
.google.cloud.vertexai.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;
| Returns |
| Type |
Description |
boolean |
Whether the exampleGcsSource field is set.
|
hasGcsSource()
publicbooleanhasGcsSource()
The Cloud Storage locations that contain the instances to be
indexed for approximate nearest neighbor search.
.google.cloud.vertexai.v1beta1.GcsSource gcs_source = 1;
| Returns |
| Type |
Description |
boolean |
Whether the gcsSource field is set.
|
hasNearestNeighborSearchConfig()
publicbooleanhasNearestNeighborSearchConfig()
The full configuration for the generated index, the semantics are the
same as metadata and
should match
NearestNeighborSearchConfig.
.google.protobuf.Value nearest_neighbor_search_config = 2;
| Returns |
| Type |
Description |
boolean |
Whether the nearestNeighborSearchConfig field is set.
|
hasPresets()
publicbooleanhasPresets()
Simplified preset configuration, which automatically sets configuration
values based on the desired query speed-precision trade-off and modality.
.google.cloud.vertexai.v1beta1.Presets presets = 4;
| Returns |
| Type |
Description |
boolean |
Whether the presets field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
Overrides
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Overrides
isInitialized()
publicfinalbooleanisInitialized()
Overrides
newBuilderForType()
publicExamples.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedExamples.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
| Returns |
| Type |
Description |
Object |
Overrides
toBuilder()
publicExamples.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
Overrides