public final class IndexDatapoint extends com.google.protobuf.GeneratedMessageV3 implements IndexDatapointOrBuilder
A datapoint of Index.Protobuf type
google.cloud.aiplatform.v1.IndexDatapoint| Modifier and Type | Class and Description |
|---|---|
static class |
IndexDatapoint.Builder
A datapoint of Index.
|
static class |
IndexDatapoint.CrowdingTag
Crowding tag is a constraint on a neighbor list produced by nearest
neighbor search requiring that no more than some value k' of the k
neighbors returned have the same value of crowding_attribute.
|
static interface |
IndexDatapoint.CrowdingTagOrBuilder |
static class |
IndexDatapoint.NumericRestriction
This field allows restricts to be based on numeric comparisons rather
than categorical tokens.
|
static interface |
IndexDatapoint.NumericRestrictionOrBuilder |
static class |
IndexDatapoint.Restriction
Restriction of a datapoint which describe its attributes(tokens) from each
of several attribute categories(namespaces).
|
static interface |
IndexDatapoint.RestrictionOrBuilder |
static class |
IndexDatapoint.SparseEmbedding
Feature embedding vector for sparse index.
|
static interface |
IndexDatapoint.SparseEmbeddingOrBuilder |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
CROWDING_TAG_FIELD_NUMBER |
static int |
DATAPOINT_ID_FIELD_NUMBER |
static int |
FEATURE_VECTOR_FIELD_NUMBER |
static int |
NUMERIC_RESTRICTS_FIELD_NUMBER |
static int |
RESTRICTS_FIELD_NUMBER |
static int |
SPARSE_EMBEDDING_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
IndexDatapoint.CrowdingTag |
getCrowdingTag()
Optional.
|
IndexDatapoint.CrowdingTagOrBuilder |
getCrowdingTagOrBuilder()
Optional.
|
String |
getDatapointId()
Required.
|
com.google.protobuf.ByteString |
getDatapointIdBytes()
Required.
|
static IndexDatapoint |
getDefaultInstance() |
IndexDatapoint |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
float |
getFeatureVector(int index)
Required.
|
int |
getFeatureVectorCount()
Required.
|
List<Float> |
getFeatureVectorList()
Required.
|
IndexDatapoint.NumericRestriction |
getNumericRestricts(int index)
Optional.
|
int |
getNumericRestrictsCount()
Optional.
|
List<IndexDatapoint.NumericRestriction> |
getNumericRestrictsList()
Optional.
|
IndexDatapoint.NumericRestrictionOrBuilder |
getNumericRestrictsOrBuilder(int index)
Optional.
|
List<? extends IndexDatapoint.NumericRestrictionOrBuilder> |
getNumericRestrictsOrBuilderList()
Optional.
|
com.google.protobuf.Parser<IndexDatapoint> |
getParserForType() |
IndexDatapoint.Restriction |
getRestricts(int index)
Optional.
|
int |
getRestrictsCount()
Optional.
|
List<IndexDatapoint.Restriction> |
getRestrictsList()
Optional.
|
IndexDatapoint.RestrictionOrBuilder |
getRestrictsOrBuilder(int index)
Optional.
|
List<? extends IndexDatapoint.RestrictionOrBuilder> |
getRestrictsOrBuilderList()
Optional.
|
int |
getSerializedSize() |
IndexDatapoint.SparseEmbedding |
getSparseEmbedding()
Optional.
|
IndexDatapoint.SparseEmbeddingOrBuilder |
getSparseEmbeddingOrBuilder()
Optional.
|
boolean |
hasCrowdingTag()
Optional.
|
int |
hashCode() |
boolean |
hasSparseEmbedding()
Optional.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static IndexDatapoint.Builder |
newBuilder() |
static IndexDatapoint.Builder |
newBuilder(IndexDatapoint prototype) |
IndexDatapoint.Builder |
newBuilderForType() |
protected IndexDatapoint.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static IndexDatapoint |
parseDelimitedFrom(InputStream input) |
static IndexDatapoint |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static IndexDatapoint |
parseFrom(byte[] data) |
static IndexDatapoint |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static IndexDatapoint |
parseFrom(ByteBuffer data) |
static IndexDatapoint |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static IndexDatapoint |
parseFrom(com.google.protobuf.ByteString data) |
static IndexDatapoint |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static IndexDatapoint |
parseFrom(com.google.protobuf.CodedInputStream input) |
static IndexDatapoint |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static IndexDatapoint |
parseFrom(InputStream input) |
static IndexDatapoint |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<IndexDatapoint> |
parser() |
IndexDatapoint.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int DATAPOINT_ID_FIELD_NUMBER
public static final int FEATURE_VECTOR_FIELD_NUMBER
public static final int SPARSE_EMBEDDING_FIELD_NUMBER
public static final int RESTRICTS_FIELD_NUMBER
public static final int NUMERIC_RESTRICTS_FIELD_NUMBER
public static final int CROWDING_TAG_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getDatapointId()
Required. Unique identifier of the datapoint.
string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];getDatapointId in interface IndexDatapointOrBuilderpublic com.google.protobuf.ByteString getDatapointIdBytes()
Required. Unique identifier of the datapoint.
string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];getDatapointIdBytes in interface IndexDatapointOrBuilderpublic 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];getFeatureVectorList in interface IndexDatapointOrBuilderpublic 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];getFeatureVectorCount in interface IndexDatapointOrBuilderpublic 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];getFeatureVector in interface IndexDatapointOrBuilderindex - The index of the element to return.public boolean hasSparseEmbedding()
Optional. Feature embedding vector for sparse index.
.google.cloud.aiplatform.v1.IndexDatapoint.SparseEmbedding sparse_embedding = 7 [(.google.api.field_behavior) = OPTIONAL];
hasSparseEmbedding in interface IndexDatapointOrBuilderpublic IndexDatapoint.SparseEmbedding getSparseEmbedding()
Optional. Feature embedding vector for sparse index.
.google.cloud.aiplatform.v1.IndexDatapoint.SparseEmbedding sparse_embedding = 7 [(.google.api.field_behavior) = OPTIONAL];
getSparseEmbedding in interface IndexDatapointOrBuilderpublic IndexDatapoint.SparseEmbeddingOrBuilder getSparseEmbeddingOrBuilder()
Optional. Feature embedding vector for sparse index.
.google.cloud.aiplatform.v1.IndexDatapoint.SparseEmbedding sparse_embedding = 7 [(.google.api.field_behavior) = OPTIONAL];
getSparseEmbeddingOrBuilder in interface IndexDatapointOrBuilderpublic 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];
getRestrictsList in interface IndexDatapointOrBuilderpublic 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];
getRestrictsOrBuilderList in interface IndexDatapointOrBuilderpublic 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];
getRestrictsCount in interface IndexDatapointOrBuilderpublic 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];
getRestricts in interface IndexDatapointOrBuilderpublic 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];
getRestrictsOrBuilder in interface IndexDatapointOrBuilderpublic 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];
getNumericRestrictsList in interface IndexDatapointOrBuilderpublic 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];
getNumericRestrictsOrBuilderList in interface IndexDatapointOrBuilderpublic 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];
getNumericRestrictsCount in interface IndexDatapointOrBuilderpublic 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];
getNumericRestricts in interface IndexDatapointOrBuilderpublic 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];
getNumericRestrictsOrBuilder in interface IndexDatapointOrBuilderpublic 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];
hasCrowdingTag in interface IndexDatapointOrBuilderpublic 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];
getCrowdingTag in interface IndexDatapointOrBuilderpublic 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];
getCrowdingTagOrBuilder in interface IndexDatapointOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static IndexDatapoint parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static IndexDatapoint parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static IndexDatapoint parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static IndexDatapoint parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static IndexDatapoint parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static IndexDatapoint parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static IndexDatapoint parseFrom(InputStream input) throws IOException
IOExceptionpublic static IndexDatapoint parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static IndexDatapoint parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static IndexDatapoint parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static IndexDatapoint parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static IndexDatapoint parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic IndexDatapoint.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static IndexDatapoint.Builder newBuilder()
public static IndexDatapoint.Builder newBuilder(IndexDatapoint prototype)
public IndexDatapoint.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected IndexDatapoint.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static IndexDatapoint getDefaultInstance()
public static com.google.protobuf.Parser<IndexDatapoint> parser()
public com.google.protobuf.Parser<IndexDatapoint> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public IndexDatapoint getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.