Reference documentation and code samples for the Cloud Firestore V1 Client class FindNearest.
Nearest Neighbors search config.
Generated from protobuf message google.firestore.v1.StructuredQuery.FindNearest
Namespace
Google \ Cloud \ Firestore \ V1 \ StructuredQueryMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ vector_field
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.
↳ query_vector
Google\Cloud\Firestore\V1\Value
Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.
↳ distance_measure
int
Required. The Distance Measure to use, required.
↳ limit
Google\Protobuf\Int32Value
Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.
getVectorField
Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.
hasVectorField
clearVectorField
setVectorField
Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.
$this
getQueryVector
Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.
hasQueryVector
clearQueryVector
setQueryVector
Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.
$this
getDistanceMeasure
Required. The Distance Measure to use, required.
int
setDistanceMeasure
Required. The Distance Measure to use, required.
var
int
$this
getLimit
Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.
hasLimit
clearLimit
getLimitValue
Returns the unboxed value from getLimit()
Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.
int|null
setLimit
Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.
$this
setLimitValue
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 1000.
var
int|null
$this
