Class IndexDatapoint (3.49.0)

public final class IndexDatapoint extends GeneratedMessageV3 implements IndexDatapointOrBuilder

A datapoint of Index.

Protobuf type google.cloud.aiplatform.v1.IndexDatapoint

Static Fields

CROWDING_TAG_FIELD_NUMBER

public static final int CROWDING_TAG_FIELD_NUMBER
Field Value
Type Description
int

DATAPOINT_ID_FIELD_NUMBER

public static final int DATAPOINT_ID_FIELD_NUMBER
Field Value
Type Description
int

FEATURE_VECTOR_FIELD_NUMBER

public static final int FEATURE_VECTOR_FIELD_NUMBER
Field Value
Type Description
int

NUMERIC_RESTRICTS_FIELD_NUMBER

public static final int NUMERIC_RESTRICTS_FIELD_NUMBER
Field Value
Type Description
int

RESTRICTS_FIELD_NUMBER

public static final int RESTRICTS_FIELD_NUMBER
Field Value
Type Description
int

SPARSE_EMBEDDING_FIELD_NUMBER

public static final int SPARSE_EMBEDDING_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static IndexDatapoint getDefaultInstance()
Returns
Type Description
IndexDatapoint

getDescriptor()

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

newBuilder()

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

newBuilder(IndexDatapoint prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCrowdingTag()

public IndexDatapoint.CrowdingTag getCrowdingTag()

Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query.

.google.cloud.aiplatform.v1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
IndexDatapoint.CrowdingTag

The crowdingTag.

getCrowdingTagOrBuilder()

public IndexDatapoint.CrowdingTagOrBuilder getCrowdingTagOrBuilder()

Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query.

.google.cloud.aiplatform.v1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
IndexDatapoint.CrowdingTagOrBuilder

getDatapointId()

public String getDatapointId()

Required. Unique identifier of the datapoint.

string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The datapointId.

getDatapointIdBytes()

public ByteString getDatapointIdBytes()

Required. Unique identifier of the datapoint.

string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for datapointId.

getDefaultInstanceForType()

public IndexDatapoint getDefaultInstanceForType()
Returns
Type Description
IndexDatapoint

getFeatureVector(int index)

public float getFeatureVector(int index)

Required. Feature embedding vector for dense index. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].

repeated float feature_vector = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
float

The featureVector at the given index.

getFeatureVectorCount()

public int getFeatureVectorCount()

Required. Feature embedding vector for dense index. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].

repeated float feature_vector = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of featureVector.

getFeatureVectorList()

public List<Float> getFeatureVectorList()

Required. Feature embedding vector for dense index. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].

repeated float feature_vector = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Float>

A list containing the featureVector.

getNumericRestricts(int index)

public IndexDatapoint.NumericRestriction getNumericRestricts(int index)

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses numeric comparisons.

repeated .google.cloud.aiplatform.v1.IndexDatapoint.NumericRestriction numeric_restricts = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
IndexDatapoint.NumericRestriction

getNumericRestrictsCount()

public int getNumericRestrictsCount()

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses numeric comparisons.

repeated .google.cloud.aiplatform.v1.IndexDatapoint.NumericRestriction numeric_restricts = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getNumericRestrictsList()

public List<IndexDatapoint.NumericRestriction> getNumericRestrictsList()

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses numeric comparisons.

repeated .google.cloud.aiplatform.v1.IndexDatapoint.NumericRestriction numeric_restricts = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<NumericRestriction>

getNumericRestrictsOrBuilder(int index)

public IndexDatapoint.NumericRestrictionOrBuilder getNumericRestrictsOrBuilder(int index)

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses numeric comparisons.

repeated .google.cloud.aiplatform.v1.IndexDatapoint.NumericRestriction numeric_restricts = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
IndexDatapoint.NumericRestrictionOrBuilder

getNumericRestrictsOrBuilderList()

public List<? extends IndexDatapoint.NumericRestrictionOrBuilder> getNumericRestrictsOrBuilderList()

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses numeric comparisons.

repeated .google.cloud.aiplatform.v1.IndexDatapoint.NumericRestriction numeric_restricts = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1.IndexDatapoint.NumericRestrictionOrBuilder>

getParserForType()

public Parser<IndexDatapoint> getParserForType()
Returns
Type Description
Parser<IndexDatapoint>
Overrides

getRestricts(int index)

public IndexDatapoint.Restriction getRestricts(int index)

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses categorical tokens. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
IndexDatapoint.Restriction

getRestrictsCount()

public int getRestrictsCount()

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses categorical tokens. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getRestrictsList()

public List<IndexDatapoint.Restriction> getRestrictsList()

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses categorical tokens. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Restriction>

getRestrictsOrBuilder(int index)

public IndexDatapoint.RestrictionOrBuilder getRestrictsOrBuilder(int index)

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses categorical tokens. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
IndexDatapoint.RestrictionOrBuilder

getRestrictsOrBuilderList()

public List<? extends IndexDatapoint.RestrictionOrBuilder> getRestrictsOrBuilderList()

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses categorical tokens. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1.IndexDatapoint.RestrictionOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSparseEmbedding()

public IndexDatapoint.SparseEmbedding getSparseEmbedding()

Optional. Feature embedding vector for sparse index.

.google.cloud.aiplatform.v1.IndexDatapoint.SparseEmbedding sparse_embedding = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
IndexDatapoint.SparseEmbedding

The sparseEmbedding.

getSparseEmbeddingOrBuilder()

public IndexDatapoint.SparseEmbeddingOrBuilder getSparseEmbeddingOrBuilder()

Optional. Feature embedding vector for sparse index.

.google.cloud.aiplatform.v1.IndexDatapoint.SparseEmbedding sparse_embedding = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
IndexDatapoint.SparseEmbeddingOrBuilder

hasCrowdingTag()

public boolean hasCrowdingTag()

Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query.

.google.cloud.aiplatform.v1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the crowdingTag field is set.

hasSparseEmbedding()

public boolean hasSparseEmbedding()

Optional. Feature embedding vector for sparse index.

.google.cloud.aiplatform.v1.IndexDatapoint.SparseEmbedding sparse_embedding = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the sparseEmbedding 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 IndexDatapoint.Builder newBuilderForType()
Returns
Type Description
IndexDatapoint.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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