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 KnnQuery.Builder
boost(java.lang.Float value)
Boost value to apply to kNN scoresKnnQuery
build()
Builds aKnnQuery
.KnnQuery.Builder
field(java.lang.String value)
Required - The name of the vector field to search againstKnnQuery.Builder
filter(Query value, Query... values)
Filters for the kNN search queryKnnQuery.Builder
filter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)
Filters for the kNN search queryKnnQuery.Builder
filter(java.util.List<Query> list)
Filters for the kNN search queryKnnQuery.Builder
k(long value)
Required - The final number of nearest neighbors to return as top hitsKnnQuery.Builder
numCandidates(long value)
Required - The number of nearest neighbor candidates to consider per shardKnnQuery.Builder
queryVector(java.lang.Double value, java.lang.Double... values)
Required - The query vectorKnnQuery.Builder
queryVector(java.util.List<java.lang.Double> list)
Required - The query vectorprotected KnnQuery.Builder
self()
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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
field
Required - The name of the vector field to search againstAPI name:
field
-
queryVector
Required - The query vectorAPI name:
query_vector
Adds all elements of
list
toqueryVector
. -
queryVector
Required - The query vectorAPI name:
query_vector
Adds one or more values to
queryVector
. -
k
Required - The final number of nearest neighbors to return as top hitsAPI name:
k
-
numCandidates
Required - The number of nearest neighbor candidates to consider per shardAPI name:
num_candidates
-
boost
Boost value to apply to kNN scoresAPI name:
boost
-
filter
Filters for the kNN search queryAPI name:
filter
Adds all elements of
list
tofilter
. -
filter
Filters for the kNN search queryAPI name:
filter
Adds one or more values to
filter
. -
filter
public final KnnQuery.Builder filter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)Filters for the kNN search queryAPI name:
filter
Adds a value to
filter
using a builder lambda. -
self
- Specified by:
self
in classWithJsonObjectBuilderBase<KnnQuery.Builder>
-
build
Builds aKnnQuery
.- Specified by:
build
in interfaceObjectBuilder<KnnQuery>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-