- 1.63.0 (latest)
- 1.62.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.1
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.39.0
- 1.38.1
- 1.37.0
- 1.36.4
- 1.35.0
- 1.34.0
- 1.33.1
- 1.32.0
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.1
- 1.27.1
- 1.26.1
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.1
- 1.21.0
- 1.20.0
- 1.19.1
- 1.18.3
- 1.17.1
- 1.16.1
- 1.15.1
- 1.14.0
- 1.13.1
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.1
- 1.7.1
- 1.6.2
- 1.5.0
- 1.4.3
- 1.3.0
- 1.2.0
- 1.1.1
- 1.0.1
- 0.9.0
- 0.8.0
- 0.7.1
- 0.6.0
- 0.5.1
- 0.4.0
- 0.3.1
VectorSearchConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for vector search.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes |
|
---|---|
Name | Description |
tree_ah_config |
google.cloud.aiplatform_v1beta1.types.FeatureView.VectorSearchConfig.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 This field is a member of oneof _ algorithm_config .
|
brute_force_config |
google.cloud.aiplatform_v1beta1.types.FeatureView.VectorSearchConfig.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. This field is a member of oneof _ algorithm_config .
|
embedding_column |
str
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. |
filter_columns |
MutableSequence[str]
Optional. Columns of features that're used to filter vector search results. |
crowding_column |
str
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. |
embedding_dimension |
int
Optional. The number of dimensions of the input embedding. This field is a member of oneof _ _embedding_dimension .
|
distance_measure_type |
google.cloud.aiplatform_v1beta1.types.FeatureView.VectorSearchConfig.DistanceMeasureType
Optional. The distance measure used in nearest neighbor search. |
Classes
DistanceMeasureType
DistanceMeasureType(value)
Values: DISTANCE_MEASURE_TYPE_UNSPECIFIED (0): Should not be set. SQUARED_L2_DISTANCE (1): Euclidean (L_2) Distance. COSINE_DISTANCE (2): Cosine Distance. Defined as 1 - cosine similarity.
We strongly suggest using DOT_PRODUCT_DISTANCE +
UNIT_L2_NORM instead of COSINE distance. Our algorithms have
been more optimized for DOT_PRODUCT distance which, when
combined with UNIT_L2_NORM, is mathematically equivalent to
COSINE distance and results in the same ranking.
DOT_PRODUCT_DISTANCE (3):
Dot Product Distance. Defined as a negative
of the dot product.
TreeAHConfig
TreeAHConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Methods
VectorSearchConfig
VectorSearchConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for vector search.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields