Package co.elastic.clients.elasticsearch._types

Class KnnQuery.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<KnnQuery.Builder>

co.elastic.clients.elasticsearch._types.KnnQuery.Builder

All Implemented Interfaces:

WithJson<KnnQuery.Builder>, ObjectBuilder<KnnQuery>

Enclosing class:

KnnQuery

public static class KnnQuery.Builder
extends WithJsonObjectBuilderBase<KnnQuery.Builder>
implements ObjectBuilder<KnnQuery>

Builder for KnnQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final KnnQuery.Builder	boost(Float value)	Boost value to apply to kNN scores
KnnQuery	build()	Builds a KnnQuery.
final KnnQuery.Builder	field(String value)	Required - The name of the vector field to search against
final KnnQuery.Builder	filter(Query value, Query... values)	Filters for the kNN search query
final KnnQuery.Builder	filter(Function<Query.Builder,ObjectBuilder<Query>> fn)	Filters for the kNN search query
final KnnQuery.Builder	filter(List<Query> list)	Filters for the kNN search query
final KnnQuery.Builder	innerHits(InnerHits value)	If defined, each search hit will contain inner hits.
final KnnQuery.Builder	innerHits(Function<InnerHits.Builder,ObjectBuilder<InnerHits>> fn)	If defined, each search hit will contain inner hits.
final KnnQuery.Builder	k(long value)	Required - The final number of nearest neighbors to return as top hits
final KnnQuery.Builder	numCandidates(long value)	Required - The number of nearest neighbor candidates to consider per shard
final KnnQuery.Builder	queryVector(Float value, Float... values)	The query vector
final KnnQuery.Builder	queryVector(List<Float> list)	The query vector
final KnnQuery.Builder	queryVectorBuilder(QueryVectorBuilder value)	The query vector builder.
final KnnQuery.Builder	queryVectorBuilder(Function<QueryVectorBuilder.Builder,ObjectBuilder<QueryVectorBuilder>> fn)	The query vector builder.
protected KnnQuery.Builder	self()
final KnnQuery.Builder	similarity(Float value)	The minimum similarity for a vector to be considered a match

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

field

public final KnnQuery.Builder field(String value)

Required - The name of the vector field to search against

API name: field

queryVector

public final KnnQuery.Builder queryVector(List<Float> list)

The query vector

API name: query_vector

Adds all elements of list to queryVector.

queryVector

public final KnnQuery.Builder queryVector(Float value,
 Float... values)

The query vector

API name: query_vector

Adds one or more values to queryVector.

queryVectorBuilder

public final KnnQuery.Builder queryVectorBuilder(@Nullable
 QueryVectorBuilder value)

The query vector builder. You must provide a query_vector_builder or query_vector, but not both.

API name: query_vector_builder

queryVectorBuilder

public final KnnQuery.Builder queryVectorBuilder(Function<QueryVectorBuilder.Builder,ObjectBuilder<QueryVectorBuilder>> fn)

The query vector builder. You must provide a query_vector_builder or query_vector, but not both.

API name: query_vector_builder

k

public final KnnQuery.Builder k(long value)

Required - The final number of nearest neighbors to return as top hits

API name: k

numCandidates

public final KnnQuery.Builder numCandidates(long value)

Required - The number of nearest neighbor candidates to consider per shard

API name: num_candidates

boost

public final KnnQuery.Builder boost(@Nullable
 Float value)

Boost value to apply to kNN scores

API name: boost

filter

public final KnnQuery.Builder filter(List<Query> list)

Filters for the kNN search query

API name: filter

Adds all elements of list to filter.

filter

public final KnnQuery.Builder filter(Query value,
 Query... values)

Filters for the kNN search query

API name: filter

Adds one or more values to filter.

filter

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

Filters for the kNN search query

API name: filter

Adds a value to filter using a builder lambda.

similarity

public final KnnQuery.Builder similarity(@Nullable
 Float value)

The minimum similarity for a vector to be considered a match

API name: similarity

innerHits

public final KnnQuery.Builder innerHits(@Nullable
 InnerHits value)

If defined, each search hit will contain inner hits.

API name: inner_hits

innerHits

public final KnnQuery.Builder innerHits(Function<InnerHits.Builder,ObjectBuilder<InnerHits>> fn)

If defined, each search hit will contain inner hits.

API name: inner_hits

self

protected KnnQuery.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<KnnQuery.Builder>

build

public KnnQuery build()

Builds a KnnQuery.

Specified by:

build in interface ObjectBuilder<KnnQuery>

Throws:

NullPointerException - if some of the required fields are null.