Class Examples (3.36.0)

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

Implements

ExamplesOrBuilder

Static Fields

EXAMPLE_GCS_SOURCE_FIELD_NUMBER

public static final int EXAMPLE_GCS_SOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

GCS_SOURCE_FIELD_NUMBER

public static final int GCS_SOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

NEAREST_NEIGHBOR_SEARCH_CONFIG_FIELD_NUMBER

public static final int NEAREST_NEIGHBOR_SEARCH_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

NEIGHBOR_COUNT_FIELD_NUMBER

public static final int NEIGHBOR_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

PRESETS_FIELD_NUMBER

public static final int PRESETS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Examples getDefaultInstance()
Returns
TypeDescription
Examples

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Examples.Builder newBuilder()
Returns
TypeDescription
Examples.Builder

newBuilder(Examples prototype)

public static Examples.Builder newBuilder(Examples prototype)
Parameter
NameDescription
prototypeExamples
Returns
TypeDescription
Examples.Builder

parseDelimitedFrom(InputStream input)

public static Examples parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Examples
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Examples parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Examples
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Examples parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Examples
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Examples parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Examples
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Examples parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Examples
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Examples parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Examples
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Examples parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Examples
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Examples parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Examples
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Examples parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Examples
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Examples parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Examples
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Examples parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Examples
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Examples parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Examples
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Examples> parser()
Returns
TypeDescription
Parser<Examples>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getConfigCase()

public Examples.ConfigCase getConfigCase()
Returns
TypeDescription
Examples.ConfigCase

getDefaultInstanceForType()

public Examples getDefaultInstanceForType()
Returns
TypeDescription
Examples

getExampleGcsSource()

public Examples.ExampleGcsSource getExampleGcsSource()

The Cloud Storage input instances.

.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;

Returns
TypeDescription
Examples.ExampleGcsSource

The exampleGcsSource.

getExampleGcsSourceOrBuilder()

public Examples.ExampleGcsSourceOrBuilder getExampleGcsSourceOrBuilder()

The Cloud Storage input instances.

.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;

Returns
TypeDescription
Examples.ExampleGcsSourceOrBuilder

getGcsSource()

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
TypeDescription
GcsSource

The gcsSource.

getGcsSourceOrBuilder()

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;

Returns
TypeDescription
GcsSourceOrBuilder

getNearestNeighborSearchConfig()

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
TypeDescription
Value

The nearestNeighborSearchConfig.

getNearestNeighborSearchConfigOrBuilder()

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;

Returns
TypeDescription
ValueOrBuilder

getNeighborCount()

public int getNeighborCount()

The number of neighbors to return when querying for examples.

int32 neighbor_count = 3;

Returns
TypeDescription
int

The neighborCount.

getParserForType()

public Parser<Examples> getParserForType()
Returns
TypeDescription
Parser<Examples>
Overrides

getPresets()

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
TypeDescription
Presets

The presets.

getPresetsOrBuilder()

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;

Returns
TypeDescription
PresetsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSourceCase()

public Examples.SourceCase getSourceCase()
Returns
TypeDescription
Examples.SourceCase

hasExampleGcsSource()

public boolean hasExampleGcsSource()

The Cloud Storage input instances.

.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;

Returns
TypeDescription
boolean

Whether the exampleGcsSource field is set.

hasGcsSource()

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
TypeDescription
boolean

Whether the gcsSource field is set.

hasNearestNeighborSearchConfig()

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
TypeDescription
boolean

Whether the nearestNeighborSearchConfig field is set.

hasPresets()

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
TypeDescription
boolean

Whether the presets field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Examples.Builder newBuilderForType()
Returns
TypeDescription
Examples.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Examples.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Examples.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Examples.Builder toBuilder()
Returns
TypeDescription
Examples.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException