public static final class FeatureView.IndexConfig extends GeneratedMessageV3 implements FeatureView.IndexConfigOrBuilder
Configuration for vector indexing.
Protobuf type google.cloud.aiplatform.v1beta1.FeatureView.IndexConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int BRUTE_FORCE_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int CROWDING_COLUMN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DISTANCE_MEASURE_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int EMBEDDING_COLUMN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int EMBEDDING_DIMENSION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int FILTER_COLUMNS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TREE_AH_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static FeatureView.IndexConfig getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static FeatureView.IndexConfig.Builder newBuilder()
public static FeatureView.IndexConfig.Builder newBuilder(FeatureView.IndexConfig prototype)
public static FeatureView.IndexConfig parseDelimitedFrom(InputStream input)
public static FeatureView.IndexConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static FeatureView.IndexConfig parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static FeatureView.IndexConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static FeatureView.IndexConfig parseFrom(ByteString data)
public static FeatureView.IndexConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FeatureView.IndexConfig parseFrom(CodedInputStream input)
public static FeatureView.IndexConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static FeatureView.IndexConfig parseFrom(InputStream input)
public static FeatureView.IndexConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static FeatureView.IndexConfig parseFrom(ByteBuffer data)
public static FeatureView.IndexConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<FeatureView.IndexConfig> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public FeatureView.IndexConfig.AlgorithmConfigCase getAlgorithmConfigCase()
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.v1beta1.FeatureView.IndexConfig.BruteForceConfig brute_force_config = 7 [(.google.api.field_behavior) = OPTIONAL];
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.v1beta1.FeatureView.IndexConfig.BruteForceConfig brute_force_config = 7 [(.google.api.field_behavior) = OPTIONAL];
public String getCrowdingColumn()
Optional. Column of crowding. This column contains crowding attribute
which is a constraint on a neighbor list produced by
FeatureOnlineStoreService.SearchNearestEntities
to diversify search results. If
NearestNeighborQuery.per_crowding_attribute_neighbor_count
is set to K in
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];
| Returns |
| Type |
Description |
String |
The crowdingColumn.
|
public ByteString getCrowdingColumnBytes()
Optional. Column of crowding. This column contains crowding attribute
which is a constraint on a neighbor list produced by
FeatureOnlineStoreService.SearchNearestEntities
to diversify search results. If
NearestNeighborQuery.per_crowding_attribute_neighbor_count
is set to K in
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];
| Returns |
| Type |
Description |
ByteString |
The bytes for crowdingColumn.
|
public FeatureView.IndexConfig getDefaultInstanceForType()
public FeatureView.IndexConfig.DistanceMeasureType getDistanceMeasureType()
Optional. The distance measure used in nearest neighbor search.
.google.cloud.aiplatform.v1beta1.FeatureView.IndexConfig.DistanceMeasureType distance_measure_type = 5 [(.google.api.field_behavior) = OPTIONAL];
public int getDistanceMeasureTypeValue()
Optional. The distance measure used in nearest neighbor search.
.google.cloud.aiplatform.v1beta1.FeatureView.IndexConfig.DistanceMeasureType distance_measure_type = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for distanceMeasureType.
|
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];
| Returns |
| Type |
Description |
String |
The embeddingColumn.
|
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for embeddingColumn.
|
public int getEmbeddingDimension()
Optional. The number of dimensions of the input embedding.
optional int32 embedding_dimension = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The embeddingDimension.
|
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];
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The filterColumns at the given index.
|
public 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];
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the filterColumns at the given index.
|
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];
| Returns |
| Type |
Description |
int |
The count of filterColumns.
|
public ProtocolStringList getFilterColumnsList()
Optional. Columns of features that're used to filter vector search
results.
repeated string filter_columns = 2 [(.google.api.field_behavior) = OPTIONAL];
public Parser<FeatureView.IndexConfig> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public FeatureView.IndexConfig.TreeAHConfig getTreeAhConfig()
Optional. Configuration options for the tree-AH algorithm (Shallow tree
.google.cloud.aiplatform.v1beta1.FeatureView.IndexConfig.TreeAHConfig tree_ah_config = 6 [(.google.api.field_behavior) = OPTIONAL];
public FeatureView.IndexConfig.TreeAHConfigOrBuilder getTreeAhConfigOrBuilder()
Optional. Configuration options for the tree-AH algorithm (Shallow tree
.google.cloud.aiplatform.v1beta1.FeatureView.IndexConfig.TreeAHConfig tree_ah_config = 6 [(.google.api.field_behavior) = OPTIONAL];
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.v1beta1.FeatureView.IndexConfig.BruteForceConfig brute_force_config = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the bruteForceConfig field is set.
|
public boolean hasEmbeddingDimension()
Optional. The number of dimensions of the input embedding.
optional int32 embedding_dimension = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the embeddingDimension field is set.
|
public boolean hasTreeAhConfig()
Optional. Configuration options for the tree-AH algorithm (Shallow tree
.google.cloud.aiplatform.v1beta1.FeatureView.IndexConfig.TreeAHConfig tree_ah_config = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the treeAhConfig field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public FeatureView.IndexConfig.Builder newBuilderForType()
protected FeatureView.IndexConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public FeatureView.IndexConfig.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
