Class KnnSearchQuery.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<KnnSearchQuery.Builder>
co.elastic.clients.elasticsearch.core.knn_search.KnnSearchQuery.Builder
- All Implemented Interfaces:
WithJson<KnnSearchQuery.Builder>
,ObjectBuilder<KnnSearchQuery>
- Enclosing class:
- KnnSearchQuery
public static class KnnSearchQuery.Builder
extends WithJsonObjectBuilderBase<KnnSearchQuery.Builder>
implements ObjectBuilder<KnnSearchQuery>
Builder for
KnnSearchQuery
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aKnnSearchQuery
.final KnnSearchQuery.Builder
Required - The name of the vector field to search againstfinal KnnSearchQuery.Builder
k
(long value) Required - The final number of nearest neighbors to return as top hitsfinal KnnSearchQuery.Builder
numCandidates
(long value) Required - The number of nearest neighbor candidates to consider per shardfinal KnnSearchQuery.Builder
queryVector
(Float value, Float... values) Required - The query vectorfinal KnnSearchQuery.Builder
queryVector
(List<Float> list) Required - The query vectorprotected KnnSearchQuery.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
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
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<KnnSearchQuery.Builder>
-
build
Builds aKnnSearchQuery
.- Specified by:
build
in interfaceObjectBuilder<KnnSearchQuery>
- Throws:
NullPointerException
- if some of the required fields are null.
-