Package co.elastic.clients.elasticsearch._types

Class KnnSearch.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch._types.KnnSearch.Builder

All Implemented Interfaces:

WithJson<KnnSearch.Builder>, ObjectBuilder<KnnSearch>

Enclosing class:

KnnSearch

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

Builder for KnnSearch.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Required - The name of the vector field to search against

API name: field

queryVector

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

The query vector

API name: query_vector

Adds all elements of list to queryVector.

queryVector

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

The query vector

API name: query_vector

Adds one or more values to queryVector.

queryVectorBuilder

public final KnnSearch.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 KnnSearch.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 KnnSearch.Builder k(@Nullable
 Integer value)

The final number of nearest neighbors to return as top hits

API name: k

numCandidates

public final KnnSearch.Builder numCandidates(@Nullable
 Integer value)

The number of nearest neighbor candidates to consider per shard

API name: num_candidates

boost

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

Boost value to apply to kNN scores

API name: boost

filter

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

Filters for the kNN search query

API name: filter

Adds all elements of list to filter.

filter

public final KnnSearch.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 KnnSearch.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 KnnSearch.Builder similarity(@Nullable
 Float value)

The minimum similarity for a vector to be considered a match

API name: similarity

innerHits

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

If defined, each search hit will contain inner hits.

API name: inner_hits

innerHits

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

If defined, each search hit will contain inner hits.

API name: inner_hits

self

protected KnnSearch.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<KnnSearch.Builder>

build

public KnnSearch build()

Builds a KnnSearch.

Specified by:

build in interface ObjectBuilder<KnnSearch>

Throws:

NullPointerException - if some of the required fields are null.