Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig (v0.47.0)

Version 0.47.0

• 0.55.0 (latest)
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig.

Configuration for vector indexing.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#brute_force_config

def brute_force_config() -> ::Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig::BruteForceConfig

Returns

• (::Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig::BruteForceConfig) — 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.

#brute_force_config=

def brute_force_config=(value) -> ::Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig::BruteForceConfig

Parameter

• value (::Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig::BruteForceConfig) — 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.

Returns

• (::Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig::BruteForceConfig) — 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.

#crowding_column

def crowding_column() -> ::String

Returns

• (::String) — 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.

#crowding_column=

def crowding_column=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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.

#distance_measure_type

def distance_measure_type() -> ::Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig::DistanceMeasureType

Returns

• (::Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig::DistanceMeasureType) — Optional. The distance measure used in nearest neighbor search.

#distance_measure_type=

def distance_measure_type=(value) -> ::Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig::DistanceMeasureType

Parameter

• value (::Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig::DistanceMeasureType) — Optional. The distance measure used in nearest neighbor search.

Returns

• (::Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig::DistanceMeasureType) — Optional. The distance measure used in nearest neighbor search.

#embedding_column

def embedding_column() -> ::String

Returns

• (::String) — 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.

#embedding_column=

def embedding_column=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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.

#embedding_dimension

def embedding_dimension() -> ::Integer

Returns

• (::Integer) — Optional. The number of dimensions of the input embedding.

#embedding_dimension=

def embedding_dimension=(value) -> ::Integer

Parameter

• value (::Integer) — Optional. The number of dimensions of the input embedding.

Returns

• (::Integer) — Optional. The number of dimensions of the input embedding.

#filter_columns

def filter_columns() -> ::Array<::String>

Returns

• (::Array<::String>) — Optional. Columns of features that're used to filter vector search results.

#filter_columns=

def filter_columns=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — Optional. Columns of features that're used to filter vector search results.

Returns

• (::Array<::String>) — Optional. Columns of features that're used to filter vector search results.

#tree_ah_config

def tree_ah_config() -> ::Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig::TreeAHConfig

Returns

• (::Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig::TreeAHConfig) —

  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

#tree_ah_config=

def tree_ah_config=(value) -> ::Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig::TreeAHConfig

Parameter

• value (::Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig::TreeAHConfig) —

  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

Returns

• (::Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig::TreeAHConfig) —

  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