Class Similarity

public final class Similarity extends GeneratedMessageV3 implements SimilarityOrBuilder

Similarity explainability that returns the nearest neighbors from the provided dataset.

Protobuf type google.cloud.aiplatform.v1beta1.Similarity

Implements

SimilarityOrBuilder

Static Fields

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

Static Methods

getDefaultInstance()

public static Similarity getDefaultInstance()
Returns
TypeDescription
Similarity

getDescriptor()

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

newBuilder()

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

newBuilder(Similarity prototype)

public static Similarity.Builder newBuilder(Similarity prototype)
Parameter
NameDescription
prototypeSimilarity
Returns
TypeDescription
Similarity.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Similarity getDefaultInstanceForType()
Returns
TypeDescription
Similarity

getGcsSource()

public GcsSource getGcsSource()

The Cloud Storage location for the input instances.

.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;

Returns
TypeDescription
GcsSource

The gcsSource.

getGcsSourceOrBuilder()

public GcsSourceOrBuilder getGcsSourceOrBuilder()

The Cloud Storage location for the input instances.

.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;

Returns
TypeDescription
GcsSourceOrBuilder

getNearestNeighborSearchConfig()

public Value getNearestNeighborSearchConfig()

The 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 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

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasGcsSource()

public boolean hasGcsSource()

The Cloud Storage location for the input instances.

.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;

Returns
TypeDescription
boolean

Whether the gcsSource field is set.

hasNearestNeighborSearchConfig()

public boolean hasNearestNeighborSearchConfig()

The 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.

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 Similarity.Builder newBuilderForType()
Returns
TypeDescription
Similarity.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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