Package com.google.cloud.aiplatform.v1

Class IndexDatapoint

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.IndexDatapoint
All Implemented Interfaces:
IndexDatapointOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class IndexDatapoint extends com.google.protobuf.GeneratedMessage implements IndexDatapointOrBuilder
 A datapoint of Index.
Protobuf type google.cloud.aiplatform.v1.IndexDatapoint
See Also:

  • Field Details

    • DATAPOINT_ID_FIELD_NUMBER

      public static final int DATAPOINT_ID_FIELD_NUMBER
      See Also:

    • FEATURE_VECTOR_FIELD_NUMBER

      public static final int FEATURE_VECTOR_FIELD_NUMBER
      See Also:

    • SPARSE_EMBEDDING_FIELD_NUMBER

      public static final int SPARSE_EMBEDDING_FIELD_NUMBER
      See Also:

    • RESTRICTS_FIELD_NUMBER

      public static final int RESTRICTS_FIELD_NUMBER
      See Also:

    • NUMERIC_RESTRICTS_FIELD_NUMBER

      public static final int NUMERIC_RESTRICTS_FIELD_NUMBER
      See Also:

    • CROWDING_TAG_FIELD_NUMBER

      public static final int CROWDING_TAG_FIELD_NUMBER
      See Also:

    • EMBEDDING_METADATA_FIELD_NUMBER

      public static final int EMBEDDING_METADATA_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getDatapointId

      public String getDatapointId()
       Required. Unique identifier of the datapoint.
      string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDatapointId in interface IndexDatapointOrBuilder
      Returns:
      The datapointId.

    • getDatapointIdBytes

      public com.google.protobuf.ByteString getDatapointIdBytes()
       Required. Unique identifier of the datapoint.
      string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDatapointIdBytes in interface IndexDatapointOrBuilder
      Returns:
      The bytes for datapointId.

    • 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];
      Specified by:
      getFeatureVectorList in interface IndexDatapointOrBuilder
      Returns:
      A list containing the featureVector.

    • 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];
      Specified by:
      getFeatureVectorCount in interface IndexDatapointOrBuilder
      Returns:
      The count of featureVector.

    • getFeatureVector

      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];
      Specified by:
      getFeatureVector in interface IndexDatapointOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The featureVector at the given index.

    • 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];
      Specified by:
      hasSparseEmbedding in interface IndexDatapointOrBuilder
      Returns:
      Whether the sparseEmbedding field is set.

    • 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];
      Specified by:
      getSparseEmbedding in interface IndexDatapointOrBuilder
      Returns:
      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];
      Specified by:
      getSparseEmbeddingOrBuilder in interface IndexDatapointOrBuilder

    • 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];
      Specified by:
      getRestrictsList in interface IndexDatapointOrBuilder

    • 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];
      Specified by:
      getRestrictsOrBuilderList in interface IndexDatapointOrBuilder

    • 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];
      Specified by:
      getRestrictsCount in interface IndexDatapointOrBuilder

    • getRestricts

      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];
      Specified by:
      getRestricts in interface IndexDatapointOrBuilder

    • getRestrictsOrBuilder

      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];
      Specified by:
      getRestrictsOrBuilder in interface IndexDatapointOrBuilder

    • 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];
      Specified by:
      getNumericRestrictsList in interface IndexDatapointOrBuilder

    • 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];
      Specified by:
      getNumericRestrictsOrBuilderList in interface IndexDatapointOrBuilder

    • 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];
      Specified by:
      getNumericRestrictsCount in interface IndexDatapointOrBuilder

    • getNumericRestricts

      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];
      Specified by:
      getNumericRestricts in interface IndexDatapointOrBuilder

    • getNumericRestrictsOrBuilder

      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];
      Specified by:
      getNumericRestrictsOrBuilder in interface IndexDatapointOrBuilder

    • 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];
      Specified by:
      hasCrowdingTag in interface IndexDatapointOrBuilder
      Returns:
      Whether the crowdingTag field is set.

    • 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];
      Specified by:
      getCrowdingTag in interface IndexDatapointOrBuilder
      Returns:
      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];
      Specified by:
      getCrowdingTagOrBuilder in interface IndexDatapointOrBuilder

    • hasEmbeddingMetadata

      public boolean hasEmbeddingMetadata()
       Optional. The key-value map of additional metadata for the datapoint.
      .google.protobuf.Struct embedding_metadata = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasEmbeddingMetadata in interface IndexDatapointOrBuilder
      Returns:
      Whether the embeddingMetadata field is set.

    • getEmbeddingMetadata

      public com.google.protobuf.Struct getEmbeddingMetadata()
       Optional. The key-value map of additional metadata for the datapoint.
      .google.protobuf.Struct embedding_metadata = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEmbeddingMetadata in interface IndexDatapointOrBuilder
      Returns:
      The embeddingMetadata.

    • getEmbeddingMetadataOrBuilder

      public com.google.protobuf.StructOrBuilder getEmbeddingMetadataOrBuilder()
       Optional. The key-value map of additional metadata for the datapoint.
      .google.protobuf.Struct embedding_metadata = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEmbeddingMetadataOrBuilder in interface IndexDatapointOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static IndexDatapoint parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static IndexDatapoint parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static IndexDatapoint parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static IndexDatapoint parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static IndexDatapoint parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static IndexDatapoint parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static IndexDatapoint parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static IndexDatapoint parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static IndexDatapoint parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static IndexDatapoint parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static IndexDatapoint parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static IndexDatapoint parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public IndexDatapoint.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static IndexDatapoint.Builder newBuilder()

    • newBuilder

      public static IndexDatapoint.Builder newBuilder(IndexDatapoint prototype)

    • toBuilder

      public IndexDatapoint.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected IndexDatapoint.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static IndexDatapoint getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<IndexDatapoint> parser()

    • getParserForType

      public com.google.protobuf.Parser<IndexDatapoint> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public IndexDatapoint getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder