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
-
Method Summary
Modifier and TypeMethodDescriptionfinal KnnQuery.Builder
Boost value to apply to kNN scoresbuild()
Builds aKnnQuery
.final KnnQuery.Builder
Required - The name of the vector field to search againstfinal KnnQuery.Builder
Filters for the kNN search queryfinal KnnQuery.Builder
Filters for the kNN search queryfinal KnnQuery.Builder
Filters for the kNN search queryfinal KnnQuery.Builder
k
(long value) Required - The final number of nearest neighbors to return as top hitsfinal KnnQuery.Builder
numCandidates
(long value) Required - The number of nearest neighbor candidates to consider per shardfinal KnnQuery.Builder
queryVector
(Float value, Float... values) The query vectorfinal KnnQuery.Builder
queryVector
(List<Float> list) The query vectorfinal KnnQuery.Builder
The query vector builder.final KnnQuery.Builder
The query vector builder.protected 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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
field
Required - The name of the vector field to search againstAPI name:
field
-
queryVector
The query vectorAPI name:
query_vector
Adds all elements of
list
toqueryVector
. -
queryVector
The query vectorAPI name:
query_vector
Adds one or more values to
queryVector
. -
queryVectorBuilder
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
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
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:
NullPointerException
- if some of the required fields are null.
-