Class FeatureView.IndexConfig (3.43.0)

public static final class FeatureView.IndexConfig extends GeneratedMessageV3 implements FeatureView.IndexConfigOrBuilder

Configuration for vector indexing.

Protobuf type google.cloud.aiplatform.v1.FeatureView.IndexConfig

Static Fields

BRUTE_FORCE_CONFIG_FIELD_NUMBER

public static final int BRUTE_FORCE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

CROWDING_COLUMN_FIELD_NUMBER

public static final int CROWDING_COLUMN_FIELD_NUMBER
Field Value
Type Description
int

DISTANCE_MEASURE_TYPE_FIELD_NUMBER

public static final int DISTANCE_MEASURE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

EMBEDDING_COLUMN_FIELD_NUMBER

public static final int EMBEDDING_COLUMN_FIELD_NUMBER
Field Value
Type Description
int

EMBEDDING_DIMENSION_FIELD_NUMBER

public static final int EMBEDDING_DIMENSION_FIELD_NUMBER
Field Value
Type Description
int

FILTER_COLUMNS_FIELD_NUMBER

public static final int FILTER_COLUMNS_FIELD_NUMBER
Field Value
Type Description
int

TREE_AH_CONFIG_FIELD_NUMBER

public static final int TREE_AH_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FeatureView.IndexConfig getDefaultInstance()
Returns
Type Description
FeatureView.IndexConfig

getDescriptor()

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

newBuilder()

public static FeatureView.IndexConfig.Builder newBuilder()
Returns
Type Description
FeatureView.IndexConfig.Builder

newBuilder(FeatureView.IndexConfig prototype)

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

parseDelimitedFrom(InputStream input)

public static FeatureView.IndexConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FeatureView.IndexConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static FeatureView.IndexConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FeatureView.IndexConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static FeatureView.IndexConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FeatureView.IndexConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static FeatureView.IndexConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FeatureView.IndexConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static FeatureView.IndexConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FeatureView.IndexConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<FeatureView.IndexConfig> parser()
Returns
Type Description
Parser<IndexConfig>

Methods

equals(Object obj)

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

getAlgorithmConfigCase()

public FeatureView.IndexConfig.AlgorithmConfigCase getAlgorithmConfigCase()
Returns
Type Description
FeatureView.IndexConfig.AlgorithmConfigCase

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];

Returns
Type Description
FeatureView.IndexConfig.BruteForceConfig

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];

Returns
Type Description
FeatureView.IndexConfig.BruteForceConfigOrBuilder

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 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.

getCrowdingColumnBytes()

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.

getDefaultInstanceForType()

public FeatureView.IndexConfig getDefaultInstanceForType()
Returns
Type Description
FeatureView.IndexConfig

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];

Returns
Type Description
FeatureView.IndexConfig.DistanceMeasureType

The distanceMeasureType.

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];

Returns
Type Description
int

The enum numeric value on the wire for distanceMeasureType.

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];

Returns
Type Description
String

The embeddingColumn.

getEmbeddingColumnBytes()

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.

getEmbeddingDimension()

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.

getFilterColumns(int index)

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.

getFilterColumnsBytes(int 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.

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];

Returns
Type Description
int

The count of filterColumns.

getFilterColumnsList()

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];

Returns
Type Description
ProtocolStringList

A list containing the filterColumns.

getParserForType()

public Parser<FeatureView.IndexConfig> getParserForType()
Returns
Type Description
Parser<IndexConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTreeAhConfig()

public FeatureView.IndexConfig.TreeAHConfig getTreeAhConfig()

Optional. Configuration options for the tree-AH algorithm (Shallow tree

.google.cloud.aiplatform.v1.FeatureView.IndexConfig.TreeAHConfig tree_ah_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FeatureView.IndexConfig.TreeAHConfig

The treeAhConfig.

getTreeAhConfigOrBuilder()

public FeatureView.IndexConfig.TreeAHConfigOrBuilder getTreeAhConfigOrBuilder()

Optional. Configuration options for the tree-AH algorithm (Shallow tree

.google.cloud.aiplatform.v1.FeatureView.IndexConfig.TreeAHConfig tree_ah_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FeatureView.IndexConfig.TreeAHConfigOrBuilder

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];

Returns
Type Description
boolean

Whether the bruteForceConfig field is set.

hasEmbeddingDimension()

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.

hasTreeAhConfig()

public boolean hasTreeAhConfig()

Optional. Configuration options for the tree-AH algorithm (Shallow tree

.google.cloud.aiplatform.v1.FeatureView.IndexConfig.TreeAHConfig tree_ah_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the treeAhConfig 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 FeatureView.IndexConfig.Builder newBuilderForType()
Returns
Type Description
FeatureView.IndexConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public FeatureView.IndexConfig.Builder toBuilder()
Returns
Type Description
FeatureView.IndexConfig.Builder

writeTo(CodedOutputStream output)

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