Package com.google.cloud.aiplatform.v1

Class FeatureView.IndexConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.FeatureView.IndexConfig
All Implemented Interfaces:
FeatureView.IndexConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
FeatureView
public static final class FeatureView.IndexConfig extends com.google.protobuf.GeneratedMessage implements FeatureView.IndexConfigOrBuilder
 Configuration for vector indexing.
Protobuf type google.cloud.aiplatform.v1.FeatureView.IndexConfig
See Also:

  • Field Details

    • TREE_AH_CONFIG_FIELD_NUMBER

      public static final int TREE_AH_CONFIG_FIELD_NUMBER
      See Also:

    • BRUTE_FORCE_CONFIG_FIELD_NUMBER

      public static final int BRUTE_FORCE_CONFIG_FIELD_NUMBER
      See Also:

    • EMBEDDING_COLUMN_FIELD_NUMBER

      public static final int EMBEDDING_COLUMN_FIELD_NUMBER
      See Also:

    • FILTER_COLUMNS_FIELD_NUMBER

      public static final int FILTER_COLUMNS_FIELD_NUMBER
      See Also:

    • CROWDING_COLUMN_FIELD_NUMBER

      public static final int CROWDING_COLUMN_FIELD_NUMBER
      See Also:

    • EMBEDDING_DIMENSION_FIELD_NUMBER

      public static final int EMBEDDING_DIMENSION_FIELD_NUMBER
      See Also:

    • DISTANCE_MEASURE_TYPE_FIELD_NUMBER

      public static final int DISTANCE_MEASURE_TYPE_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

    • getAlgorithmConfigCase

      public FeatureView.IndexConfig.AlgorithmConfigCase getAlgorithmConfigCase()
      Specified by:
      getAlgorithmConfigCase in interface FeatureView.IndexConfigOrBuilder

    • hasTreeAhConfig

      public boolean hasTreeAhConfig()
       Optional. Configuration options for the tree-AH algorithm (Shallow tree
 + Asymmetric Hashing). Please refer to this paper for more details:
 https://arxiv.org/abs/1908.10396
      .google.cloud.aiplatform.v1.FeatureView.IndexConfig.TreeAHConfig tree_ah_config = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasTreeAhConfig in interface FeatureView.IndexConfigOrBuilder
      Returns:
      Whether the treeAhConfig field is set.

    • getTreeAhConfig

      public FeatureView.IndexConfig.TreeAHConfig getTreeAhConfig()
       Optional. Configuration options for the tree-AH algorithm (Shallow tree
 + Asymmetric Hashing). Please refer to this paper for more details:
 https://arxiv.org/abs/1908.10396
      .google.cloud.aiplatform.v1.FeatureView.IndexConfig.TreeAHConfig tree_ah_config = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTreeAhConfig in interface FeatureView.IndexConfigOrBuilder
      Returns:
      The treeAhConfig.

    • getTreeAhConfigOrBuilder

      public FeatureView.IndexConfig.TreeAHConfigOrBuilder getTreeAhConfigOrBuilder()
       Optional. Configuration options for the tree-AH algorithm (Shallow tree
 + Asymmetric Hashing). Please refer to this paper for more details:
 https://arxiv.org/abs/1908.10396
      .google.cloud.aiplatform.v1.FeatureView.IndexConfig.TreeAHConfig tree_ah_config = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTreeAhConfigOrBuilder in interface FeatureView.IndexConfigOrBuilder

    • hasBruteForceConfig

      public boolean hasBruteForceConfig()
       Optional. Configuration options for using brute force search, which
 simply implements the standard linear search in the database for each
 query. It is primarily meant for benchmarking and to generate the
 ground truth for approximate search.
      .google.cloud.aiplatform.v1.FeatureView.IndexConfig.BruteForceConfig brute_force_config = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasBruteForceConfig in interface FeatureView.IndexConfigOrBuilder
      Returns:
      Whether the bruteForceConfig field is set.

    • getBruteForceConfig

      public FeatureView.IndexConfig.BruteForceConfig getBruteForceConfig()
       Optional. Configuration options for using brute force search, which
 simply implements the standard linear search in the database for each
 query. It is primarily meant for benchmarking and to generate the
 ground truth for approximate search.
      .google.cloud.aiplatform.v1.FeatureView.IndexConfig.BruteForceConfig brute_force_config = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBruteForceConfig in interface FeatureView.IndexConfigOrBuilder
      Returns:
      The bruteForceConfig.

    • getBruteForceConfigOrBuilder

      public FeatureView.IndexConfig.BruteForceConfigOrBuilder getBruteForceConfigOrBuilder()
       Optional. Configuration options for using brute force search, which
 simply implements the standard linear search in the database for each
 query. It is primarily meant for benchmarking and to generate the
 ground truth for approximate search.
      .google.cloud.aiplatform.v1.FeatureView.IndexConfig.BruteForceConfig brute_force_config = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBruteForceConfigOrBuilder in interface FeatureView.IndexConfigOrBuilder

    • getEmbeddingColumn

      public String getEmbeddingColumn()
       Optional. Column of embedding. This column contains the source data to
 create index for vector search. embedding_column must be set when using
 vector search.
      string embedding_column = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEmbeddingColumn in interface FeatureView.IndexConfigOrBuilder
      Returns:
      The embeddingColumn.

    • getEmbeddingColumnBytes

      public com.google.protobuf.ByteString getEmbeddingColumnBytes()
       Optional. Column of embedding. This column contains the source data to
 create index for vector search. embedding_column must be set when using
 vector search.
      string embedding_column = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEmbeddingColumnBytes in interface FeatureView.IndexConfigOrBuilder
      Returns:
      The bytes for embeddingColumn.

    • getFilterColumnsList

      public com.google.protobuf.ProtocolStringList getFilterColumnsList()
       Optional. Columns of features that're used to filter vector search
 results.
      repeated string filter_columns = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilterColumnsList in interface FeatureView.IndexConfigOrBuilder
      Returns:
      A list containing the filterColumns.

    • getFilterColumnsCount

      public int getFilterColumnsCount()
       Optional. Columns of features that're used to filter vector search
 results.
      repeated string filter_columns = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilterColumnsCount in interface FeatureView.IndexConfigOrBuilder
      Returns:
      The count of filterColumns.

    • getFilterColumns

      public String getFilterColumns(int index)
       Optional. Columns of features that're used to filter vector search
 results.
      repeated string filter_columns = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilterColumns in interface FeatureView.IndexConfigOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The filterColumns at the given index.

    • getFilterColumnsBytes

      public com.google.protobuf.ByteString getFilterColumnsBytes(int index)
       Optional. Columns of features that're used to filter vector search
 results.
      repeated string filter_columns = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilterColumnsBytes in interface FeatureView.IndexConfigOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the filterColumns at the given index.

    • getCrowdingColumn

      public String getCrowdingColumn()
       Optional. Column of crowding. This column contains crowding attribute
 which is a constraint on a neighbor list produced by
 [FeatureOnlineStoreService.SearchNearestEntities][google.cloud.aiplatform.v1.FeatureOnlineStoreService.SearchNearestEntities]
 to diversify search results. If
 [NearestNeighborQuery.per_crowding_attribute_neighbor_count][google.cloud.aiplatform.v1.NearestNeighborQuery.per_crowding_attribute_neighbor_count]
 is set to K in
 [SearchNearestEntitiesRequest][google.cloud.aiplatform.v1.SearchNearestEntitiesRequest],
 it's guaranteed that no more than K entities of the same crowding
 attribute are returned in the response.
      string crowding_column = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCrowdingColumn in interface FeatureView.IndexConfigOrBuilder
      Returns:
      The crowdingColumn.

    • getCrowdingColumnBytes

      public com.google.protobuf.ByteString getCrowdingColumnBytes()
       Optional. Column of crowding. This column contains crowding attribute
 which is a constraint on a neighbor list produced by
 [FeatureOnlineStoreService.SearchNearestEntities][google.cloud.aiplatform.v1.FeatureOnlineStoreService.SearchNearestEntities]
 to diversify search results. If
 [NearestNeighborQuery.per_crowding_attribute_neighbor_count][google.cloud.aiplatform.v1.NearestNeighborQuery.per_crowding_attribute_neighbor_count]
 is set to K in
 [SearchNearestEntitiesRequest][google.cloud.aiplatform.v1.SearchNearestEntitiesRequest],
 it's guaranteed that no more than K entities of the same crowding
 attribute are returned in the response.
      string crowding_column = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCrowdingColumnBytes in interface FeatureView.IndexConfigOrBuilder
      Returns:
      The bytes for crowdingColumn.

    • hasEmbeddingDimension

      public boolean hasEmbeddingDimension()
       Optional. The number of dimensions of the input embedding.
      optional int32 embedding_dimension = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasEmbeddingDimension in interface FeatureView.IndexConfigOrBuilder
      Returns:
      Whether the embeddingDimension field is set.

    • getEmbeddingDimension

      public int getEmbeddingDimension()
       Optional. The number of dimensions of the input embedding.
      optional int32 embedding_dimension = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEmbeddingDimension in interface FeatureView.IndexConfigOrBuilder
      Returns:
      The embeddingDimension.

    • getDistanceMeasureTypeValue

      public int getDistanceMeasureTypeValue()
       Optional. The distance measure used in nearest neighbor search.
      .google.cloud.aiplatform.v1.FeatureView.IndexConfig.DistanceMeasureType distance_measure_type = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDistanceMeasureTypeValue in interface FeatureView.IndexConfigOrBuilder
      Returns:
      The enum numeric value on the wire for distanceMeasureType.

    • getDistanceMeasureType

      public FeatureView.IndexConfig.DistanceMeasureType getDistanceMeasureType()
       Optional. The distance measure used in nearest neighbor search.
      .google.cloud.aiplatform.v1.FeatureView.IndexConfig.DistanceMeasureType distance_measure_type = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDistanceMeasureType in interface FeatureView.IndexConfigOrBuilder
      Returns:
      The distanceMeasureType.

    • 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 FeatureView.IndexConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static FeatureView.IndexConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static FeatureView.IndexConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FeatureView.IndexConfig.Builder newBuilder()

    • newBuilder

      public static FeatureView.IndexConfig.Builder newBuilder(FeatureView.IndexConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static FeatureView.IndexConfig getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<FeatureView.IndexConfig> 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 FeatureView.IndexConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder