Class VectorQueryOptions.Builder (3.28.0)

Version latest

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public static final class VectorQueryOptions.Builder

Inheritance

java.lang.Object > VectorQueryOptions.Builder

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build()

public VectorQueryOptions build()

Returns
Type	Description
VectorQueryOptions

setDistanceResultField(FieldPath fieldPath)

public VectorQueryOptions.Builder setDistanceResultField(FieldPath fieldPath)

Specifies the name of the field that will be set on each returned DocumentSnapshot, which will contain the computed distance for the document. If null, then the computed distance will not be returned. Default value: null.

Parameter
Name	Description
fieldPath	FieldPath A FieldPath value specifying the distance result field.

Returns
Type	Description
VectorQueryOptions.Builder

setDistanceResultField(String fieldPath)

public VectorQueryOptions.Builder setDistanceResultField(String fieldPath)

Specifies the name of the field that will be set on each returned DocumentSnapshot, which will contain the computed distance for the document. If null, then the computed distance will not be returned. Default value: null.

Parameter
Name	Description
fieldPath	String A string value specifying the distance result field.

Returns
Type	Description
VectorQueryOptions.Builder

setDistanceThreshold(Double distanceThreshold)

public VectorQueryOptions.Builder setDistanceThreshold(Double distanceThreshold)

Specifies a threshold for which no less similar documents will be returned. The behavior of the specified distanceMeasure will affect the meaning of the distance threshold.

• For distanceMeasure: "EUCLIDEAN", the meaning of distanceThreshold is: SELECT docs WHERE euclidean_distance <= distanceThreshold
• For distanceMeasure: "COSINE", the meaning of distanceThreshold is: SELECT docs WHERE cosine_distance <= distanceThreshold
• For distanceMeasure: "DOT_PRODUCT", the meaning of distanceThreshold is: SELECT docs WHERE dot_product_distance >= distanceThreshold

If null, then the computed distance will not be returned. Default value: null.

Parameter
Name	Description
distanceThreshold	Double A Double value specifying the distance threshold.

Returns
Type	Description
VectorQueryOptions.Builder