Google Cloud Datastore v1 API - Class FindNearest (4.14.0)

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

Reference documentation and code samples for the Google Cloud Datastore v1 API 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.

Inheritance

object > FindNearest

Implements

IMessage FindNearest, IEquatable FindNearest, IDeepCloneable FindNearest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Datastore.V1

Assembly

Google.Cloud.Datastore.V1.dll

Constructors

FindNearest()

public FindNearest()

FindNearest(FindNearest)

public FindNearest(FindNearest other)

Parameter
Name	Description
`other`	`FindNearest`

Properties

DistanceMeasure

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

Required. The Distance Measure to use, required.

Property Value
Type	Description
`FindNearestTypesDistanceMeasure`

DistanceResultProperty

public string DistanceResultProperty { get; set; }

Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to [entity property][google.datastore.v1.Entity.properties] limitations.

Property Value
Type	Description
`string`

DistanceThreshold

public double? DistanceThreshold { get; set; }

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

Property Value
Type	Description
`double`

Limit

public int? Limit { get; set; }

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

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`

VectorProperty

public PropertyReference VectorProperty { get; set; }

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

Property Value
Type	Description
`PropertyReference`