Send feedback
Class Examples (3.52.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.52.0 keyboard_arrow_down
public final class Examples extends GeneratedMessageV3 implements ExamplesOrBuilder
Example-based explainability that returns the nearest neighbors from the
provided dataset.
Protobuf type google.cloud.aiplatform.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
public static final int EXAMPLE_GCS_SOURCE_FIELD_NUMBER
Field Value
Type Description
int
public static final int GCS_SOURCE_FIELD_NUMBER
Field Value
Type Description
int
public static final int NEAREST_NEIGHBOR_SEARCH_CONFIG_FIELD_NUMBER
Field Value
Type Description
int
public static final int NEIGHBOR_COUNT_FIELD_NUMBER
Field Value
Type Description
int
public static final int PRESETS_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static Examples getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static Examples . Builder newBuilder ()
public static Examples . Builder newBuilder ( Examples prototype )
Parameter
Name Description
prototypeExamples
public static Examples parseDelimitedFrom ( InputStream input )
public static Examples parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static Examples parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static Examples parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static Examples parseFrom ( ByteString data )
public static Examples parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Examples parseFrom ( CodedInputStream input )
public static Examples parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Examples parseFrom ( InputStream input )
public static Examples parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static Examples parseFrom ( ByteBuffer data )
public static Examples parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<Examples> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
public Examples . ConfigCase getConfigCase ()
public Examples getDefaultInstanceForType ()
public Examples . ExampleGcsSource getExampleGcsSource ()
The Cloud Storage input instances.
.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;
public Examples . ExampleGcsSourceOrBuilder getExampleGcsSourceOrBuilder ()
The Cloud Storage input instances.
.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;
public GcsSource getGcsSource ()
The Cloud Storage locations that contain the instances to be
indexed for approximate nearest neighbor search.
.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;
Returns
Type Description
GcsSource The gcsSource.
public GcsSourceOrBuilder getGcsSourceOrBuilder ()
The Cloud Storage locations that contain the instances to be
indexed for approximate nearest neighbor search.
.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;
public Value getNearestNeighborSearchConfig ()
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.
public ValueOrBuilder getNearestNeighborSearchConfigOrBuilder ()
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;
public int getNeighborCount ()
The number of neighbors to return when querying for examples.
int32 neighbor_count = 3;
Returns
Type Description
int The neighborCount.
public Parser<Examples> getParserForType ()
Overrides
public Presets getPresets ()
Simplified preset configuration, which automatically sets configuration
values based on the desired query speed-precision trade-off and modality.
.google.cloud.aiplatform.v1beta1.Presets presets = 4;
Returns
Type Description
Presets The presets.
public PresetsOrBuilder getPresetsOrBuilder ()
Simplified preset configuration, which automatically sets configuration
values based on the desired query speed-precision trade-off and modality.
.google.cloud.aiplatform.v1beta1.Presets presets = 4;
public int getSerializedSize ()
Returns
Type Description
int
Overrides
public Examples . SourceCase getSourceCase ()
public boolean hasExampleGcsSource ()
The Cloud Storage input instances.
.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;
Returns
Type Description
boolean Whether the exampleGcsSource field is set.
public boolean hasGcsSource ()
The Cloud Storage locations that contain the instances to be
indexed for approximate nearest neighbor search.
.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;
Returns
Type Description
boolean Whether the gcsSource field is set.
public boolean hasNearestNeighborSearchConfig ()
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.
public boolean hasPresets ()
Simplified preset configuration, which automatically sets configuration
values based on the desired query speed-precision trade-off and modality.
.google.cloud.aiplatform.v1beta1.Presets presets = 4;
Returns
Type Description
boolean Whether the presets field is set.
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public Examples . Builder newBuilderForType ()
protected Examples . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public Examples . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
