Class Examples (1.13.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.vertexai.v1.Examples

Inheritance

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

Implements

ExamplesOrBuilder

Static Fields

EXAMPLE_GCS_SOURCE_FIELD_NUMBER

public static final int EXAMPLE_GCS_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

NEAREST_NEIGHBOR_SEARCH_CONFIG_FIELD_NUMBER

public static final int NEAREST_NEIGHBOR_SEARCH_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

NEIGHBOR_COUNT_FIELD_NUMBER

public static final int NEIGHBOR_COUNT_FIELD_NUMBER
Field Value
Type Description
int

PRESETS_FIELD_NUMBER

public static final int PRESETS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Examples getDefaultInstance()
Returns
Type Description
Examples

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Examples.Builder newBuilder()
Returns
Type Description
Examples.Builder

newBuilder(Examples prototype)

public static Examples.Builder newBuilder(Examples prototype)
Parameter
Name Description
prototype Examples
Returns
Type Description
Examples.Builder

parseDelimitedFrom(InputStream input)

public static Examples parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Examples
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Examples parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Examples
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Examples parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Examples
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Examples parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Examples
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Examples parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Examples
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Examples parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Examples
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Examples parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Examples
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Examples parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Examples
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Examples parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Examples
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Examples parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Examples
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Examples parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Examples
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Examples parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Examples
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Examples> parser()
Returns
Type Description
Parser<Examples>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getConfigCase()

public Examples.ConfigCase getConfigCase()
Returns
Type Description
Examples.ConfigCase

getDefaultInstanceForType()

public Examples getDefaultInstanceForType()
Returns
Type Description
Examples

getExampleGcsSource()

public Examples.ExampleGcsSource getExampleGcsSource()

The Cloud Storage input instances.

.google.cloud.vertexai.v1.Examples.ExampleGcsSource example_gcs_source = 5;

Returns
Type Description
Examples.ExampleGcsSource

The exampleGcsSource.

getExampleGcsSourceOrBuilder()

public Examples.ExampleGcsSourceOrBuilder getExampleGcsSourceOrBuilder()

The Cloud Storage input instances.

.google.cloud.vertexai.v1.Examples.ExampleGcsSource example_gcs_source = 5;

Returns
Type Description
Examples.ExampleGcsSourceOrBuilder

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
Type Description
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
Type Description
ValueOrBuilder

getNeighborCount()

public int getNeighborCount()

The number of neighbors to return when querying for examples.

int32 neighbor_count = 3;

Returns
Type Description
int

The neighborCount.

getParserForType()

public Parser<Examples> getParserForType()
Returns
Type Description
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.vertexai.v1.Presets presets = 4;

Returns
Type Description
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.vertexai.v1.Presets presets = 4;

Returns
Type Description
PresetsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceCase()

public Examples.SourceCase getSourceCase()
Returns
Type Description
Examples.SourceCase

hasExampleGcsSource()

public boolean hasExampleGcsSource()

The Cloud Storage input instances.

.google.cloud.vertexai.v1.Examples.ExampleGcsSource example_gcs_source = 5;

Returns
Type Description
boolean

Whether the exampleGcsSource 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
Type Description
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.vertexai.v1.Presets presets = 4;

Returns
Type Description
boolean

Whether the presets field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Examples.Builder newBuilderForType()
Returns
Type Description
Examples.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Examples.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Examples.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Examples.Builder toBuilder()
Returns
Type Description
Examples.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException