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:

CopyableBuilder<KnnQuery.Builder,KnnQuery>, MutableBuilder<KnnQuery.Builder,KnnQuery>, ObjectBuilder<KnnQuery>

Enclosing class:

KnnQuery

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

Builder for KnnQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
KnnQuery	build()	Builds a KnnQuery.
KnnQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final KnnQuery.Builder	expandNestedDocs(Boolean value)	API name: expand_nested_docs
final KnnQuery.Builder	field(String value)	Required - The target field
final KnnQuery.Builder	filter(Function<Query.Builder,ObjectBuilder<Query>> fn)	The filter for the k-NN search query.
final KnnQuery.Builder	filter(Query value)	The filter for the k-NN search query.
final KnnQuery.Builder	k(Integer value)	The total number of nearest neighbors to return as top hits.
final KnnQuery.Builder	maxDistance(Float value)	The maximum physical vector space distance required in order for a neighbor to be considered a hit.
final KnnQuery.Builder	methodParameters(String key, JsonData value)	API name: method_parameters
final KnnQuery.Builder	methodParameters(Map<String,JsonData> map)	API name: method_parameters
final KnnQuery.Builder	minScore(Float value)	The minimum similarity score required in order for a neighbor to be considered a hit.
final KnnQuery.Builder	rescore(Function<KnnQueryRescore.Builder,ObjectBuilder<KnnQueryRescore>> fn)	API name: rescore
final KnnQuery.Builder	rescore(KnnQueryRescore value)	API name: rescore
protected KnnQuery.Builder	self()
final KnnQuery.Builder	vector(Float value, Float... values)	Required - API name: vector
final KnnQuery.Builder	vector(List<Float> list)	Required - API name: vector

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, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public KnnQuery.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<KnnQuery.Builder,KnnQuery>

Returns:

a new builder instance.

self

@Nonnull
protected KnnQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<KnnQuery.Builder>

expandNestedDocs

@Nonnull
public final KnnQuery.Builder expandNestedDocs(@Nullable
 Boolean value)

API name: expand_nested_docs

field

@Nonnull
public final KnnQuery.Builder field(String value)

Required - The target field

filter

@Nonnull
public final KnnQuery.Builder filter(@Nullable
 Query value)

The filter for the k-NN search query.

API name: filter

filter

@Nonnull
public final KnnQuery.Builder filter(Function<Query.Builder,ObjectBuilder<Query>> fn)

The filter for the k-NN search query.

API name: filter

k

@Nonnull
public final KnnQuery.Builder k(@Nullable
 Integer value)

The total number of nearest neighbors to return as top hits.

API name: k

maxDistance

@Nonnull
public final KnnQuery.Builder maxDistance(@Nullable
 Float value)

The maximum physical vector space distance required in order for a neighbor to be considered a hit.

API name: max_distance

methodParameters

@Nonnull
public final KnnQuery.Builder methodParameters(Map<String,JsonData> map)

API name: method_parameters

Adds all elements of map to methodParameters.

methodParameters

@Nonnull
public final KnnQuery.Builder methodParameters(String key,
 JsonData value)

API name: method_parameters

Adds an entry to methodParameters.

minScore

@Nonnull
public final KnnQuery.Builder minScore(@Nullable
 Float value)

The minimum similarity score required in order for a neighbor to be considered a hit.

API name: min_score

rescore

@Nonnull
public final KnnQuery.Builder rescore(@Nullable
 KnnQueryRescore value)

API name: rescore

rescore

@Nonnull
public final KnnQuery.Builder rescore(Function<KnnQueryRescore.Builder,ObjectBuilder<KnnQueryRescore>> fn)

API name: rescore

vector

@Nonnull
public final KnnQuery.Builder vector(List<Float> list)

Required - API name: vector

Adds all elements of list to vector.

vector

@Nonnull
public final KnnQuery.Builder vector(Float value,
 Float... values)

Required - API name: vector

Adds one or more values to vector.

build

@Nonnull
public KnnQuery build()

Builds a KnnQuery.

Specified by:

build in interface ObjectBuilder<KnnQuery>

Throws:

NullPointerException - if some of the required fields are null.