FindNearest(mapping=None, *, ignore_unknown_fields=False, **kwargs)Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries.
Attributes |
|
|---|---|
| Name | Description |
vector_field |
google.cloud.firestore_v1.types.StructuredQuery.FieldReference
Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned. |
query_vector |
google.cloud.firestore_v1.types.Value
Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. |
distance_measure |
google.cloud.firestore_v1.types.StructuredQuery.FindNearest.DistanceMeasure
Required. The distance measure to use, required. |
limit |
google.protobuf.wrappers_pb2.Int32Value
Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. |
distance_result_field |
str
Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to [document field name][google.firestore.v1.Document.fields] limitations. |
distance_threshold |
google.protobuf.wrappers_pb2.DoubleValue
Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified distance_measure will affect the meaning of
the distance threshold. Since DOT_PRODUCT distances increase
when the vectors are more similar, the comparison is
inverted.
For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold="" for="" dot_product:="" where="" distance="">= distance_threshold
|
Classes
DistanceMeasure
DistanceMeasure(value)The distance measure to use when comparing vectors.