Firestore v1 API - Class StructuredQuery.Types.FindNearest (3.6.0)

public sealed class StructuredQuery.Types.FindNearest : IMessage<StructuredQuery.Types.FindNearest>, IEquatable<StructuredQuery.Types.FindNearest>, IDeepCloneable<StructuredQuery.Types.FindNearest>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore v1 API class StructuredQuery.Types.FindNearest.

Nearest Neighbors search config.

Inheritance

object > StructuredQuery.Types.FindNearest

Implements

IMessage StructuredQuery Types FindNearest, IEquatable StructuredQuery Types FindNearest, IDeepCloneable StructuredQuery Types FindNearest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

FindNearest()

public FindNearest()

FindNearest(FindNearest)

public FindNearest(StructuredQuery.Types.FindNearest other)

Parameter
Name	Description
`other`	`StructuredQueryTypesFindNearest`

Properties

DistanceMeasure

public StructuredQuery.Types.FindNearest.Types.DistanceMeasure DistanceMeasure { get; set; }

Required. The Distance Measure to use, required.

Property Value
Type	Description
`StructuredQueryTypesFindNearestTypesDistanceMeasure`

Limit

public int? Limit { get; set; }

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

Property Value
Type	Description
`int`

QueryVector

public Value QueryVector { get; set; }

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

Property Value
Type	Description
`Value`

VectorField

public StructuredQuery.Types.FieldReference VectorField { get; set; }

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

Property Value
Type	Description
`StructuredQueryTypesFieldReference`