Interface FeatureView.VectorSearchConfigOrBuilder (3.41.0)

public static interface FeatureView.VectorSearchConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAlgorithmConfigCase() (deprecated)

public abstract FeatureView.VectorSearchConfig.AlgorithmConfigCase getAlgorithmConfigCase()

Returns
Type	Description
`FeatureView.VectorSearchConfig.AlgorithmConfigCase`

getBruteForceConfig() (deprecated)

public abstract FeatureView.VectorSearchConfig.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.VectorSearchConfig.BruteForceConfig brute_force_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FeatureView.VectorSearchConfig.BruteForceConfig`	The bruteForceConfig.

getBruteForceConfigOrBuilder() (deprecated)

public abstract FeatureView.VectorSearchConfig.BruteForceConfigOrBuilder getBruteForceConfigOrBuilder()

.google.cloud.aiplatform.v1beta1.FeatureView.VectorSearchConfig.BruteForceConfig brute_force_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FeatureView.VectorSearchConfig.BruteForceConfigOrBuilder`

getCrowdingColumn() (deprecated)

public abstract String getCrowdingColumn()

Optional. Column of crowding. This column contains crowding attribute which 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.

string crowding_column = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The crowdingColumn.

getCrowdingColumnBytes() (deprecated)

public abstract ByteString getCrowdingColumnBytes()

string crowding_column = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for crowdingColumn.

getDistanceMeasureType() (deprecated)

public abstract FeatureView.VectorSearchConfig.DistanceMeasureType getDistanceMeasureType()

Optional. The distance measure used in nearest neighbor search.

.google.cloud.aiplatform.v1beta1.FeatureView.VectorSearchConfig.DistanceMeasureType distance_measure_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FeatureView.VectorSearchConfig.DistanceMeasureType`	The distanceMeasureType.

getDistanceMeasureTypeValue() (deprecated)

public abstract int getDistanceMeasureTypeValue()

Optional. The distance measure used in nearest neighbor search.

.google.cloud.aiplatform.v1beta1.FeatureView.VectorSearchConfig.DistanceMeasureType distance_measure_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The enum numeric value on the wire for distanceMeasureType.

getEmbeddingColumn() (deprecated)

public abstract 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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The embeddingColumn.

getEmbeddingColumnBytes() (deprecated)

public abstract 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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for embeddingColumn.

getEmbeddingDimension() (deprecated)

public abstract int getEmbeddingDimension()

Optional. The number of dimensions of the input embedding.

optional int32 embedding_dimension = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The embeddingDimension.

getFilterColumns(int index) (deprecated)

public abstract String getFilterColumns(int index)

Optional. Columns of features that're used to filter vector search results.

repeated string filter_columns = 4 [(.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) (deprecated)

public abstract ByteString getFilterColumnsBytes(int index)

Optional. Columns of features that're used to filter vector search results.

repeated string filter_columns = 4 [(.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() (deprecated)

public abstract int getFilterColumnsCount()

Optional. Columns of features that're used to filter vector search results.

repeated string filter_columns = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The count of filterColumns.

getFilterColumnsList() (deprecated)

public abstract List<String> getFilterColumnsList()

Optional. Columns of features that're used to filter vector search results.

repeated string filter_columns = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<String>`	A list containing the filterColumns.

getTreeAhConfig() (deprecated)

public abstract FeatureView.VectorSearchConfig.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.v1beta1.FeatureView.VectorSearchConfig.TreeAHConfig tree_ah_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FeatureView.VectorSearchConfig.TreeAHConfig`	The treeAhConfig.

getTreeAhConfigOrBuilder() (deprecated)

public abstract FeatureView.VectorSearchConfig.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.v1beta1.FeatureView.VectorSearchConfig.TreeAHConfig tree_ah_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FeatureView.VectorSearchConfig.TreeAHConfigOrBuilder`

hasBruteForceConfig() (deprecated)

public abstract boolean hasBruteForceConfig()

.google.cloud.aiplatform.v1beta1.FeatureView.VectorSearchConfig.BruteForceConfig brute_force_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the bruteForceConfig field is set.

hasEmbeddingDimension() (deprecated)

public abstract boolean hasEmbeddingDimension()

Optional. The number of dimensions of the input embedding.

optional int32 embedding_dimension = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the embeddingDimension field is set.

hasTreeAhConfig() (deprecated)

public abstract 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.v1beta1.FeatureView.VectorSearchConfig.TreeAHConfig tree_ah_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the treeAhConfig field is set.