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.
Implements
Inherited Members
Namespace: Google.Apis.Firestore.v1.Data
Assembly: Google.Apis.Firestore.v1.dll
Syntax
public class FindNearest : IDirectResponseSchema
Properties
DistanceMeasure
Required. The distance measure to use, required.
Declaration
[JsonProperty("distanceMeasure")]
public virtual string DistanceMeasure { get; set; }
Property Value
Type | Description |
---|---|
string |
DistanceResultField
Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to document field name limitations.
Declaration
[JsonProperty("distanceResultField")]
public virtual string DistanceResultField { get; set; }
Property Value
Type | Description |
---|---|
string |
DistanceThreshold
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
Declaration
[JsonProperty("distanceThreshold")]
public virtual double? DistanceThreshold { get; set; }
Property Value
Type | Description |
---|---|
double? |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
Limit
Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.
Declaration
[JsonProperty("limit")]
public virtual int? Limit { get; set; }
Property Value
Type | Description |
---|---|
int? |
QueryVector
Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.
Declaration
[JsonProperty("queryVector")]
public virtual Value QueryVector { get; set; }
Property Value
Type | Description |
---|---|
Value |
VectorField
Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.
Declaration
[JsonProperty("vectorField")]
public virtual FieldReference VectorField { get; set; }
Property Value
Type | Description |
---|---|
FieldReference |