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