Cloud Datastore V1 Client - Class FindNearest (1.33.0)

Reference documentation and code samples for the Cloud Datastore V1 Client class FindNearest.

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.

Generated from protobuf message google.datastore.v1.FindNearest

Constructor.

Required. An indexed vector property to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.

Required. An indexed vector property to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.

Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.

Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.

Required. The Distance Measure to use, required.

Required. The Distance Measure to use, required.

Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100.

Returns the unboxed value from getLimit()

Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100.

Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100.

Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.

Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100.

Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to entity property limitations.

Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to entity property limitations.

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

Returns the unboxed value from getDistanceThreshold()

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

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

Sets the field by wrapping a primitive type in a Google\Protobuf\DoubleValue object.

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