Package org.opensearch.client.opensearch._types.query_dsl

Class KnnQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder<KnnQuery.Builder>

org.opensearch.client.opensearch._types.query_dsl.KnnQuery.Builder

All Implemented Interfaces:

ObjectBuilder<KnnQuery>

Enclosing class:

KnnQuery

public static class KnnQuery.Builder
extends QueryBase.AbstractBuilder<KnnQuery.Builder>
implements ObjectBuilder<KnnQuery>

Builder for KnnQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
KnnQuery	build()	Builds a KnnQuery.
KnnQuery.Builder	expandNestedDocs(java.lang.Boolean value)
KnnQuery.Builder	field(java.lang.String field)	Required - The target field.
KnnQuery.Builder	filter(Query filter)	Optional - A query to filter the results of the knn query.
KnnQuery.Builder	k(java.lang.Integer k)	Optional - The number of neighbors to return.
KnnQuery.Builder	maxDistance(java.lang.Float maxDistance)	Optional - The maximum distance allowed between the vector and each of the returned search results.
KnnQuery.Builder	methodParameters(java.lang.String key, JsonData value)
KnnQuery.Builder	methodParameters(java.util.Map<java.lang.String,JsonData> value)
KnnQuery.Builder	minScore(java.lang.Float minScore)	Optional - The minimum score allowed for the returned search results.
KnnQuery.Builder	rescore(java.util.function.Function<KnnQueryRescore.Builder,ObjectBuilder<KnnQueryRescore>> fn)
KnnQuery.Builder	rescore(KnnQueryRescore value)
protected KnnQuery.Builder	self()
KnnQuery.Builder	vector(float[] vector)	Required - The vector to search for.

Methods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder

boost, queryName

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAdd, _listAddAll, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

field

public KnnQuery.Builder field(@Nullable
                              java.lang.String field)

Required - The target field.

Parameters:

field - The target field.

Returns:

This builder.

vector

public KnnQuery.Builder vector(@Nullable
                               float[] vector)

Required - The vector to search for.

Parameters:

vector - The vector to search for.

Returns:

This builder.

k

public KnnQuery.Builder k(@Nullable
                          java.lang.Integer k)

Optional - The number of neighbors to return.

Parameters:

k - The number of neighbors to return.

Returns:

This builder.

minScore

public KnnQuery.Builder minScore(@Nullable
                                 java.lang.Float minScore)

Optional - The minimum score allowed for the returned search results.

Parameters:

minScore - The minimum score allowed for the returned search results.

Returns:

This builder.

maxDistance

public KnnQuery.Builder maxDistance(@Nullable
                                    java.lang.Float maxDistance)

Optional - The maximum distance allowed between the vector and each of the returned search results.

Parameters:

maxDistance - The maximum distance allowed between the vector and each ofthe returned search results.

Returns:

This builder.

filter

public KnnQuery.Builder filter(@Nullable
                               Query filter)

Optional - A query to filter the results of the knn query.

Parameters:

filter - The filter query.

Returns:

This builder.

methodParameters

public KnnQuery.Builder methodParameters(@Nonnull
                                         java.util.Map<java.lang.String,JsonData> value)

methodParameters

public KnnQuery.Builder methodParameters(java.lang.String key,
                                         JsonData value)

rescore

public KnnQuery.Builder rescore(@Nullable
                                KnnQueryRescore value)

rescore

public KnnQuery.Builder rescore(java.util.function.Function<KnnQueryRescore.Builder,ObjectBuilder<KnnQueryRescore>> fn)

expandNestedDocs

public KnnQuery.Builder expandNestedDocs(@Nullable
                                         java.lang.Boolean value)

self

protected KnnQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<KnnQuery.Builder>

build

public KnnQuery build()

Builds a KnnQuery.

Specified by:

build in interface ObjectBuilder<KnnQuery>

Returns:

The built KnnQuery.