Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::StructuredQuery::FindNearest (v1.2.0)

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::StructuredQuery::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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#distance_measure

def distance_measure() -> ::Google::Cloud::Firestore::V1::StructuredQuery::FindNearest::DistanceMeasure

Returns

(::Google::Cloud::Firestore::V1::StructuredQuery::FindNearest::DistanceMeasure) — Required. The distance measure to use, required.

#distance_measure=

def distance_measure=(value) -> ::Google::Cloud::Firestore::V1::StructuredQuery::FindNearest::DistanceMeasure

Parameter

value (::Google::Cloud::Firestore::V1::StructuredQuery::FindNearest::DistanceMeasure) — Required. The distance measure to use, required.

Returns

(::Google::Cloud::Firestore::V1::StructuredQuery::FindNearest::DistanceMeasure) — Required. The distance measure to use, required.

#distance_result_field

def distance_result_field() -> ::String

Returns

(::String) — 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_result_field=

def distance_result_field=(value) -> ::String

Parameter

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

Returns

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

def distance_threshold() -> ::Google::Protobuf::DoubleValue

Returns

(::Google::Protobuf::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

#distance_threshold=

def distance_threshold=(value) -> ::Google::Protobuf::DoubleValue

Parameter

value (::Google::Protobuf::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

Returns

(::Google::Protobuf::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

#limit

def limit() -> ::Google::Protobuf::Int32Value

Returns

(::Google::Protobuf::Int32Value) — Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.

#limit=

def limit=(value) -> ::Google::Protobuf::Int32Value

Parameter

value (::Google::Protobuf::Int32Value) — Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.

Returns

(::Google::Protobuf::Int32Value) — Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.

#query_vector

def query_vector() -> ::Google::Cloud::Firestore::V1::Value

Returns

(::Google::Cloud::Firestore::V1::Value) — Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.

#query_vector=

def query_vector=(value) -> ::Google::Cloud::Firestore::V1::Value

Parameter

value (::Google::Cloud::Firestore::V1::Value) — Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.

Returns

(::Google::Cloud::Firestore::V1::Value) — Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.

#vector_field

def vector_field() -> ::Google::Cloud::Firestore::V1::StructuredQuery::FieldReference

Returns

(::Google::Cloud::Firestore::V1::StructuredQuery::FieldReference) — Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.

#vector_field=

def vector_field=(value) -> ::Google::Cloud::Firestore::V1::StructuredQuery::FieldReference

Parameter

value (::Google::Cloud::Firestore::V1::StructuredQuery::FieldReference) — Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.

Returns

(::Google::Cloud::Firestore::V1::StructuredQuery::FieldReference) — Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.